From cdcccfa295910a1cd38694eca22d5a87689daf36 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Wed, 24 May 2023 00:24:12 -0700 Subject: [PATCH] feat(all): auto-regenerate discovery clients (#1995) --- androidpublisher/v3/androidpublisher-api.json | 4 +- androidpublisher/v3/androidpublisher-gen.go | 2 + api-list.json | 2 +- .../v1/certificatemanager-api.json | 8 +- .../v1/certificatemanager-gen.go | 8 +- chat/v1/chat-api.json | 3 +- chat/v1/chat-gen.go | 1 + cloudbuild/v1/cloudbuild-api.json | 54 +- cloudbuild/v1/cloudbuild-gen.go | 89 +- composer/v1/composer-api.json | 352 ++- composer/v1/composer-gen.go | 1144 ++++++++- composer/v1beta1/composer-api.json | 352 ++- composer/v1beta1/composer-gen.go | 1140 ++++++++- connectors/v1/connectors-api.json | 30 +- connectors/v1/connectors-gen.go | 18 + dataflow/v1b3/dataflow-api.json | 6 +- dataflow/v1b3/dataflow-gen.go | 4 + datamigration/v1/datamigration-api.json | 6 +- datamigration/v1/datamigration-gen.go | 5 + dataplex/v1/dataplex-api.json | 48 +- dataplex/v1/dataplex-gen.go | 58 + dialogflow/v2/dialogflow-api.json | 79 +- dialogflow/v2/dialogflow-gen.go | 152 +- dialogflow/v2beta1/dialogflow-api.json | 147 +- dialogflow/v2beta1/dialogflow-gen.go | 284 ++- dialogflow/v3/dialogflow-api.json | 71 +- dialogflow/v3/dialogflow-gen.go | 124 + dialogflow/v3beta1/dialogflow-api.json | 71 +- dialogflow/v3beta1/dialogflow-gen.go | 124 + displayvideo/v1/displayvideo-api.json | 42 +- displayvideo/v1/displayvideo-gen.go | 149 +- displayvideo/v2/displayvideo-api.json | 38 +- displayvideo/v2/displayvideo-gen.go | 137 +- drive/v2/drive-api.json | 1085 +++++---- drive/v2/drive-gen.go | 2156 +++++++++-------- drive/v3/drive-api.json | 825 ++++--- drive/v3/drive-gen.go | 1603 ++++++------ firebaseappcheck/v1/firebaseappcheck-api.json | 3 +- .../v1beta/firebaseappcheck-api.json | 6 +- .../v1beta/firebaseappcheck-gen.go | 6 +- .../v1beta1/firebasehosting-api.json | 4 +- .../v1beta1/firebasehosting-gen.go | 2 + gkehub/v1/gkehub-api.json | 100 +- gkehub/v1/gkehub-gen.go | 495 +++- gkehub/v1alpha/gkehub-api.json | 104 +- gkehub/v1alpha/gkehub-gen.go | 500 +++- gkehub/v1beta/gkehub-api.json | 100 +- gkehub/v1beta/gkehub-gen.go | 495 +++- gkehub/v1beta1/gkehub-api.json | 3 +- gkehub/v1beta1/gkehub-gen.go | 1 + gkeonprem/v1/gkeonprem-api.json | 157 +- gkeonprem/v1/gkeonprem-gen.go | 480 +++- .../v1alpha1/migrationcenter-api.json | 4 +- .../v1alpha1/migrationcenter-gen.go | 4 +- .../v1beta1/networkmanagement-api.json | 4 +- .../v1beta1/networkmanagement-gen.go | 3 + networkservices/v1/networkservices-api.json | 11 +- networkservices/v1/networkservices-gen.go | 5 +- .../v1beta1/networkservices-api.json | 11 +- .../v1beta1/networkservices-gen.go | 5 +- osconfig/v1alpha/osconfig-api.json | 3 +- pubsub/v1/pubsub-api.json | 5 +- pubsub/v1/pubsub-gen.go | 10 +- retail/v2/retail-api.json | 10 +- retail/v2/retail-gen.go | 8 + retail/v2alpha/retail-api.json | 10 +- retail/v2alpha/retail-gen.go | 8 + retail/v2beta/retail-api.json | 10 +- retail/v2beta/retail-gen.go | 8 + servicedirectory/v1/servicedirectory-api.json | 4 +- servicedirectory/v1/servicedirectory-gen.go | 2 +- .../v1beta1/servicedirectory-api.json | 4 +- .../v1beta1/servicedirectory-gen.go | 2 +- .../v1/streetviewpublish-api.json | 5 +- streetviewpublish/v1/streetviewpublish-gen.go | 8 +- testing/v1/testing-api.json | 13 +- testing/v1/testing-gen.go | 30 +- vmmigration/v1/vmmigration-api.json | 30 +- vmmigration/v1/vmmigration-gen.go | 37 + vmmigration/v1alpha1/vmmigration-api.json | 30 +- vmmigration/v1alpha1/vmmigration-gen.go | 37 + .../v1/workflowexecutions-api.json | 4 +- .../v1/workflowexecutions-gen.go | 2 +- youtube/v3/youtube-api.json | 4 +- youtube/v3/youtube-gen.go | 2 + 85 files changed, 10075 insertions(+), 3135 deletions(-) diff --git a/androidpublisher/v3/androidpublisher-api.json b/androidpublisher/v3/androidpublisher-api.json index aba30603183..9394d7c953f 100644 --- a/androidpublisher/v3/androidpublisher-api.json +++ b/androidpublisher/v3/androidpublisher-api.json @@ -2199,6 +2199,7 @@ ], "parameters": { "maxResults": { + "deprecated": true, "description": "Deprecated and ignored. The page size is determined by the server.", "format": "uint32", "location": "query", @@ -2211,6 +2212,7 @@ "type": "string" }, "startIndex": { + "deprecated": true, "description": "Deprecated and ignored. Set the `token` parameter to retrieve the next page.", "format": "uint32", "location": "query", @@ -4045,7 +4047,7 @@ } } }, - "revision": "20230516", + "revision": "20230523", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "AcquisitionTargetingRule": { diff --git a/androidpublisher/v3/androidpublisher-gen.go b/androidpublisher/v3/androidpublisher-gen.go index 3dea2463c3a..76cf6e1f569 100644 --- a/androidpublisher/v3/androidpublisher-gen.go +++ b/androidpublisher/v3/androidpublisher-gen.go @@ -14879,6 +14879,7 @@ func (c *InappproductsListCall) Do(opts ...googleapi.CallOption) (*Inappproducts // ], // "parameters": { // "maxResults": { + // "deprecated": true, // "description": "Deprecated and ignored. The page size is determined by the server.", // "format": "uint32", // "location": "query", @@ -14891,6 +14892,7 @@ func (c *InappproductsListCall) Do(opts ...googleapi.CallOption) (*Inappproducts // "type": "string" // }, // "startIndex": { + // "deprecated": true, // "description": "Deprecated and ignored. Set the `token` parameter to retrieve the next page.", // "format": "uint32", // "location": "query", diff --git a/api-list.json b/api-list.json index 8e07ec3de5c..f11905e8126 100644 --- a/api-list.json +++ b/api-list.json @@ -2319,7 +2319,7 @@ "id": "dlp:v2", "name": "dlp", "version": "v2", - "title": "Cloud Data Loss Prevention (DLP) API", + "title": "Cloud Data Loss Prevention (DLP)", "description": "Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.", "discoveryRestUrl": "https://dlp.googleapis.com/$discovery/rest?version=v2", "icons": { diff --git a/certificatemanager/v1/certificatemanager-api.json b/certificatemanager/v1/certificatemanager-api.json index 3972fada250..f976b6f200d 100644 --- a/certificatemanager/v1/certificatemanager-api.json +++ b/certificatemanager/v1/certificatemanager-api.json @@ -1280,7 +1280,7 @@ } } }, - "revision": "20230407", + "revision": "20230512", "rootUrl": "https://certificatemanager.googleapis.com/", "schemas": { "AuthorizationAttemptInfo": { @@ -1323,7 +1323,7 @@ ], "enumDescriptions": [ "State is unspecified.", - "Certificate provisioning for this domain is under way. GCP will attempt to authorize the domain.", + "Certificate provisioning for this domain is under way. Google Cloud will attempt to authorize the domain.", "A managed certificate can be provisioned, no issues for this domain.", "Attempt to authorize the domain failed. This prevents the Managed Certificate from being issued. See `failure_reason` and `details` fields for more information." ], @@ -1395,7 +1395,7 @@ ], "enumDescriptions": [ "Certificates with default scope are served from core Google data centers. If unsure, choose this option.", - "Certificates with scope EDGE_CACHE are special-purposed certificates, served from non-core Google data centers." + "Certificates with scope EDGE_CACHE are special-purposed certificates, served from Edge Points of Presence. See https://cloud.google.com/vpc/docs/edge-locations." ], "type": "string" }, @@ -1925,7 +1925,7 @@ "type": "object" }, "Location": { - "description": "A resource that represents Google Cloud Platform location.", + "description": "A resource that represents a Google Cloud location.", "id": "Location", "properties": { "displayName": { diff --git a/certificatemanager/v1/certificatemanager-gen.go b/certificatemanager/v1/certificatemanager-gen.go index 3048bcdb184..e2ad55c55fc 100644 --- a/certificatemanager/v1/certificatemanager-gen.go +++ b/certificatemanager/v1/certificatemanager-gen.go @@ -274,7 +274,7 @@ type AuthorizationAttemptInfo struct { // Possible values: // "STATE_UNSPECIFIED" - State is unspecified. // "AUTHORIZING" - Certificate provisioning for this domain is under - // way. GCP will attempt to authorize the domain. + // way. Google Cloud will attempt to authorize the domain. // "AUTHORIZED" - A managed certificate can be provisioned, no issues // for this domain. // "FAILED" - Attempt to authorize the domain failed. This prevents @@ -349,8 +349,8 @@ type Certificate struct { // "DEFAULT" - Certificates with default scope are served from core // Google data centers. If unsure, choose this option. // "EDGE_CACHE" - Certificates with scope EDGE_CACHE are - // special-purposed certificates, served from non-core Google data - // centers. + // special-purposed certificates, served from Edge Points of Presence. + // See https://cloud.google.com/vpc/docs/edge-locations. Scope string `json:"scope,omitempty"` // SelfManaged: If set, defines data of a self-managed certificate. @@ -1199,7 +1199,7 @@ func (s *ListTrustConfigsResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Location: A resource that represents Google Cloud Platform location. +// Location: A resource that represents a Google Cloud location. type Location struct { // DisplayName: The friendly name for this location, typically a nearby // city name. For example, "Tokyo". diff --git a/chat/v1/chat-api.json b/chat/v1/chat-api.json index fbb26790948..2554abf9938 100644 --- a/chat/v1/chat-api.json +++ b/chat/v1/chat-api.json @@ -591,6 +591,7 @@ "type": "string" }, "threadKey": { + "deprecated": true, "description": "Optional. Deprecated: Use thread.thread_key instead. Opaque thread identifier. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](https://developers.google.com/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread).", "location": "query", "type": "string" @@ -939,7 +940,7 @@ } } }, - "revision": "20230516", + "revision": "20230521", "rootUrl": "https://chat.googleapis.com/", "schemas": { "ActionParameter": { diff --git a/chat/v1/chat-gen.go b/chat/v1/chat-gen.go index 96c50636622..7c8d9730d69 100644 --- a/chat/v1/chat-gen.go +++ b/chat/v1/chat-gen.go @@ -7359,6 +7359,7 @@ func (c *SpacesMessagesCreateCall) Do(opts ...googleapi.CallOption) (*Message, e // "type": "string" // }, // "threadKey": { + // "deprecated": true, // "description": "Optional. Deprecated: Use thread.thread_key instead. Opaque thread identifier. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](https://developers.google.com/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread).", // "location": "query", // "type": "string" diff --git a/cloudbuild/v1/cloudbuild-api.json b/cloudbuild/v1/cloudbuild-api.json index 8f202cdc054..72f447ad76e 100644 --- a/cloudbuild/v1/cloudbuild-api.json +++ b/cloudbuild/v1/cloudbuild-api.json @@ -401,7 +401,7 @@ ] }, "retry": { - "description": "Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", + "description": "Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", "flatPath": "v1/projects/{projectId}/builds/{id}:retry", "httpMethod": "POST", "id": "cloudbuild.projects.builds.retry", @@ -460,6 +460,7 @@ "type": "string" }, "projectId": { + "deprecated": true, "description": "ID of the project.", "location": "query", "type": "string" @@ -486,6 +487,7 @@ ], "parameters": { "configId": { + "deprecated": true, "description": "Unique identifier of the `GitHubEnterpriseConfig`", "location": "query", "type": "string" @@ -498,6 +500,7 @@ "type": "string" }, "projectId": { + "deprecated": true, "description": "ID of the project", "location": "query", "type": "string" @@ -521,6 +524,7 @@ ], "parameters": { "configId": { + "deprecated": true, "description": "Unique identifier of the `GitHubEnterpriseConfig`", "location": "query", "type": "string" @@ -533,6 +537,7 @@ "type": "string" }, "projectId": { + "deprecated": true, "description": "ID of the project", "location": "query", "type": "string" @@ -563,6 +568,7 @@ "type": "string" }, "projectId": { + "deprecated": true, "description": "ID of the project", "location": "query", "type": "string" @@ -1046,7 +1052,7 @@ ] }, "retry": { - "description": "Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", + "description": "Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds/{buildsId}:retry", "httpMethod": "POST", "id": "cloudbuild.projects.locations.builds.retry", @@ -1358,6 +1364,7 @@ "type": "string" }, "projectId": { + "deprecated": true, "description": "ID of the project.", "location": "query", "type": "string" @@ -1384,6 +1391,7 @@ ], "parameters": { "configId": { + "deprecated": true, "description": "Unique identifier of the `GitHubEnterpriseConfig`", "location": "query", "type": "string" @@ -1396,6 +1404,7 @@ "type": "string" }, "projectId": { + "deprecated": true, "description": "ID of the project", "location": "query", "type": "string" @@ -1419,6 +1428,7 @@ ], "parameters": { "configId": { + "deprecated": true, "description": "Unique identifier of the `GitHubEnterpriseConfig`", "location": "query", "type": "string" @@ -1431,6 +1441,7 @@ "type": "string" }, "projectId": { + "deprecated": true, "description": "ID of the project", "location": "query", "type": "string" @@ -1461,6 +1472,7 @@ "type": "string" }, "projectId": { + "deprecated": true, "description": "ID of the project", "location": "query", "type": "string" @@ -2307,7 +2319,7 @@ } } }, - "revision": "20230505", + "revision": "20230522", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -2407,7 +2419,7 @@ "type": "array" }, "location": { - "description": "The path of an artifact in a Google Cloud Storage bucket, with the generation number. For example, `gs://mybucket/path/to/output.jar#generation`.", + "description": "The path of an artifact in a Cloud Storage bucket, with the generation number. For example, `gs://mybucket/path/to/output.jar#generation`.", "type": "string" } }, @@ -2779,7 +2791,7 @@ "type": "string" }, "logsBucket": { - "description": "Google Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.", + "description": "Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.", "type": "string" }, "name": { @@ -2991,7 +3003,7 @@ "type": "array" }, "logStreamingOption": { - "description": "Option to define build log streaming behavior to Google Cloud Storage.", + "description": "Option to define build log streaming behavior to Cloud Storage.", "enum": [ "STREAM_DEFAULT", "STREAM_ON", @@ -2999,8 +3011,8 @@ ], "enumDescriptions": [ "Service may automatically determine build log streaming behavior.", - "Build logs should be streamed to Google Cloud Storage.", - "Build logs should not be streamed to Google Cloud Storage; they will be written when the build is completed." + "Build logs should be streamed to Cloud Storage.", + "Build logs should not be streamed to Cloud Storage; they will be written when the build is completed." ], "type": "string" }, @@ -3717,7 +3729,7 @@ "type": "string" }, "repository": { - "description": "The fully qualified resource name of the Repo API repository. Either uri or repository can be specified. If unspecified, the repo from which the trigger invocation originated is assumed to be the repo from which to read the specified path.", + "description": "The fully qualified resource name of the Repos API repository. Either URI or repository can be specified. If unspecified, the repo from which the trigger invocation originated is assumed to be the repo from which to read the specified path.", "type": "string" }, "revision": { @@ -4058,11 +4070,11 @@ "type": "string" }, "repository": { - "description": "The qualified resource name of the Repo API repository Either uri or repository can be specified and is required.", + "description": "The connected repository resource name, in the format `projects/*/locations/*/connections/*/repositories/*`. Either `uri` or `repository` can be specified and is required.", "type": "string" }, "uri": { - "description": "The URI of the repo. Either uri or repository can be specified and is required.", + "description": "The URI of the repo (e.g. https://github.com/user/repo.git). Either `uri` or `repository` can be specified and is required.", "type": "string" } }, @@ -4889,11 +4901,11 @@ }, "storageSource": { "$ref": "StorageSource", - "description": "If provided, get the source from this location in Google Cloud Storage." + "description": "If provided, get the source from this location in Cloud Storage." }, "storageSourceManifest": { "$ref": "StorageSourceManifest", - "description": "If provided, get the source from this manifest in Google Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher)." + "description": "If provided, get the source from this manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher)." } }, "type": "object" @@ -4953,40 +4965,40 @@ "type": "object" }, "StorageSource": { - "description": "Location of the source in an archive file in Google Cloud Storage.", + "description": "Location of the source in an archive file in Cloud Storage.", "id": "StorageSource", "properties": { "bucket": { - "description": "Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", + "description": "Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", "type": "string" }, "generation": { - "description": "Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", + "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", "format": "int64", "type": "string" }, "object": { - "description": "Google Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.", + "description": "Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.", "type": "string" } }, "type": "object" }, "StorageSourceManifest": { - "description": "Location of the source manifest in Google Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).", + "description": "Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).", "id": "StorageSourceManifest", "properties": { "bucket": { - "description": "Google Cloud Storage bucket containing the source manifest (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", + "description": "Cloud Storage bucket containing the source manifest (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", "type": "string" }, "generation": { - "description": "Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", + "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", "format": "int64", "type": "string" }, "object": { - "description": "Google Cloud Storage object containing the source manifest. This object must be a JSON file.", + "description": "Cloud Storage object containing the source manifest. This object must be a JSON file.", "type": "string" } }, diff --git a/cloudbuild/v1/cloudbuild-gen.go b/cloudbuild/v1/cloudbuild-gen.go index 8c0a69e8e78..e6756a7f046 100644 --- a/cloudbuild/v1/cloudbuild-gen.go +++ b/cloudbuild/v1/cloudbuild-gen.go @@ -536,8 +536,8 @@ type ArtifactResult struct { // FileHash: The file hash of the artifact. FileHash []*FileHashes `json:"fileHash,omitempty"` - // Location: The path of an artifact in a Google Cloud Storage bucket, - // with the generation number. For example, + // Location: The path of an artifact in a Cloud Storage bucket, with the + // generation number. For example, // `gs://mybucket/path/to/output.jar#generation`. Location string `json:"location,omitempty"` @@ -1178,8 +1178,8 @@ type Build struct { // Console. LogUrl string `json:"logUrl,omitempty"` - // LogsBucket: Google Cloud Storage bucket where logs should be written - // (see Bucket Name Requirements + // LogsBucket: Cloud Storage bucket where logs should be written (see + // Bucket Name Requirements // (https://cloud.google.com/storage/docs/bucket-naming#requirements)). // Logs file names will be of the format // `${logs_bucket}/log-${build_id}.txt`. @@ -1411,15 +1411,14 @@ type BuildOptions struct { Env []string `json:"env,omitempty"` // LogStreamingOption: Option to define build log streaming behavior to - // Google Cloud Storage. + // Cloud Storage. // // Possible values: // "STREAM_DEFAULT" - Service may automatically determine build log // streaming behavior. - // "STREAM_ON" - Build logs should be streamed to Google Cloud - // Storage. - // "STREAM_OFF" - Build logs should not be streamed to Google Cloud - // Storage; they will be written when the build is completed. + // "STREAM_ON" - Build logs should be streamed to Cloud Storage. + // "STREAM_OFF" - Build logs should not be streamed to Cloud Storage; + // they will be written when the build is completed. LogStreamingOption string `json:"logStreamingOption,omitempty"` // Logging: Option to specify the logging mode, which determines if and @@ -2413,8 +2412,8 @@ type GitFileSource struct { // "GITLAB" - A GitLab-hosted repo. RepoType string `json:"repoType,omitempty"` - // Repository: The fully qualified resource name of the Repo API - // repository. Either uri or repository can be specified. If + // Repository: The fully qualified resource name of the Repos API + // repository. Either URI or repository can be specified. If // unspecified, the repo from which the trigger invocation originated is // assumed to be the repo from which to read the specified path. Repository string `json:"repository,omitempty"` @@ -2969,12 +2968,13 @@ type GitRepoSource struct { // "GITLAB" - A GitLab-hosted repo. RepoType string `json:"repoType,omitempty"` - // Repository: The qualified resource name of the Repo API repository - // Either uri or repository can be specified and is required. + // Repository: The connected repository resource name, in the format + // `projects/*/locations/*/connections/*/repositories/*`. Either `uri` + // or `repository` can be specified and is required. Repository string `json:"repository,omitempty"` - // Uri: The URI of the repo. Either uri or repository can be specified - // and is required. + // Uri: The URI of the repo (e.g. https://github.com/user/repo.git). + // Either `uri` or `repository` can be specified and is required. Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -4470,12 +4470,11 @@ type Source struct { RepoSource *RepoSource `json:"repoSource,omitempty"` // StorageSource: If provided, get the source from this location in - // Google Cloud Storage. + // Cloud Storage. StorageSource *StorageSource `json:"storageSource,omitempty"` // StorageSourceManifest: If provided, get the source from this manifest - // in Google Cloud Storage. This feature is in Preview; see description - // here + // in Cloud Storage. This feature is in Preview; see description here // (https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). StorageSourceManifest *StorageSourceManifest `json:"storageSourceManifest,omitempty"` @@ -4595,21 +4594,21 @@ func (s *Status) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// StorageSource: Location of the source in an archive file in Google -// Cloud Storage. +// StorageSource: Location of the source in an archive file in Cloud +// Storage. type StorageSource struct { - // Bucket: Google Cloud Storage bucket containing the source (see Bucket - // Name Requirements + // Bucket: Cloud Storage bucket containing the source (see Bucket Name + // Requirements // (https://cloud.google.com/storage/docs/bucket-naming#requirements)). Bucket string `json:"bucket,omitempty"` - // Generation: Google Cloud Storage generation for the object. If the + // Generation: Cloud Storage generation for the object. If the // generation is omitted, the latest generation will be used. Generation int64 `json:"generation,omitempty,string"` - // Object: Google Cloud Storage object containing the source. This - // object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) - // containing source to build. + // Object: Cloud Storage object containing the source. This object must + // be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing + // source to build. Object string `json:"object,omitempty"` // ForceSendFields is a list of field names (e.g. "Bucket") to @@ -4635,21 +4634,21 @@ func (s *StorageSource) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// StorageSourceManifest: Location of the source manifest in Google -// Cloud Storage. This feature is in Preview; see description here +// StorageSourceManifest: Location of the source manifest in Cloud +// Storage. This feature is in Preview; see description here // (https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). type StorageSourceManifest struct { - // Bucket: Google Cloud Storage bucket containing the source manifest - // (see Bucket Name Requirements + // Bucket: Cloud Storage bucket containing the source manifest (see + // Bucket Name Requirements // (https://cloud.google.com/storage/docs/bucket-naming#requirements)). Bucket string `json:"bucket,omitempty"` - // Generation: Google Cloud Storage generation for the object. If the + // Generation: Cloud Storage generation for the object. If the // generation is omitted, the latest generation will be used. Generation int64 `json:"generation,omitempty,string"` - // Object: Google Cloud Storage object containing the source manifest. - // This object must be a JSON file. + // Object: Cloud Storage object containing the source manifest. This + // object must be a JSON file. Object string `json:"object,omitempty"` // ForceSendFields is a list of field names (e.g. "Bucket") to @@ -6672,8 +6671,8 @@ type ProjectsBuildsRetryCall struct { // the original build. * If the original build specified a commit sha or // revision ID, the retried build will use the identical source. For // builds that specify `StorageSource`: * If the original build pulled -// source from Google Cloud Storage without specifying the generation of -// the object, the new build will use the current object, which may be +// source from Cloud Storage without specifying the generation of the +// object, the new build will use the current object, which may be // different from the original build source. * If the original build // pulled source from Cloud Storage and specified the generation of the // object, the new build will attempt to use the same object, which may @@ -6782,7 +6781,7 @@ func (c *ProjectsBuildsRetryCall) Do(opts ...googleapi.CallOption) (*Operation, } return ret, nil // { - // "description": "Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", + // "description": "Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", // "flatPath": "v1/projects/{projectId}/builds/{id}:retry", // "httpMethod": "POST", // "id": "cloudbuild.projects.builds.retry", @@ -6970,6 +6969,7 @@ func (c *ProjectsGithubEnterpriseConfigsCreateCall) Do(opts ...googleapi.CallOpt // "type": "string" // }, // "projectId": { + // "deprecated": true, // "description": "ID of the project.", // "location": "query", // "type": "string" @@ -7120,6 +7120,7 @@ func (c *ProjectsGithubEnterpriseConfigsDeleteCall) Do(opts ...googleapi.CallOpt // ], // "parameters": { // "configId": { + // "deprecated": true, // "description": "Unique identifier of the `GitHubEnterpriseConfig`", // "location": "query", // "type": "string" @@ -7132,6 +7133,7 @@ func (c *ProjectsGithubEnterpriseConfigsDeleteCall) Do(opts ...googleapi.CallOpt // "type": "string" // }, // "projectId": { + // "deprecated": true, // "description": "ID of the project", // "location": "query", // "type": "string" @@ -7292,6 +7294,7 @@ func (c *ProjectsGithubEnterpriseConfigsGetCall) Do(opts ...googleapi.CallOption // ], // "parameters": { // "configId": { + // "deprecated": true, // "description": "Unique identifier of the `GitHubEnterpriseConfig`", // "location": "query", // "type": "string" @@ -7304,6 +7307,7 @@ func (c *ProjectsGithubEnterpriseConfigsGetCall) Do(opts ...googleapi.CallOption // "type": "string" // }, // "projectId": { + // "deprecated": true, // "description": "ID of the project", // "location": "query", // "type": "string" @@ -7463,6 +7467,7 @@ func (c *ProjectsGithubEnterpriseConfigsListCall) Do(opts ...googleapi.CallOptio // "type": "string" // }, // "projectId": { + // "deprecated": true, // "description": "ID of the project", // "location": "query", // "type": "string" @@ -9789,8 +9794,8 @@ type ProjectsLocationsBuildsRetryCall struct { // the original build. * If the original build specified a commit sha or // revision ID, the retried build will use the identical source. For // builds that specify `StorageSource`: * If the original build pulled -// source from Google Cloud Storage without specifying the generation of -// the object, the new build will use the current object, which may be +// source from Cloud Storage without specifying the generation of the +// object, the new build will use the current object, which may be // different from the original build source. * If the original build // pulled source from Cloud Storage and specified the generation of the // object, the new build will attempt to use the same object, which may @@ -9897,7 +9902,7 @@ func (c *ProjectsLocationsBuildsRetryCall) Do(opts ...googleapi.CallOption) (*Op } return ret, nil // { - // "description": "Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", + // "description": "Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds/{buildsId}:retry", // "httpMethod": "POST", // "id": "cloudbuild.projects.locations.builds.retry", @@ -11358,6 +11363,7 @@ func (c *ProjectsLocationsGithubEnterpriseConfigsCreateCall) Do(opts ...googleap // "type": "string" // }, // "projectId": { + // "deprecated": true, // "description": "ID of the project.", // "location": "query", // "type": "string" @@ -11508,6 +11514,7 @@ func (c *ProjectsLocationsGithubEnterpriseConfigsDeleteCall) Do(opts ...googleap // ], // "parameters": { // "configId": { + // "deprecated": true, // "description": "Unique identifier of the `GitHubEnterpriseConfig`", // "location": "query", // "type": "string" @@ -11520,6 +11527,7 @@ func (c *ProjectsLocationsGithubEnterpriseConfigsDeleteCall) Do(opts ...googleap // "type": "string" // }, // "projectId": { + // "deprecated": true, // "description": "ID of the project", // "location": "query", // "type": "string" @@ -11680,6 +11688,7 @@ func (c *ProjectsLocationsGithubEnterpriseConfigsGetCall) Do(opts ...googleapi.C // ], // "parameters": { // "configId": { + // "deprecated": true, // "description": "Unique identifier of the `GitHubEnterpriseConfig`", // "location": "query", // "type": "string" @@ -11692,6 +11701,7 @@ func (c *ProjectsLocationsGithubEnterpriseConfigsGetCall) Do(opts ...googleapi.C // "type": "string" // }, // "projectId": { + // "deprecated": true, // "description": "ID of the project", // "location": "query", // "type": "string" @@ -11851,6 +11861,7 @@ func (c *ProjectsLocationsGithubEnterpriseConfigsListCall) Do(opts ...googleapi. // "type": "string" // }, // "projectId": { + // "deprecated": true, // "description": "ID of the project", // "location": "query", // "type": "string" diff --git a/composer/v1/composer-api.json b/composer/v1/composer-api.json index 9dc02e14911..38f3cfaf439 100644 --- a/composer/v1/composer-api.json +++ b/composer/v1/composer-api.json @@ -139,6 +139,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "databaseFailover": { + "description": "Triggers database failover (only for highly resilient environments).", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:databaseFailover", + "httpMethod": "POST", + "id": "composer.projects.locations.environments.databaseFailover", + "parameterOrder": [ + "environment" + ], + "parameters": { + "environment": { + "description": "Target environment: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+environment}:databaseFailover", + "request": { + "$ref": "DatabaseFailoverRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "delete": { "description": "Delete an environment.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}", @@ -164,6 +192,59 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "executeAirflowCommand": { + "description": "Executes Airflow CLI command.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:executeAirflowCommand", + "httpMethod": "POST", + "id": "composer.projects.locations.environments.executeAirflowCommand", + "parameterOrder": [ + "environment" + ], + "parameters": { + "environment": { + "description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+environment}:executeAirflowCommand", + "request": { + "$ref": "ExecuteAirflowCommandRequest" + }, + "response": { + "$ref": "ExecuteAirflowCommandResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchDatabaseProperties": { + "description": "Fetches database properties.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:fetchDatabaseProperties", + "httpMethod": "GET", + "id": "composer.projects.locations.environments.fetchDatabaseProperties", + "parameterOrder": [ + "environment" + ], + "parameters": { + "environment": { + "description": "Required. The resource name of the environment, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+environment}:fetchDatabaseProperties", + "response": { + "$ref": "FetchDatabasePropertiesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Get an existing environment.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}", @@ -287,6 +368,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "pollAirflowCommand": { + "description": "Polls Airflow CLI command execution and fetches logs.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:pollAirflowCommand", + "httpMethod": "POST", + "id": "composer.projects.locations.environments.pollAirflowCommand", + "parameterOrder": [ + "environment" + ], + "parameters": { + "environment": { + "description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+environment}:pollAirflowCommand", + "request": { + "$ref": "PollAirflowCommandRequest" + }, + "response": { + "$ref": "PollAirflowCommandResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "saveSnapshot": { "description": "Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:saveSnapshot", @@ -314,6 +423,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "stopAirflowCommand": { + "description": "Stops Airflow CLI command execution.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:stopAirflowCommand", + "httpMethod": "POST", + "id": "composer.projects.locations.environments.stopAirflowCommand", + "parameterOrder": [ + "environment" + ], + "parameters": { + "environment": { + "description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+environment}:stopAirflowCommand", + "request": { + "$ref": "StopAirflowCommandRequest" + }, + "response": { + "$ref": "StopAirflowCommandResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -462,7 +599,7 @@ } } }, - "revision": "20230323", + "revision": "20230516", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AllowedIpRange": { @@ -549,6 +686,18 @@ }, "type": "object" }, + "DatabaseFailoverRequest": { + "description": "Request to trigger database failover (only for highly resilient environments).", + "id": "DatabaseFailoverRequest", + "properties": {}, + "type": "object" + }, + "DatabaseFailoverResponse": { + "description": "Response for DatabaseFailoverRequest.", + "id": "DatabaseFailoverResponse", + "properties": {}, + "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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "id": "Date", @@ -714,6 +863,18 @@ "$ref": "RecoveryConfig", "description": "Optional. The Recovery settings configuration of an environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer." }, + "resilienceMode": { + "description": "Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer.", + "enum": [ + "RESILIENCE_MODE_UNSPECIFIED", + "HIGH_RESILIENCE" + ], + "enumDescriptions": [ + "Default mode doesn't change environment parameters.", + "Enabled High Resilience mode, including Cloud SQL HA." + ], + "type": "string" + }, "softwareConfig": { "$ref": "SoftwareConfig", "description": "The configuration settings for software inside the environment." @@ -733,6 +894,86 @@ }, "type": "object" }, + "ExecuteAirflowCommandRequest": { + "description": "Execute Airflow Command request.", + "id": "ExecuteAirflowCommandRequest", + "properties": { + "command": { + "description": "Airflow command.", + "type": "string" + }, + "parameters": { + "description": "Parameters for the Airflow command/subcommand as an array of arguments. It may contain positional arguments like `[\"my-dag-id\"]`, key-value parameters like `[\"--foo=bar\"]` or `[\"--foo\",\"bar\"]`, or other flags like `[\"-f\"]`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "subcommand": { + "description": "Airflow subcommand.", + "type": "string" + } + }, + "type": "object" + }, + "ExecuteAirflowCommandResponse": { + "description": "Response to ExecuteAirflowCommandRequest.", + "id": "ExecuteAirflowCommandResponse", + "properties": { + "error": { + "description": "Error message. Empty if there was no error.", + "type": "string" + }, + "executionId": { + "description": "The unique ID of the command execution for polling.", + "type": "string" + }, + "pod": { + "description": "The name of the pod where the command is executed.", + "type": "string" + }, + "podNamespace": { + "description": "The namespace of the pod where the command is executed.", + "type": "string" + } + }, + "type": "object" + }, + "ExitInfo": { + "description": "Information about how a command ended.", + "id": "ExitInfo", + "properties": { + "error": { + "description": "Error message. Empty if there was no error.", + "type": "string" + }, + "exitCode": { + "description": "The exit code from the command execution.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "FetchDatabasePropertiesResponse": { + "description": "Response for FetchDatabasePropertiesRequest.", + "id": "FetchDatabasePropertiesResponse", + "properties": { + "isFailoverReplicaAvailable": { + "description": "The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only fail over to the failover replica when the status is true.", + "type": "boolean" + }, + "primaryGceZone": { + "description": "The Compute Engine zone that the instance is currently serving from.", + "type": "string" + }, + "secondaryGceZone": { + "description": "The Compute Engine zone that the failover instance is currently serving from for a regional Cloud SQL instance.", + "type": "string" + } + }, + "type": "object" + }, "IPAllocationPolicy": { "description": "Configuration for controlling how IPs are allocated in the GKE cluster running the Apache Airflow software.", "id": "IPAllocationPolicy", @@ -794,6 +1035,22 @@ }, "type": "object" }, + "Line": { + "description": "Contains information about a single line from logs.", + "id": "Line", + "properties": { + "content": { + "description": "Text content of the log line.", + "type": "string" + }, + "lineNumber": { + "description": "Number of the line.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "ListEnvironmentsResponse": { "description": "The environments in a project and location.", "id": "ListEnvironmentsResponse", @@ -1053,7 +1310,8 @@ "UPDATE", "CHECK", "SAVE_SNAPSHOT", - "LOAD_SNAPSHOT" + "LOAD_SNAPSHOT", + "DATABASE_FAILOVER" ], "enumDescriptions": [ "Unused.", @@ -1062,7 +1320,8 @@ "A resource update operation.", "A resource check operation.", "Saves snapshot of the resource operation.", - "Loads snapshot of the resource operation." + "Loads snapshot of the resource operation.", + "Triggers failover of environment's Cloud SQL instance (only for highly resilient environments)." ], "type": "string" }, @@ -1097,6 +1356,52 @@ }, "type": "object" }, + "PollAirflowCommandRequest": { + "description": "Poll Airflow Command request.", + "id": "PollAirflowCommandRequest", + "properties": { + "executionId": { + "description": "The unique ID of the command execution.", + "type": "string" + }, + "nextLineNumber": { + "description": "Line number from which new logs should be fetched.", + "format": "int32", + "type": "integer" + }, + "pod": { + "description": "The name of the pod where the command is executed.", + "type": "string" + }, + "podNamespace": { + "description": "The namespace of the pod where the command is executed.", + "type": "string" + } + }, + "type": "object" + }, + "PollAirflowCommandResponse": { + "description": "Response to PollAirflowCommandRequest.", + "id": "PollAirflowCommandResponse", + "properties": { + "exitInfo": { + "$ref": "ExitInfo", + "description": "The result exit status of the command." + }, + "output": { + "description": "Output from the command execution. It may not contain the full output and the caller may need to poll for more lines.", + "items": { + "$ref": "Line" + }, + "type": "array" + }, + "outputEnd": { + "description": "Whether the command execution has finished and there is no more output.", + "type": "boolean" + } + }, + "type": "object" + }, "PrivateClusterConfig": { "description": "Configuration options for the private GKE cluster in a Cloud Composer environment.", "id": "PrivateClusterConfig", @@ -1317,6 +1622,47 @@ }, "type": "object" }, + "StopAirflowCommandRequest": { + "description": "Stop Airflow Command request.", + "id": "StopAirflowCommandRequest", + "properties": { + "executionId": { + "description": "The unique ID of the command execution.", + "type": "string" + }, + "force": { + "description": "If true, the execution is terminated forcefully (SIGKILL). If false, the execution is stopped gracefully, giving it time for cleanup.", + "type": "boolean" + }, + "pod": { + "description": "The name of the pod where the command is executed.", + "type": "string" + }, + "podNamespace": { + "description": "The namespace of the pod where the command is executed.", + "type": "string" + } + }, + "type": "object" + }, + "StopAirflowCommandResponse": { + "description": "Response to StopAirflowCommandRequest.", + "id": "StopAirflowCommandResponse", + "properties": { + "isDone": { + "description": "Whether the execution is still running.", + "type": "boolean" + }, + "output": { + "description": "Output message from stopping execution request.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "WebServerConfig": { "description": "The configuration settings for the Airflow web server App Engine instance. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*", "id": "WebServerConfig", diff --git a/composer/v1/composer-gen.go b/composer/v1/composer-gen.go index 56a6998f565..66195ae2c40 100644 --- a/composer/v1/composer-gen.go +++ b/composer/v1/composer-gen.go @@ -348,6 +348,15 @@ func (s *DatabaseConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// DatabaseFailoverRequest: Request to trigger database failover (only +// for highly resilient environments). +type DatabaseFailoverRequest struct { +} + +// DatabaseFailoverResponse: Response for DatabaseFailoverRequest. +type DatabaseFailoverResponse struct { +} + // Date: 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 @@ -597,6 +606,17 @@ type EnvironmentConfig struct { // in versions composer-2.*.*-airflow-*.*.* and newer. RecoveryConfig *RecoveryConfig `json:"recoveryConfig,omitempty"` + // ResilienceMode: Optional. Resilience mode of the Cloud Composer + // Environment. This field is supported for Cloud Composer environments + // in versions composer-2.2.0-airflow-*.*.* and newer. + // + // Possible values: + // "RESILIENCE_MODE_UNSPECIFIED" - Default mode doesn't change + // environment parameters. + // "HIGH_RESILIENCE" - Enabled High Resilience mode, including Cloud + // SQL HA. + ResilienceMode string `json:"resilienceMode,omitempty"` + // SoftwareConfig: The configuration settings for software inside the // environment. SoftwareConfig *SoftwareConfig `json:"softwareConfig,omitempty"` @@ -641,6 +661,162 @@ func (s *EnvironmentConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// ExecuteAirflowCommandRequest: Execute Airflow Command request. +type ExecuteAirflowCommandRequest struct { + // Command: Airflow command. + Command string `json:"command,omitempty"` + + // Parameters: Parameters for the Airflow command/subcommand as an array + // of arguments. It may contain positional arguments like + // `["my-dag-id"]`, key-value parameters like `["--foo=bar"]` or + // `["--foo","bar"]`, or other flags like `["-f"]`. + Parameters []string `json:"parameters,omitempty"` + + // Subcommand: Airflow subcommand. + Subcommand string `json:"subcommand,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Command") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Command") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ExecuteAirflowCommandRequest) MarshalJSON() ([]byte, error) { + type NoMethod ExecuteAirflowCommandRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ExecuteAirflowCommandResponse: Response to +// ExecuteAirflowCommandRequest. +type ExecuteAirflowCommandResponse struct { + // Error: Error message. Empty if there was no error. + Error string `json:"error,omitempty"` + + // ExecutionId: The unique ID of the command execution for polling. + ExecutionId string `json:"executionId,omitempty"` + + // Pod: The name of the pod where the command is executed. + Pod string `json:"pod,omitempty"` + + // PodNamespace: The namespace of the pod where the command is executed. + PodNamespace string `json:"podNamespace,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "Error") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Error") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ExecuteAirflowCommandResponse) MarshalJSON() ([]byte, error) { + type NoMethod ExecuteAirflowCommandResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ExitInfo: Information about how a command ended. +type ExitInfo struct { + // Error: Error message. Empty if there was no error. + Error string `json:"error,omitempty"` + + // ExitCode: The exit code from the command execution. + ExitCode int64 `json:"exitCode,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Error") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Error") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ExitInfo) MarshalJSON() ([]byte, error) { + type NoMethod ExitInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// FetchDatabasePropertiesResponse: Response for +// FetchDatabasePropertiesRequest. +type FetchDatabasePropertiesResponse struct { + // IsFailoverReplicaAvailable: The availability status of the failover + // replica. A false status indicates that the failover replica is out of + // sync. The primary instance can only fail over to the failover replica + // when the status is true. + IsFailoverReplicaAvailable bool `json:"isFailoverReplicaAvailable,omitempty"` + + // PrimaryGceZone: The Compute Engine zone that the instance is + // currently serving from. + PrimaryGceZone string `json:"primaryGceZone,omitempty"` + + // SecondaryGceZone: The Compute Engine zone that the failover instance + // is currently serving from for a regional Cloud SQL instance. + SecondaryGceZone string `json:"secondaryGceZone,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. + // "IsFailoverReplicaAvailable") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. + // "IsFailoverReplicaAvailable") to include in API requests with the + // JSON null value. By default, fields with empty values are omitted + // from API requests. However, any field with an empty value appearing + // in NullFields will be sent to the server as null. It is an error if a + // field in this list has a non-empty value. This may be used to include + // null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *FetchDatabasePropertiesResponse) MarshalJSON() ([]byte, error) { + type NoMethod FetchDatabasePropertiesResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // IPAllocationPolicy: Configuration for controlling how IPs are // allocated in the GKE cluster running the Apache Airflow software. type IPAllocationPolicy struct { @@ -760,6 +936,37 @@ func (s *ImageVersion) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// Line: Contains information about a single line from logs. +type Line struct { + // Content: Text content of the log line. + Content string `json:"content,omitempty"` + + // LineNumber: Number of the line. + LineNumber int64 `json:"lineNumber,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Content") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Content") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *Line) MarshalJSON() ([]byte, error) { + type NoMethod Line + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // ListEnvironmentsResponse: The environments in a project and location. type ListEnvironmentsResponse struct { // Environments: The list of environments returned by a @@ -1248,6 +1455,8 @@ type OperationMetadata struct { // "CHECK" - A resource check operation. // "SAVE_SNAPSHOT" - Saves snapshot of the resource operation. // "LOAD_SNAPSHOT" - Loads snapshot of the resource operation. + // "DATABASE_FAILOVER" - Triggers failover of environment's Cloud SQL + // instance (only for highly resilient environments). OperationType string `json:"operationType,omitempty"` // Resource: Output only. The resource being operated on, as a relative @@ -1292,6 +1501,83 @@ func (s *OperationMetadata) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// PollAirflowCommandRequest: Poll Airflow Command request. +type PollAirflowCommandRequest struct { + // ExecutionId: The unique ID of the command execution. + ExecutionId string `json:"executionId,omitempty"` + + // NextLineNumber: Line number from which new logs should be fetched. + NextLineNumber int64 `json:"nextLineNumber,omitempty"` + + // Pod: The name of the pod where the command is executed. + Pod string `json:"pod,omitempty"` + + // PodNamespace: The namespace of the pod where the command is executed. + PodNamespace string `json:"podNamespace,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExecutionId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ExecutionId") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *PollAirflowCommandRequest) MarshalJSON() ([]byte, error) { + type NoMethod PollAirflowCommandRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// PollAirflowCommandResponse: Response to PollAirflowCommandRequest. +type PollAirflowCommandResponse struct { + // ExitInfo: The result exit status of the command. + ExitInfo *ExitInfo `json:"exitInfo,omitempty"` + + // Output: Output from the command execution. It may not contain the + // full output and the caller may need to poll for more lines. + Output []*Line `json:"output,omitempty"` + + // OutputEnd: Whether the command execution has finished and there is no + // more output. + OutputEnd bool `json:"outputEnd,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "ExitInfo") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ExitInfo") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *PollAirflowCommandResponse) MarshalJSON() ([]byte, error) { + type NoMethod PollAirflowCommandResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // PrivateClusterConfig: Configuration options for the private GKE // cluster in a Cloud Composer environment. type PrivateClusterConfig struct { @@ -1761,6 +2047,80 @@ func (s *Status) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// StopAirflowCommandRequest: Stop Airflow Command request. +type StopAirflowCommandRequest struct { + // ExecutionId: The unique ID of the command execution. + ExecutionId string `json:"executionId,omitempty"` + + // Force: If true, the execution is terminated forcefully (SIGKILL). If + // false, the execution is stopped gracefully, giving it time for + // cleanup. + Force bool `json:"force,omitempty"` + + // Pod: The name of the pod where the command is executed. + Pod string `json:"pod,omitempty"` + + // PodNamespace: The namespace of the pod where the command is executed. + PodNamespace string `json:"podNamespace,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExecutionId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ExecutionId") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *StopAirflowCommandRequest) MarshalJSON() ([]byte, error) { + type NoMethod StopAirflowCommandRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// StopAirflowCommandResponse: Response to StopAirflowCommandRequest. +type StopAirflowCommandResponse struct { + // IsDone: Whether the execution is still running. + IsDone bool `json:"isDone,omitempty"` + + // Output: Output message from stopping execution request. + Output []string `json:"output,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "IsDone") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "IsDone") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *StopAirflowCommandResponse) MarshalJSON() ([]byte, error) { + type NoMethod StopAirflowCommandResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // WebServerConfig: The configuration settings for the Airflow web // server App Engine instance. Supported for Cloud Composer environments // in versions composer-1.*.*-airflow-*.*.* @@ -2122,31 +2482,34 @@ func (c *ProjectsLocationsEnvironmentsCreateCall) Do(opts ...googleapi.CallOptio } -// method id "composer.projects.locations.environments.delete": +// method id "composer.projects.locations.environments.databaseFailover": -type ProjectsLocationsEnvironmentsDeleteCall struct { - s *Service - name string - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header +type ProjectsLocationsEnvironmentsDatabaseFailoverCall struct { + s *Service + environment string + databasefailoverrequest *DatabaseFailoverRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header } -// Delete: Delete an environment. +// DatabaseFailover: Triggers database failover (only for highly +// resilient environments). // -// - name: The environment to delete, in the form: +// - environment: Target environment: // "projects/{projectId}/locations/{locationId}/environments/{environme // ntId}". -func (r *ProjectsLocationsEnvironmentsService) Delete(name string) *ProjectsLocationsEnvironmentsDeleteCall { - c := &ProjectsLocationsEnvironmentsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.name = name +func (r *ProjectsLocationsEnvironmentsService) DatabaseFailover(environment string, databasefailoverrequest *DatabaseFailoverRequest) *ProjectsLocationsEnvironmentsDatabaseFailoverCall { + c := &ProjectsLocationsEnvironmentsDatabaseFailoverCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.environment = environment + c.databasefailoverrequest = databasefailoverrequest return c } // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse // for more information. -func (c *ProjectsLocationsEnvironmentsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsDeleteCall { +func (c *ProjectsLocationsEnvironmentsDatabaseFailoverCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsDatabaseFailoverCall { c.urlParams_.Set("fields", googleapi.CombineFields(s)) return c } @@ -2154,21 +2517,21 @@ func (c *ProjectsLocationsEnvironmentsDeleteCall) Fields(s ...googleapi.Field) * // Context sets the context to be used in this call's Do method. Any // pending HTTP request will be aborted if the provided context is // canceled. -func (c *ProjectsLocationsEnvironmentsDeleteCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsDeleteCall { +func (c *ProjectsLocationsEnvironmentsDatabaseFailoverCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsDatabaseFailoverCall { c.ctx_ = ctx return c } // Header returns an http.Header that can be modified by the caller to // add HTTP headers to the request. -func (c *ProjectsLocationsEnvironmentsDeleteCall) Header() http.Header { +func (c *ProjectsLocationsEnvironmentsDatabaseFailoverCall) Header() http.Header { if c.header_ == nil { c.header_ = make(http.Header) } return c.header_ } -func (c *ProjectsLocationsEnvironmentsDeleteCall) doRequest(alt string) (*http.Response, error) { +func (c *ProjectsLocationsEnvironmentsDatabaseFailoverCall) doRequest(alt string) (*http.Response, error) { reqHeaders := make(http.Header) reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) for k, v := range c.header_ { @@ -2176,29 +2539,34 @@ func (c *ProjectsLocationsEnvironmentsDeleteCall) doRequest(alt string) (*http.R } reqHeaders.Set("User-Agent", c.s.userAgent()) var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.databasefailoverrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+environment}:databaseFailover") urls += "?" + c.urlParams_.Encode() - req, err := http.NewRequest("DELETE", urls, body) + req, err := http.NewRequest("POST", urls, body) if err != nil { return nil, err } req.Header = reqHeaders googleapi.Expand(req.URL, map[string]string{ - "name": c.name, + "environment": c.environment, }) return gensupport.SendRequest(c.ctx_, c.s.client, req) } -// Do executes the "composer.projects.locations.environments.delete" call. +// Do executes the "composer.projects.locations.environments.databaseFailover" call. // Exactly one of *Operation or error will be non-nil. Any non-2xx // status code is an error. Response headers are in either // *Operation.ServerResponse.Header or (if a response was returned at // all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified // to check whether the returned error was because // http.StatusNotModified was returned. -func (c *ProjectsLocationsEnvironmentsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error) { +func (c *ProjectsLocationsEnvironmentsDatabaseFailoverCall) Do(opts ...googleapi.CallOption) (*Operation, error) { gensupport.SetOptions(c.urlParams_, opts...) res, err := c.doRequest("json") if res != nil && res.StatusCode == http.StatusNotModified { @@ -2229,25 +2597,454 @@ func (c *ProjectsLocationsEnvironmentsDeleteCall) Do(opts ...googleapi.CallOptio } return ret, nil // { - // "description": "Delete an environment.", - // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}", - // "httpMethod": "DELETE", - // "id": "composer.projects.locations.environments.delete", + // "description": "Triggers database failover (only for highly resilient environments).", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:databaseFailover", + // "httpMethod": "POST", + // "id": "composer.projects.locations.environments.databaseFailover", + // "parameterOrder": [ + // "environment" + // ], + // "parameters": { + // "environment": { + // "description": "Target environment: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+environment}:databaseFailover", + // "request": { + // "$ref": "DatabaseFailoverRequest" + // }, + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "composer.projects.locations.environments.delete": + +type ProjectsLocationsEnvironmentsDeleteCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Delete: Delete an environment. +// +// - name: The environment to delete, in the form: +// "projects/{projectId}/locations/{locationId}/environments/{environme +// ntId}". +func (r *ProjectsLocationsEnvironmentsService) Delete(name string) *ProjectsLocationsEnvironmentsDeleteCall { + c := &ProjectsLocationsEnvironmentsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsEnvironmentsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsDeleteCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsEnvironmentsDeleteCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsDeleteCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsEnvironmentsDeleteCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsEnvironmentsDeleteCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("DELETE", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "composer.projects.locations.environments.delete" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsEnvironmentsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Operation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Delete an environment.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}", + // "httpMethod": "DELETE", + // "id": "composer.projects.locations.environments.delete", // "parameterOrder": [ // "name" // ], // "parameters": { - // "name": { - // "description": "The environment to delete, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + // "name": { + // "description": "The environment to delete, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+name}", + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "composer.projects.locations.environments.executeAirflowCommand": + +type ProjectsLocationsEnvironmentsExecuteAirflowCommandCall struct { + s *Service + environment string + executeairflowcommandrequest *ExecuteAirflowCommandRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// ExecuteAirflowCommand: Executes Airflow CLI command. +// +// - environment: The resource name of the environment in the form: +// "projects/{projectId}/locations/{locationId}/environments/{environme +// ntId}". +func (r *ProjectsLocationsEnvironmentsService) ExecuteAirflowCommand(environment string, executeairflowcommandrequest *ExecuteAirflowCommandRequest) *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall { + c := &ProjectsLocationsEnvironmentsExecuteAirflowCommandCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.environment = environment + c.executeairflowcommandrequest = executeairflowcommandrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.executeairflowcommandrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+environment}:executeAirflowCommand") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "environment": c.environment, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "composer.projects.locations.environments.executeAirflowCommand" call. +// Exactly one of *ExecuteAirflowCommandResponse or error will be +// non-nil. Any non-2xx status code is an error. Response headers are in +// either *ExecuteAirflowCommandResponse.ServerResponse.Header or (if a +// response was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall) Do(opts ...googleapi.CallOption) (*ExecuteAirflowCommandResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &ExecuteAirflowCommandResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Executes Airflow CLI command.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:executeAirflowCommand", + // "httpMethod": "POST", + // "id": "composer.projects.locations.environments.executeAirflowCommand", + // "parameterOrder": [ + // "environment" + // ], + // "parameters": { + // "environment": { + // "description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\".", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+environment}:executeAirflowCommand", + // "request": { + // "$ref": "ExecuteAirflowCommandRequest" + // }, + // "response": { + // "$ref": "ExecuteAirflowCommandResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "composer.projects.locations.environments.fetchDatabaseProperties": + +type ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall struct { + s *Service + environment string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// FetchDatabaseProperties: Fetches database properties. +// +// - environment: The resource name of the environment, in the form: +// "projects/{projectId}/locations/{locationId}/environments/{environme +// ntId}". +func (r *ProjectsLocationsEnvironmentsService) FetchDatabaseProperties(environment string) *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall { + c := &ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.environment = environment + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) IfNoneMatch(entityTag string) *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+environment}:fetchDatabaseProperties") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "environment": c.environment, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "composer.projects.locations.environments.fetchDatabaseProperties" call. +// Exactly one of *FetchDatabasePropertiesResponse or error will be +// non-nil. Any non-2xx status code is an error. Response headers are in +// either *FetchDatabasePropertiesResponse.ServerResponse.Header or (if +// a response was returned at all) in error.(*googleapi.Error).Header. +// Use googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) Do(opts ...googleapi.CallOption) (*FetchDatabasePropertiesResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &FetchDatabasePropertiesResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Fetches database properties.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:fetchDatabaseProperties", + // "httpMethod": "GET", + // "id": "composer.projects.locations.environments.fetchDatabaseProperties", + // "parameterOrder": [ + // "environment" + // ], + // "parameters": { + // "environment": { + // "description": "Required. The resource name of the environment, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", // "required": true, // "type": "string" // } // }, - // "path": "v1/{+name}", + // "path": "v1/{+environment}:fetchDatabaseProperties", // "response": { - // "$ref": "Operation" + // "$ref": "FetchDatabasePropertiesResponse" // }, // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform" @@ -2983,6 +3780,151 @@ func (c *ProjectsLocationsEnvironmentsPatchCall) Do(opts ...googleapi.CallOption } +// method id "composer.projects.locations.environments.pollAirflowCommand": + +type ProjectsLocationsEnvironmentsPollAirflowCommandCall struct { + s *Service + environment string + pollairflowcommandrequest *PollAirflowCommandRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// PollAirflowCommand: Polls Airflow CLI command execution and fetches +// logs. +// +// - environment: The resource name of the environment in the form: +// "projects/{projectId}/locations/{locationId}/environments/{environme +// ntId}". +func (r *ProjectsLocationsEnvironmentsService) PollAirflowCommand(environment string, pollairflowcommandrequest *PollAirflowCommandRequest) *ProjectsLocationsEnvironmentsPollAirflowCommandCall { + c := &ProjectsLocationsEnvironmentsPollAirflowCommandCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.environment = environment + c.pollairflowcommandrequest = pollairflowcommandrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsEnvironmentsPollAirflowCommandCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsPollAirflowCommandCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsEnvironmentsPollAirflowCommandCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsPollAirflowCommandCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsEnvironmentsPollAirflowCommandCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsEnvironmentsPollAirflowCommandCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.pollairflowcommandrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+environment}:pollAirflowCommand") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "environment": c.environment, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "composer.projects.locations.environments.pollAirflowCommand" call. +// Exactly one of *PollAirflowCommandResponse or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *PollAirflowCommandResponse.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsEnvironmentsPollAirflowCommandCall) Do(opts ...googleapi.CallOption) (*PollAirflowCommandResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &PollAirflowCommandResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Polls Airflow CLI command execution and fetches logs.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:pollAirflowCommand", + // "httpMethod": "POST", + // "id": "composer.projects.locations.environments.pollAirflowCommand", + // "parameterOrder": [ + // "environment" + // ], + // "parameters": { + // "environment": { + // "description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+environment}:pollAirflowCommand", + // "request": { + // "$ref": "PollAirflowCommandRequest" + // }, + // "response": { + // "$ref": "PollAirflowCommandResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "composer.projects.locations.environments.saveSnapshot": type ProjectsLocationsEnvironmentsSaveSnapshotCall struct { @@ -3130,6 +4072,150 @@ func (c *ProjectsLocationsEnvironmentsSaveSnapshotCall) Do(opts ...googleapi.Cal } +// method id "composer.projects.locations.environments.stopAirflowCommand": + +type ProjectsLocationsEnvironmentsStopAirflowCommandCall struct { + s *Service + environment string + stopairflowcommandrequest *StopAirflowCommandRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// StopAirflowCommand: Stops Airflow CLI command execution. +// +// - environment: The resource name of the environment in the form: +// "projects/{projectId}/locations/{locationId}/environments/{environme +// ntId}". +func (r *ProjectsLocationsEnvironmentsService) StopAirflowCommand(environment string, stopairflowcommandrequest *StopAirflowCommandRequest) *ProjectsLocationsEnvironmentsStopAirflowCommandCall { + c := &ProjectsLocationsEnvironmentsStopAirflowCommandCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.environment = environment + c.stopairflowcommandrequest = stopairflowcommandrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsEnvironmentsStopAirflowCommandCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsStopAirflowCommandCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsEnvironmentsStopAirflowCommandCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsStopAirflowCommandCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsEnvironmentsStopAirflowCommandCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsEnvironmentsStopAirflowCommandCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.stopairflowcommandrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+environment}:stopAirflowCommand") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "environment": c.environment, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "composer.projects.locations.environments.stopAirflowCommand" call. +// Exactly one of *StopAirflowCommandResponse or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *StopAirflowCommandResponse.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsEnvironmentsStopAirflowCommandCall) Do(opts ...googleapi.CallOption) (*StopAirflowCommandResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &StopAirflowCommandResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Stops Airflow CLI command execution.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:stopAirflowCommand", + // "httpMethod": "POST", + // "id": "composer.projects.locations.environments.stopAirflowCommand", + // "parameterOrder": [ + // "environment" + // ], + // "parameters": { + // "environment": { + // "description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\".", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+environment}:stopAirflowCommand", + // "request": { + // "$ref": "StopAirflowCommandRequest" + // }, + // "response": { + // "$ref": "StopAirflowCommandResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "composer.projects.locations.imageVersions.list": type ProjectsLocationsImageVersionsListCall struct { diff --git a/composer/v1beta1/composer-api.json b/composer/v1beta1/composer-api.json index 1ad78657ab7..4faa96a3a2f 100644 --- a/composer/v1beta1/composer-api.json +++ b/composer/v1beta1/composer-api.json @@ -167,6 +167,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "databaseFailover": { + "description": "Triggers database failover (only for highly resilient environments).", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:databaseFailover", + "httpMethod": "POST", + "id": "composer.projects.locations.environments.databaseFailover", + "parameterOrder": [ + "environment" + ], + "parameters": { + "environment": { + "description": "Target environment: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+environment}:databaseFailover", + "request": { + "$ref": "DatabaseFailoverRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "delete": { "description": "Delete an environment.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}", @@ -192,6 +220,59 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "executeAirflowCommand": { + "description": "Executes Airflow CLI command.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:executeAirflowCommand", + "httpMethod": "POST", + "id": "composer.projects.locations.environments.executeAirflowCommand", + "parameterOrder": [ + "environment" + ], + "parameters": { + "environment": { + "description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+environment}:executeAirflowCommand", + "request": { + "$ref": "ExecuteAirflowCommandRequest" + }, + "response": { + "$ref": "ExecuteAirflowCommandResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchDatabaseProperties": { + "description": "Fetches database properties.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:fetchDatabaseProperties", + "httpMethod": "GET", + "id": "composer.projects.locations.environments.fetchDatabaseProperties", + "parameterOrder": [ + "environment" + ], + "parameters": { + "environment": { + "description": "Required. The resource name of the environment, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+environment}:fetchDatabaseProperties", + "response": { + "$ref": "FetchDatabasePropertiesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Get an existing environment.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}", @@ -315,6 +396,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "pollAirflowCommand": { + "description": "Polls Airflow CLI command execution and fetches logs.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:pollAirflowCommand", + "httpMethod": "POST", + "id": "composer.projects.locations.environments.pollAirflowCommand", + "parameterOrder": [ + "environment" + ], + "parameters": { + "environment": { + "description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+environment}:pollAirflowCommand", + "request": { + "$ref": "PollAirflowCommandRequest" + }, + "response": { + "$ref": "PollAirflowCommandResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "restartWebServer": { "description": "Restart Airflow web server.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:restartWebServer", @@ -370,6 +479,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "stopAirflowCommand": { + "description": "Stops Airflow CLI command execution.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:stopAirflowCommand", + "httpMethod": "POST", + "id": "composer.projects.locations.environments.stopAirflowCommand", + "parameterOrder": [ + "environment" + ], + "parameters": { + "environment": { + "description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+environment}:stopAirflowCommand", + "request": { + "$ref": "StopAirflowCommandRequest" + }, + "response": { + "$ref": "StopAirflowCommandResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -518,7 +655,7 @@ } } }, - "revision": "20230510", + "revision": "20230516", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AllowedIpRange": { @@ -627,6 +764,18 @@ }, "type": "object" }, + "DatabaseFailoverRequest": { + "description": "Request to trigger database failover (only for highly resilient environments).", + "id": "DatabaseFailoverRequest", + "properties": {}, + "type": "object" + }, + "DatabaseFailoverResponse": { + "description": "Response for DatabaseFailoverRequest.", + "id": "DatabaseFailoverResponse", + "properties": {}, + "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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "id": "Date", @@ -798,6 +947,18 @@ "$ref": "RecoveryConfig", "description": "Optional. The Recovery settings configuration of an environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer." }, + "resilienceMode": { + "description": "Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer.", + "enum": [ + "RESILIENCE_MODE_UNSPECIFIED", + "HIGH_RESILIENCE" + ], + "enumDescriptions": [ + "Default mode doesn't change environment parameters.", + "Enabled High Resilience mode, including Cloud SQL HA." + ], + "type": "string" + }, "softwareConfig": { "$ref": "SoftwareConfig", "description": "The configuration settings for software inside the environment." @@ -817,6 +978,86 @@ }, "type": "object" }, + "ExecuteAirflowCommandRequest": { + "description": "Execute Airflow Command request.", + "id": "ExecuteAirflowCommandRequest", + "properties": { + "command": { + "description": "Airflow command.", + "type": "string" + }, + "parameters": { + "description": "Parameters for the Airflow command/subcommand as an array of arguments. It may contain positional arguments like `[\"my-dag-id\"]`, key-value parameters like `[\"--foo=bar\"]` or `[\"--foo\",\"bar\"]`, or other flags like `[\"-f\"]`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "subcommand": { + "description": "Airflow subcommand.", + "type": "string" + } + }, + "type": "object" + }, + "ExecuteAirflowCommandResponse": { + "description": "Response to ExecuteAirflowCommandRequest.", + "id": "ExecuteAirflowCommandResponse", + "properties": { + "error": { + "description": "Error message. Empty if there was no error.", + "type": "string" + }, + "executionId": { + "description": "The unique ID of the command execution for polling.", + "type": "string" + }, + "pod": { + "description": "The name of the pod where the command is executed.", + "type": "string" + }, + "podNamespace": { + "description": "The namespace of the pod where the command is executed.", + "type": "string" + } + }, + "type": "object" + }, + "ExitInfo": { + "description": "Information about how a command ended.", + "id": "ExitInfo", + "properties": { + "error": { + "description": "Error message. Empty if there was no error.", + "type": "string" + }, + "exitCode": { + "description": "The exit code from the command execution.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "FetchDatabasePropertiesResponse": { + "description": "Response for FetchDatabasePropertiesRequest.", + "id": "FetchDatabasePropertiesResponse", + "properties": { + "isFailoverReplicaAvailable": { + "description": "The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only fail over to the failover replica when the status is true.", + "type": "boolean" + }, + "primaryGceZone": { + "description": "The Compute Engine zone that the instance is currently serving from.", + "type": "string" + }, + "secondaryGceZone": { + "description": "The Compute Engine zone that the failover instance is currently serving from for a regional Cloud SQL instance.", + "type": "string" + } + }, + "type": "object" + }, "IPAllocationPolicy": { "description": "Configuration for controlling how IPs are allocated in the GKE cluster.", "id": "IPAllocationPolicy", @@ -878,6 +1119,22 @@ }, "type": "object" }, + "Line": { + "description": "Contains information about a single line from logs.", + "id": "Line", + "properties": { + "content": { + "description": "Text content of the log line.", + "type": "string" + }, + "lineNumber": { + "description": "Number of the line.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "ListEnvironmentsResponse": { "description": "The environments in a project and location.", "id": "ListEnvironmentsResponse", @@ -1142,7 +1399,8 @@ "UPDATE", "CHECK", "SAVE_SNAPSHOT", - "LOAD_SNAPSHOT" + "LOAD_SNAPSHOT", + "DATABASE_FAILOVER" ], "enumDescriptions": [ "Unused.", @@ -1151,7 +1409,8 @@ "A resource update operation.", "A resource check operation.", "Saves snapshot of the resource operation.", - "Loads snapshot of the resource operation." + "Loads snapshot of the resource operation.", + "Triggers failover of environment's Cloud SQL instance (only for highly resilient environments)." ], "type": "string" }, @@ -1184,6 +1443,52 @@ }, "type": "object" }, + "PollAirflowCommandRequest": { + "description": "Poll Airflow Command request.", + "id": "PollAirflowCommandRequest", + "properties": { + "executionId": { + "description": "The unique ID of the command execution.", + "type": "string" + }, + "nextLineNumber": { + "description": "Line number from which new logs should be fetched.", + "format": "int32", + "type": "integer" + }, + "pod": { + "description": "The name of the pod where the command is executed.", + "type": "string" + }, + "podNamespace": { + "description": "The namespace of the pod where the command is executed.", + "type": "string" + } + }, + "type": "object" + }, + "PollAirflowCommandResponse": { + "description": "Response to PollAirflowCommandRequest.", + "id": "PollAirflowCommandResponse", + "properties": { + "exitInfo": { + "$ref": "ExitInfo", + "description": "The result exit status of the command." + }, + "output": { + "description": "Output from the command execution. It may not contain the full output and the caller may need to poll for more lines.", + "items": { + "$ref": "Line" + }, + "type": "array" + }, + "outputEnd": { + "description": "Whether the command execution has finished and there is no more output.", + "type": "boolean" + } + }, + "type": "object" + }, "PrivateClusterConfig": { "description": "Configuration options for the private GKE cluster in a Cloud Composer environment.", "id": "PrivateClusterConfig", @@ -1414,6 +1719,47 @@ }, "type": "object" }, + "StopAirflowCommandRequest": { + "description": "Stop Airflow Command request.", + "id": "StopAirflowCommandRequest", + "properties": { + "executionId": { + "description": "The unique ID of the command execution.", + "type": "string" + }, + "force": { + "description": "If true, the execution is terminated forcefully (SIGKILL). If false, the execution is stopped gracefully, giving it time for cleanup.", + "type": "boolean" + }, + "pod": { + "description": "The name of the pod where the command is executed.", + "type": "string" + }, + "podNamespace": { + "description": "The namespace of the pod where the command is executed.", + "type": "string" + } + }, + "type": "object" + }, + "StopAirflowCommandResponse": { + "description": "Response to StopAirflowCommandRequest.", + "id": "StopAirflowCommandResponse", + "properties": { + "isDone": { + "description": "Whether the execution is still running.", + "type": "boolean" + }, + "output": { + "description": "Output message from stopping execution request.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "TriggererResource": { "description": "Configuration for resources used by Airflow triggerers.", "id": "TriggererResource", diff --git a/composer/v1beta1/composer-gen.go b/composer/v1beta1/composer-gen.go index ae6cc1f177b..be72c72ba43 100644 --- a/composer/v1beta1/composer-gen.go +++ b/composer/v1beta1/composer-gen.go @@ -428,6 +428,15 @@ func (s *DatabaseConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// DatabaseFailoverRequest: Request to trigger database failover (only +// for highly resilient environments). +type DatabaseFailoverRequest struct { +} + +// DatabaseFailoverResponse: Response for DatabaseFailoverRequest. +type DatabaseFailoverResponse struct { +} + // Date: 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 @@ -677,6 +686,17 @@ type EnvironmentConfig struct { // in versions composer-2.*.*-airflow-*.*.* and newer. RecoveryConfig *RecoveryConfig `json:"recoveryConfig,omitempty"` + // ResilienceMode: Optional. Resilience mode of the Cloud Composer + // Environment. This field is supported for Cloud Composer environments + // in versions composer-2.2.0-airflow-*.*.* and newer. + // + // Possible values: + // "RESILIENCE_MODE_UNSPECIFIED" - Default mode doesn't change + // environment parameters. + // "HIGH_RESILIENCE" - Enabled High Resilience mode, including Cloud + // SQL HA. + ResilienceMode string `json:"resilienceMode,omitempty"` + // SoftwareConfig: The configuration settings for software inside the // environment. SoftwareConfig *SoftwareConfig `json:"softwareConfig,omitempty"` @@ -722,6 +742,162 @@ func (s *EnvironmentConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// ExecuteAirflowCommandRequest: Execute Airflow Command request. +type ExecuteAirflowCommandRequest struct { + // Command: Airflow command. + Command string `json:"command,omitempty"` + + // Parameters: Parameters for the Airflow command/subcommand as an array + // of arguments. It may contain positional arguments like + // `["my-dag-id"]`, key-value parameters like `["--foo=bar"]` or + // `["--foo","bar"]`, or other flags like `["-f"]`. + Parameters []string `json:"parameters,omitempty"` + + // Subcommand: Airflow subcommand. + Subcommand string `json:"subcommand,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Command") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Command") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ExecuteAirflowCommandRequest) MarshalJSON() ([]byte, error) { + type NoMethod ExecuteAirflowCommandRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ExecuteAirflowCommandResponse: Response to +// ExecuteAirflowCommandRequest. +type ExecuteAirflowCommandResponse struct { + // Error: Error message. Empty if there was no error. + Error string `json:"error,omitempty"` + + // ExecutionId: The unique ID of the command execution for polling. + ExecutionId string `json:"executionId,omitempty"` + + // Pod: The name of the pod where the command is executed. + Pod string `json:"pod,omitempty"` + + // PodNamespace: The namespace of the pod where the command is executed. + PodNamespace string `json:"podNamespace,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "Error") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Error") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ExecuteAirflowCommandResponse) MarshalJSON() ([]byte, error) { + type NoMethod ExecuteAirflowCommandResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ExitInfo: Information about how a command ended. +type ExitInfo struct { + // Error: Error message. Empty if there was no error. + Error string `json:"error,omitempty"` + + // ExitCode: The exit code from the command execution. + ExitCode int64 `json:"exitCode,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Error") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Error") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ExitInfo) MarshalJSON() ([]byte, error) { + type NoMethod ExitInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// FetchDatabasePropertiesResponse: Response for +// FetchDatabasePropertiesRequest. +type FetchDatabasePropertiesResponse struct { + // IsFailoverReplicaAvailable: The availability status of the failover + // replica. A false status indicates that the failover replica is out of + // sync. The primary instance can only fail over to the failover replica + // when the status is true. + IsFailoverReplicaAvailable bool `json:"isFailoverReplicaAvailable,omitempty"` + + // PrimaryGceZone: The Compute Engine zone that the instance is + // currently serving from. + PrimaryGceZone string `json:"primaryGceZone,omitempty"` + + // SecondaryGceZone: The Compute Engine zone that the failover instance + // is currently serving from for a regional Cloud SQL instance. + SecondaryGceZone string `json:"secondaryGceZone,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. + // "IsFailoverReplicaAvailable") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. + // "IsFailoverReplicaAvailable") to include in API requests with the + // JSON null value. By default, fields with empty values are omitted + // from API requests. However, any field with an empty value appearing + // in NullFields will be sent to the server as null. It is an error if a + // field in this list has a non-empty value. This may be used to include + // null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *FetchDatabasePropertiesResponse) MarshalJSON() ([]byte, error) { + type NoMethod FetchDatabasePropertiesResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // IPAllocationPolicy: Configuration for controlling how IPs are // allocated in the GKE cluster. type IPAllocationPolicy struct { @@ -847,6 +1023,37 @@ func (s *ImageVersion) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// Line: Contains information about a single line from logs. +type Line struct { + // Content: Text content of the log line. + Content string `json:"content,omitempty"` + + // LineNumber: Number of the line. + LineNumber int64 `json:"lineNumber,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Content") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Content") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *Line) MarshalJSON() ([]byte, error) { + type NoMethod Line + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // ListEnvironmentsResponse: The environments in a project and location. type ListEnvironmentsResponse struct { // Environments: The list of environments returned by a @@ -1349,6 +1556,8 @@ type OperationMetadata struct { // "CHECK" - A resource check operation. // "SAVE_SNAPSHOT" - Saves snapshot of the resource operation. // "LOAD_SNAPSHOT" - Loads snapshot of the resource operation. + // "DATABASE_FAILOVER" - Triggers failover of environment's Cloud SQL + // instance (only for highly resilient environments). OperationType string `json:"operationType,omitempty"` // Resource: Output only. The resource being operated on, as a relative @@ -1392,6 +1601,83 @@ func (s *OperationMetadata) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// PollAirflowCommandRequest: Poll Airflow Command request. +type PollAirflowCommandRequest struct { + // ExecutionId: The unique ID of the command execution. + ExecutionId string `json:"executionId,omitempty"` + + // NextLineNumber: Line number from which new logs should be fetched. + NextLineNumber int64 `json:"nextLineNumber,omitempty"` + + // Pod: The name of the pod where the command is executed. + Pod string `json:"pod,omitempty"` + + // PodNamespace: The namespace of the pod where the command is executed. + PodNamespace string `json:"podNamespace,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExecutionId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ExecutionId") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *PollAirflowCommandRequest) MarshalJSON() ([]byte, error) { + type NoMethod PollAirflowCommandRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// PollAirflowCommandResponse: Response to PollAirflowCommandRequest. +type PollAirflowCommandResponse struct { + // ExitInfo: The result exit status of the command. + ExitInfo *ExitInfo `json:"exitInfo,omitempty"` + + // Output: Output from the command execution. It may not contain the + // full output and the caller may need to poll for more lines. + Output []*Line `json:"output,omitempty"` + + // OutputEnd: Whether the command execution has finished and there is no + // more output. + OutputEnd bool `json:"outputEnd,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "ExitInfo") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ExitInfo") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *PollAirflowCommandResponse) MarshalJSON() ([]byte, error) { + type NoMethod PollAirflowCommandResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // PrivateClusterConfig: Configuration options for the private GKE // cluster in a Cloud Composer environment. type PrivateClusterConfig struct { @@ -1869,6 +2155,80 @@ func (s *Status) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// StopAirflowCommandRequest: Stop Airflow Command request. +type StopAirflowCommandRequest struct { + // ExecutionId: The unique ID of the command execution. + ExecutionId string `json:"executionId,omitempty"` + + // Force: If true, the execution is terminated forcefully (SIGKILL). If + // false, the execution is stopped gracefully, giving it time for + // cleanup. + Force bool `json:"force,omitempty"` + + // Pod: The name of the pod where the command is executed. + Pod string `json:"pod,omitempty"` + + // PodNamespace: The namespace of the pod where the command is executed. + PodNamespace string `json:"podNamespace,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExecutionId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ExecutionId") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *StopAirflowCommandRequest) MarshalJSON() ([]byte, error) { + type NoMethod StopAirflowCommandRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// StopAirflowCommandResponse: Response to StopAirflowCommandRequest. +type StopAirflowCommandResponse struct { + // IsDone: Whether the execution is still running. + IsDone bool `json:"isDone,omitempty"` + + // Output: Output message from stopping execution request. + Output []string `json:"output,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "IsDone") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "IsDone") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *StopAirflowCommandResponse) MarshalJSON() ([]byte, error) { + type NoMethod StopAirflowCommandResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // TriggererResource: Configuration for resources used by Airflow // triggerers. type TriggererResource struct { @@ -2433,31 +2793,34 @@ func (c *ProjectsLocationsEnvironmentsCreateCall) Do(opts ...googleapi.CallOptio } -// method id "composer.projects.locations.environments.delete": +// method id "composer.projects.locations.environments.databaseFailover": -type ProjectsLocationsEnvironmentsDeleteCall struct { - s *Service - name string - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header +type ProjectsLocationsEnvironmentsDatabaseFailoverCall struct { + s *Service + environment string + databasefailoverrequest *DatabaseFailoverRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header } -// Delete: Delete an environment. +// DatabaseFailover: Triggers database failover (only for highly +// resilient environments). // -// - name: The environment to delete, in the form: +// - environment: Target environment: // "projects/{projectId}/locations/{locationId}/environments/{environme // ntId}". -func (r *ProjectsLocationsEnvironmentsService) Delete(name string) *ProjectsLocationsEnvironmentsDeleteCall { - c := &ProjectsLocationsEnvironmentsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.name = name +func (r *ProjectsLocationsEnvironmentsService) DatabaseFailover(environment string, databasefailoverrequest *DatabaseFailoverRequest) *ProjectsLocationsEnvironmentsDatabaseFailoverCall { + c := &ProjectsLocationsEnvironmentsDatabaseFailoverCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.environment = environment + c.databasefailoverrequest = databasefailoverrequest return c } // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse // for more information. -func (c *ProjectsLocationsEnvironmentsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsDeleteCall { +func (c *ProjectsLocationsEnvironmentsDatabaseFailoverCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsDatabaseFailoverCall { c.urlParams_.Set("fields", googleapi.CombineFields(s)) return c } @@ -2465,21 +2828,21 @@ func (c *ProjectsLocationsEnvironmentsDeleteCall) Fields(s ...googleapi.Field) * // Context sets the context to be used in this call's Do method. Any // pending HTTP request will be aborted if the provided context is // canceled. -func (c *ProjectsLocationsEnvironmentsDeleteCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsDeleteCall { +func (c *ProjectsLocationsEnvironmentsDatabaseFailoverCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsDatabaseFailoverCall { c.ctx_ = ctx return c } // Header returns an http.Header that can be modified by the caller to // add HTTP headers to the request. -func (c *ProjectsLocationsEnvironmentsDeleteCall) Header() http.Header { +func (c *ProjectsLocationsEnvironmentsDatabaseFailoverCall) Header() http.Header { if c.header_ == nil { c.header_ = make(http.Header) } return c.header_ } -func (c *ProjectsLocationsEnvironmentsDeleteCall) doRequest(alt string) (*http.Response, error) { +func (c *ProjectsLocationsEnvironmentsDatabaseFailoverCall) doRequest(alt string) (*http.Response, error) { reqHeaders := make(http.Header) reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) for k, v := range c.header_ { @@ -2487,29 +2850,34 @@ func (c *ProjectsLocationsEnvironmentsDeleteCall) doRequest(alt string) (*http.R } reqHeaders.Set("User-Agent", c.s.userAgent()) var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.databasefailoverrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+name}") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+environment}:databaseFailover") urls += "?" + c.urlParams_.Encode() - req, err := http.NewRequest("DELETE", urls, body) + req, err := http.NewRequest("POST", urls, body) if err != nil { return nil, err } req.Header = reqHeaders googleapi.Expand(req.URL, map[string]string{ - "name": c.name, + "environment": c.environment, }) return gensupport.SendRequest(c.ctx_, c.s.client, req) } -// Do executes the "composer.projects.locations.environments.delete" call. +// Do executes the "composer.projects.locations.environments.databaseFailover" call. // Exactly one of *Operation or error will be non-nil. Any non-2xx // status code is an error. Response headers are in either // *Operation.ServerResponse.Header or (if a response was returned at // all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified // to check whether the returned error was because // http.StatusNotModified was returned. -func (c *ProjectsLocationsEnvironmentsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error) { +func (c *ProjectsLocationsEnvironmentsDatabaseFailoverCall) Do(opts ...googleapi.CallOption) (*Operation, error) { gensupport.SetOptions(c.urlParams_, opts...) res, err := c.doRequest("json") if res != nil && res.StatusCode == http.StatusNotModified { @@ -2540,25 +2908,454 @@ func (c *ProjectsLocationsEnvironmentsDeleteCall) Do(opts ...googleapi.CallOptio } return ret, nil // { - // "description": "Delete an environment.", + // "description": "Triggers database failover (only for highly resilient environments).", + // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:databaseFailover", + // "httpMethod": "POST", + // "id": "composer.projects.locations.environments.databaseFailover", + // "parameterOrder": [ + // "environment" + // ], + // "parameters": { + // "environment": { + // "description": "Target environment: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1beta1/{+environment}:databaseFailover", + // "request": { + // "$ref": "DatabaseFailoverRequest" + // }, + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "composer.projects.locations.environments.delete": + +type ProjectsLocationsEnvironmentsDeleteCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Delete: Delete an environment. +// +// - name: The environment to delete, in the form: +// "projects/{projectId}/locations/{locationId}/environments/{environme +// ntId}". +func (r *ProjectsLocationsEnvironmentsService) Delete(name string) *ProjectsLocationsEnvironmentsDeleteCall { + c := &ProjectsLocationsEnvironmentsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsEnvironmentsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsDeleteCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsEnvironmentsDeleteCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsDeleteCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsEnvironmentsDeleteCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsEnvironmentsDeleteCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("DELETE", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "composer.projects.locations.environments.delete" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsEnvironmentsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Operation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Delete an environment.", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}", // "httpMethod": "DELETE", // "id": "composer.projects.locations.environments.delete", // "parameterOrder": [ - // "name" + // "name" + // ], + // "parameters": { + // "name": { + // "description": "The environment to delete, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1beta1/{+name}", + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "composer.projects.locations.environments.executeAirflowCommand": + +type ProjectsLocationsEnvironmentsExecuteAirflowCommandCall struct { + s *Service + environment string + executeairflowcommandrequest *ExecuteAirflowCommandRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// ExecuteAirflowCommand: Executes Airflow CLI command. +// +// - environment: The resource name of the environment in the form: +// "projects/{projectId}/locations/{locationId}/environments/{environme +// ntId}". +func (r *ProjectsLocationsEnvironmentsService) ExecuteAirflowCommand(environment string, executeairflowcommandrequest *ExecuteAirflowCommandRequest) *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall { + c := &ProjectsLocationsEnvironmentsExecuteAirflowCommandCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.environment = environment + c.executeairflowcommandrequest = executeairflowcommandrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.executeairflowcommandrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+environment}:executeAirflowCommand") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "environment": c.environment, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "composer.projects.locations.environments.executeAirflowCommand" call. +// Exactly one of *ExecuteAirflowCommandResponse or error will be +// non-nil. Any non-2xx status code is an error. Response headers are in +// either *ExecuteAirflowCommandResponse.ServerResponse.Header or (if a +// response was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsEnvironmentsExecuteAirflowCommandCall) Do(opts ...googleapi.CallOption) (*ExecuteAirflowCommandResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &ExecuteAirflowCommandResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Executes Airflow CLI command.", + // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:executeAirflowCommand", + // "httpMethod": "POST", + // "id": "composer.projects.locations.environments.executeAirflowCommand", + // "parameterOrder": [ + // "environment" + // ], + // "parameters": { + // "environment": { + // "description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\".", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1beta1/{+environment}:executeAirflowCommand", + // "request": { + // "$ref": "ExecuteAirflowCommandRequest" + // }, + // "response": { + // "$ref": "ExecuteAirflowCommandResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "composer.projects.locations.environments.fetchDatabaseProperties": + +type ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall struct { + s *Service + environment string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// FetchDatabaseProperties: Fetches database properties. +// +// - environment: The resource name of the environment, in the form: +// "projects/{projectId}/locations/{locationId}/environments/{environme +// ntId}". +func (r *ProjectsLocationsEnvironmentsService) FetchDatabaseProperties(environment string) *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall { + c := &ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.environment = environment + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) IfNoneMatch(entityTag string) *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+environment}:fetchDatabaseProperties") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "environment": c.environment, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "composer.projects.locations.environments.fetchDatabaseProperties" call. +// Exactly one of *FetchDatabasePropertiesResponse or error will be +// non-nil. Any non-2xx status code is an error. Response headers are in +// either *FetchDatabasePropertiesResponse.ServerResponse.Header or (if +// a response was returned at all) in error.(*googleapi.Error).Header. +// Use googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsEnvironmentsFetchDatabasePropertiesCall) Do(opts ...googleapi.CallOption) (*FetchDatabasePropertiesResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &FetchDatabasePropertiesResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Fetches database properties.", + // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:fetchDatabaseProperties", + // "httpMethod": "GET", + // "id": "composer.projects.locations.environments.fetchDatabaseProperties", + // "parameterOrder": [ + // "environment" // ], // "parameters": { - // "name": { - // "description": "The environment to delete, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + // "environment": { + // "description": "Required. The resource name of the environment, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", // "required": true, // "type": "string" // } // }, - // "path": "v1beta1/{+name}", + // "path": "v1beta1/{+environment}:fetchDatabaseProperties", // "response": { - // "$ref": "Operation" + // "$ref": "FetchDatabasePropertiesResponse" // }, // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform" @@ -3311,6 +4108,151 @@ func (c *ProjectsLocationsEnvironmentsPatchCall) Do(opts ...googleapi.CallOption } +// method id "composer.projects.locations.environments.pollAirflowCommand": + +type ProjectsLocationsEnvironmentsPollAirflowCommandCall struct { + s *Service + environment string + pollairflowcommandrequest *PollAirflowCommandRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// PollAirflowCommand: Polls Airflow CLI command execution and fetches +// logs. +// +// - environment: The resource name of the environment in the form: +// "projects/{projectId}/locations/{locationId}/environments/{environme +// ntId}". +func (r *ProjectsLocationsEnvironmentsService) PollAirflowCommand(environment string, pollairflowcommandrequest *PollAirflowCommandRequest) *ProjectsLocationsEnvironmentsPollAirflowCommandCall { + c := &ProjectsLocationsEnvironmentsPollAirflowCommandCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.environment = environment + c.pollairflowcommandrequest = pollairflowcommandrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsEnvironmentsPollAirflowCommandCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsPollAirflowCommandCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsEnvironmentsPollAirflowCommandCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsPollAirflowCommandCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsEnvironmentsPollAirflowCommandCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsEnvironmentsPollAirflowCommandCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.pollairflowcommandrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+environment}:pollAirflowCommand") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "environment": c.environment, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "composer.projects.locations.environments.pollAirflowCommand" call. +// Exactly one of *PollAirflowCommandResponse or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *PollAirflowCommandResponse.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsEnvironmentsPollAirflowCommandCall) Do(opts ...googleapi.CallOption) (*PollAirflowCommandResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &PollAirflowCommandResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Polls Airflow CLI command execution and fetches logs.", + // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:pollAirflowCommand", + // "httpMethod": "POST", + // "id": "composer.projects.locations.environments.pollAirflowCommand", + // "parameterOrder": [ + // "environment" + // ], + // "parameters": { + // "environment": { + // "description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1beta1/{+environment}:pollAirflowCommand", + // "request": { + // "$ref": "PollAirflowCommandRequest" + // }, + // "response": { + // "$ref": "PollAirflowCommandResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "composer.projects.locations.environments.restartWebServer": type ProjectsLocationsEnvironmentsRestartWebServerCall struct { @@ -3603,6 +4545,150 @@ func (c *ProjectsLocationsEnvironmentsSaveSnapshotCall) Do(opts ...googleapi.Cal } +// method id "composer.projects.locations.environments.stopAirflowCommand": + +type ProjectsLocationsEnvironmentsStopAirflowCommandCall struct { + s *Service + environment string + stopairflowcommandrequest *StopAirflowCommandRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// StopAirflowCommand: Stops Airflow CLI command execution. +// +// - environment: The resource name of the environment in the form: +// "projects/{projectId}/locations/{locationId}/environments/{environme +// ntId}". +func (r *ProjectsLocationsEnvironmentsService) StopAirflowCommand(environment string, stopairflowcommandrequest *StopAirflowCommandRequest) *ProjectsLocationsEnvironmentsStopAirflowCommandCall { + c := &ProjectsLocationsEnvironmentsStopAirflowCommandCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.environment = environment + c.stopairflowcommandrequest = stopairflowcommandrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsEnvironmentsStopAirflowCommandCall) Fields(s ...googleapi.Field) *ProjectsLocationsEnvironmentsStopAirflowCommandCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsEnvironmentsStopAirflowCommandCall) Context(ctx context.Context) *ProjectsLocationsEnvironmentsStopAirflowCommandCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsEnvironmentsStopAirflowCommandCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsEnvironmentsStopAirflowCommandCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.stopairflowcommandrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+environment}:stopAirflowCommand") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "environment": c.environment, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "composer.projects.locations.environments.stopAirflowCommand" call. +// Exactly one of *StopAirflowCommandResponse or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *StopAirflowCommandResponse.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsEnvironmentsStopAirflowCommandCall) Do(opts ...googleapi.CallOption) (*StopAirflowCommandResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &StopAirflowCommandResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Stops Airflow CLI command execution.", + // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:stopAirflowCommand", + // "httpMethod": "POST", + // "id": "composer.projects.locations.environments.stopAirflowCommand", + // "parameterOrder": [ + // "environment" + // ], + // "parameters": { + // "environment": { + // "description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\".", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1beta1/{+environment}:stopAirflowCommand", + // "request": { + // "$ref": "StopAirflowCommandRequest" + // }, + // "response": { + // "$ref": "StopAirflowCommandResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "composer.projects.locations.imageVersions.list": type ProjectsLocationsImageVersionsListCall struct { diff --git a/connectors/v1/connectors-api.json b/connectors/v1/connectors-api.json index 39ec11b2aea..bec7cea84ce 100644 --- a/connectors/v1/connectors-api.json +++ b/connectors/v1/connectors-api.json @@ -1444,7 +1444,7 @@ } } }, - "revision": "20230503", + "revision": "20230517", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -1782,6 +1782,25 @@ "description": "Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource.", "type": "string" }, + "connectorVersionLaunchStage": { + "description": "Output only. Flag to mark the version indicating the launch stage.", + "enum": [ + "LAUNCH_STAGE_UNSPECIFIED", + "PREVIEW", + "GA", + "DEPRECATED", + "PRIVATE_PREVIEW" + ], + "enumDescriptions": [ + "LAUNCH_STAGE_UNSPECIFIED.", + "PREVIEW.", + "GA.", + "DEPRECATED.", + "PRIVATE_PREVIEW." + ], + "readOnly": true, + "type": "string" + }, "createTime": { "description": "Output only. Created time.", "format": "google-datetime", @@ -3013,6 +3032,10 @@ "description": "Authorization code to be exchanged for access and refresh tokens.", "type": "string" }, + "authUri": { + "description": "Auth URL for Authorization Code Flow", + "type": "string" + }, "clientId": { "description": "Client ID for user-provided OAuth app.", "type": "string" @@ -3605,6 +3628,11 @@ "readOnly": true, "type": "boolean" }, + "tenantProjectId": { + "description": "Output only. Tenant project id of the consumer project.", + "readOnly": true, + "type": "string" + }, "vpcsc": { "description": "Optional. Flag indicates whether vpc-sc is enabled.", "type": "boolean" diff --git a/connectors/v1/connectors-gen.go b/connectors/v1/connectors-gen.go index 58f8db19415..e9bd58c4499 100644 --- a/connectors/v1/connectors-gen.go +++ b/connectors/v1/connectors-gen.go @@ -763,6 +763,17 @@ type Connection struct { // global location is supported for ConnectorVersion resource. ConnectorVersion string `json:"connectorVersion,omitempty"` + // ConnectorVersionLaunchStage: Output only. Flag to mark the version + // indicating the launch stage. + // + // Possible values: + // "LAUNCH_STAGE_UNSPECIFIED" - LAUNCH_STAGE_UNSPECIFIED. + // "PREVIEW" - PREVIEW. + // "GA" - GA. + // "DEPRECATED" - DEPRECATED. + // "PRIVATE_PREVIEW" - PRIVATE_PREVIEW. + ConnectorVersionLaunchStage string `json:"connectorVersionLaunchStage,omitempty"` + // CreateTime: Output only. Created time. CreateTime string `json:"createTime,omitempty"` @@ -2340,6 +2351,9 @@ type Oauth2AuthCodeFlow struct { // tokens. AuthCode string `json:"authCode,omitempty"` + // AuthUri: Auth URL for Authorization Code Flow + AuthUri string `json:"authUri,omitempty"` + // ClientId: Client ID for user-provided OAuth app. ClientId string `json:"clientId,omitempty"` @@ -3156,6 +3170,10 @@ type Settings struct { // Payg: Output only. Flag indicates if user is in PayG model Payg bool `json:"payg,omitempty"` + // TenantProjectId: Output only. Tenant project id of the consumer + // project. + TenantProjectId string `json:"tenantProjectId,omitempty"` + // Vpcsc: Optional. Flag indicates whether vpc-sc is enabled. Vpcsc bool `json:"vpcsc,omitempty"` diff --git a/dataflow/v1b3/dataflow-api.json b/dataflow/v1b3/dataflow-api.json index 013d210cfd4..134974fab23 100644 --- a/dataflow/v1b3/dataflow-api.json +++ b/dataflow/v1b3/dataflow-api.json @@ -2211,7 +2211,7 @@ } } }, - "revision": "20230506", + "revision": "20230514", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -4946,6 +4946,10 @@ "description": "Indicates whether the pipeline allows late-arriving data.", "type": "boolean" }, + "dynamicDestinations": { + "description": "If true, then this location represents dynamic topics.", + "type": "boolean" + }, "idLabel": { "description": "If set, contains a pubsub label from which to extract record ids. If left empty, record deduplication will be strictly best effort.", "type": "string" diff --git a/dataflow/v1b3/dataflow-gen.go b/dataflow/v1b3/dataflow-gen.go index 0f5cf550bf0..de9b5dfda11 100644 --- a/dataflow/v1b3/dataflow-gen.go +++ b/dataflow/v1b3/dataflow-gen.go @@ -4710,6 +4710,10 @@ type PubsubLocation struct { // data. DropLateData bool `json:"dropLateData,omitempty"` + // DynamicDestinations: If true, then this location represents dynamic + // topics. + DynamicDestinations bool `json:"dynamicDestinations,omitempty"` + // IdLabel: If set, contains a pubsub label from which to extract record // ids. If left empty, record deduplication will be strictly best // effort. diff --git a/datamigration/v1/datamigration-api.json b/datamigration/v1/datamigration-api.json index 7b5f6daab4a..d69943773c3 100644 --- a/datamigration/v1/datamigration-api.json +++ b/datamigration/v1/datamigration-api.json @@ -1918,7 +1918,7 @@ } } }, - "revision": "20230503", + "revision": "20230517", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -3834,6 +3834,10 @@ "$ref": "PrivateConnectivity", "description": "Private connectivity." }, + "ssl": { + "$ref": "SslConfig", + "description": "SSL configuration for the destination to connect to the source database. The supported configuration for Oracle SSL is of SERVER_ONLY type." + }, "staticServiceIpConnectivity": { "$ref": "StaticServiceIpConnectivity", "description": "Static Service IP connectivity." diff --git a/datamigration/v1/datamigration-gen.go b/datamigration/v1/datamigration-gen.go index ea26fc8fc36..4d863fe7deb 100644 --- a/datamigration/v1/datamigration-gen.go +++ b/datamigration/v1/datamigration-gen.go @@ -2854,6 +2854,11 @@ type OracleConnectionProfile struct { // PrivateConnectivity: Private connectivity. PrivateConnectivity *PrivateConnectivity `json:"privateConnectivity,omitempty"` + // Ssl: SSL configuration for the destination to connect to the source + // database. The supported configuration for Oracle SSL is of + // SERVER_ONLY type. + Ssl *SslConfig `json:"ssl,omitempty"` + // StaticServiceIpConnectivity: Static Service IP connectivity. StaticServiceIpConnectivity *StaticServiceIpConnectivity `json:"staticServiceIpConnectivity,omitempty"` diff --git a/dataplex/v1/dataplex-api.json b/dataplex/v1/dataplex-api.json index 617a0426870..c85b00d4bd3 100644 --- a/dataplex/v1/dataplex-api.json +++ b/dataplex/v1/dataplex-api.json @@ -4041,6 +4041,7 @@ ], "parameters": { "etag": { + "deprecated": true, "description": "Optional. The etag associated with the partition.", "location": "query", "type": "string" @@ -4263,7 +4264,7 @@ } } }, - "revision": "20230503", + "revision": "20230521", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -6589,6 +6590,19 @@ "readOnly": true, "type": "string" }, + "executionSpec": { + "$ref": "GoogleCloudDataplexV1TaskExecutionSpec", + "description": "Output only. Spec related to how a task is executed.", + "readOnly": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Output only. User-defined labels for the task.", + "readOnly": true, + "type": "object" + }, "message": { "description": "Output only. Additional information about the current state.", "readOnly": true, @@ -6652,6 +6666,21 @@ "readOnly": true, "type": "string" }, + "trigger": { + "description": "Output only. Job execution trigger.", + "enum": [ + "TRIGGER_UNSPECIFIED", + "TASK_CONFIG", + "RUN_REQUEST" + ], + "enumDescriptions": [ + "The trigger is unspecified.", + "The job was triggered by Dataplex based on trigger spec from task definition.", + "The job was triggered by the explicit call of Task API." + ], + "readOnly": true, + "type": "string" + }, "uid": { "description": "Output only. System generated globally unique ID for the job.", "readOnly": true, @@ -7317,7 +7346,22 @@ }, "GoogleCloudDataplexV1RunTaskRequest": { "id": "GoogleCloudDataplexV1RunTaskRequest", - "properties": {}, + "properties": { + "args": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Execution spec arguments. If the map is left empty, the task will run with existing execution spec args from task definition. If the map contains an entry with a new key, the same will be added to existing set of args. If the map contains an entry with an existing arg key in task definition, the task will run with new arg value for that entry. Clearing an existing arg will require arg value to be explicitly set to a hyphen \"-\". The arg value cannot be empty.", + "type": "object" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. User-defined labels for the task. If the map is left empty, the task will run with existing labels from task definition. If the map contains an entry with a new key, the same will be added to existing set of labels. If the map contains an entry with an existing label key in task definition, the task will run with new label value for that entry. Clearing an existing label will require label value to be explicitly set to a hyphen \"-\". The label value cannot be empty.", + "type": "object" + } + }, "type": "object" }, "GoogleCloudDataplexV1RunTaskResponse": { diff --git a/dataplex/v1/dataplex-gen.go b/dataplex/v1/dataplex-gen.go index 2939f955b0e..e70da80c134 100644 --- a/dataplex/v1/dataplex-gen.go +++ b/dataplex/v1/dataplex-gen.go @@ -3941,6 +3941,12 @@ type GoogleCloudDataplexV1Job struct { // EndTime: Output only. The time when the job ended. EndTime string `json:"endTime,omitempty"` + // ExecutionSpec: Output only. Spec related to how a task is executed. + ExecutionSpec *GoogleCloudDataplexV1TaskExecutionSpec `json:"executionSpec,omitempty"` + + // Labels: Output only. User-defined labels for the task. + Labels map[string]string `json:"labels,omitempty"` + // Message: Output only. Additional information about the current state. Message string `json:"message,omitempty"` @@ -3980,6 +3986,16 @@ type GoogleCloudDataplexV1Job struct { // "ABORTED" - The job was cancelled outside of Dataplex. State string `json:"state,omitempty"` + // Trigger: Output only. Job execution trigger. + // + // Possible values: + // "TRIGGER_UNSPECIFIED" - The trigger is unspecified. + // "TASK_CONFIG" - The job was triggered by Dataplex based on trigger + // spec from task definition. + // "RUN_REQUEST" - The job was triggered by the explicit call of Task + // API. + Trigger string `json:"trigger,omitempty"` + // Uid: Output only. System generated globally unique ID for the job. Uid string `json:"uid,omitempty"` @@ -5036,6 +5052,47 @@ func (s *GoogleCloudDataplexV1RunDataScanResponse) MarshalJSON() ([]byte, error) } type GoogleCloudDataplexV1RunTaskRequest struct { + // Args: Optional. Execution spec arguments. If the map is left empty, + // the task will run with existing execution spec args from task + // definition. If the map contains an entry with a new key, the same + // will be added to existing set of args. If the map contains an entry + // with an existing arg key in task definition, the task will run with + // new arg value for that entry. Clearing an existing arg will require + // arg value to be explicitly set to a hyphen "-". The arg value cannot + // be empty. + Args map[string]string `json:"args,omitempty"` + + // Labels: Optional. User-defined labels for the task. If the map is + // left empty, the task will run with existing labels from task + // definition. If the map contains an entry with a new key, the same + // will be added to existing set of labels. If the map contains an entry + // with an existing label key in task definition, the task will run with + // new label value for that entry. Clearing an existing label will + // require label value to be explicitly set to a hyphen "-". The label + // value cannot be empty. + Labels map[string]string `json:"labels,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Args") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Args") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDataplexV1RunTaskRequest) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDataplexV1RunTaskRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } type GoogleCloudDataplexV1RunTaskResponse struct { @@ -26796,6 +26853,7 @@ func (c *ProjectsLocationsLakesZonesEntitiesPartitionsDeleteCall) Do(opts ...goo // ], // "parameters": { // "etag": { + // "deprecated": true, // "description": "Optional. The etag associated with the partition.", // "location": "query", // "type": "string" diff --git a/dialogflow/v2/dialogflow-api.json b/dialogflow/v2/dialogflow-api.json index 472bbdc9371..2f940fbffac 100644 --- a/dialogflow/v2/dialogflow-api.json +++ b/dialogflow/v2/dialogflow-api.json @@ -8209,7 +8209,7 @@ } } }, - "revision": "20230508", + "revision": "20230516", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AudioInput": { @@ -12361,7 +12361,7 @@ "type": "string" }, "clicked": { - "description": "Indicates whether the answer/item was clicked by the human agent or not. Default to false. For knowledge search, the answer record is considered to be clicked if the answer was copied or any URI was clicked.", + "description": "Indicates whether the answer/item was clicked by the human agent or not. Default to false. For knowledge search and knowledge assist, the answer record is considered to be clicked if the answer was copied or any URI was clicked.", "type": "boolean" }, "correctnessLevel": { @@ -14123,7 +14123,7 @@ "id": "GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfig", "properties": { "confidenceThreshold": { - "description": "Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST.", + "description": "Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION.", "format": "float", "type": "number" }, @@ -16577,10 +16577,6 @@ "description": "The request message for Conversations.SuggestConversationSummary.", "id": "GoogleCloudDialogflowV2SuggestConversationSummaryRequest", "properties": { - "assistQueryParams": { - "$ref": "GoogleCloudDialogflowV2AssistQueryParameters", - "description": "Parameters for a human assist query." - }, "contextSize": { "description": "Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 500 and at most 1000.", "format": "int32", @@ -17196,6 +17192,7 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", + "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION" ], "enumDescriptions": [ @@ -17203,6 +17200,7 @@ "Run article suggestion model for chat.", "Run FAQ model.", "Run smart reply model for chat.", + "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat." ], "type": "string" @@ -17273,6 +17271,25 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer": { + "description": "Represents a Dialogflow assist answer.", + "id": "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer", + "properties": { + "answerRecord": { + "description": "The name of answer record, in the format of \"projects//locations//answerRecords/\"", + "type": "string" + }, + "intentSuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1IntentSuggestion", + "description": "An intent suggestion generated from conversation." + }, + "queryResult": { + "$ref": "GoogleCloudDialogflowV2beta1QueryResult", + "description": "Result from v2 agent." + } + }, + "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", @@ -18623,6 +18640,25 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1IntentSuggestion": { + "description": "Represents an intent suggestion.", + "id": "GoogleCloudDialogflowV2beta1IntentSuggestion", + "properties": { + "description": { + "description": "Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", + "type": "string" + }, + "displayName": { + "description": "The display name of the intent.", + "type": "string" + }, + "intentV2": { + "description": "The unique identifier of this intent. Format: `projects//locations//agent/intents/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1IntentTrainingPhrase": { "description": "Represents an example that the agent is trained on.", "id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase", @@ -19063,6 +19099,7 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", + "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION" ], "enumDescriptions": [ @@ -19070,6 +19107,7 @@ "Run article suggestion model for chat.", "Run FAQ model.", "Run smart reply model for chat.", + "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat." ], "type": "string" @@ -19120,6 +19158,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse": { + "description": "The response message for Participants.SuggestDialogflowAssists.", + "id": "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse", + "properties": { + "contextSize": { + "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestDialogflowAssistsRequest.context_size field in the request if there aren't that many messages in the conversation.", + "format": "int32", + "type": "integer" + }, + "dialogflowAssistAnswers": { + "description": "Output only. Multiple reply options provided by Dialogflow assist service. The order is based on the rank of the model prediction.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer" + }, + "type": "array" + }, + "latestMessage": { + "description": "The name of the latest conversation message used to suggest answer. Format: `projects//locations//conversations//messages/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse": { "description": "The request message for Participants.SuggestFaqAnswers.", "id": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse", @@ -19178,6 +19239,10 @@ "$ref": "GoogleCloudDialogflowV2beta1SuggestArticlesResponse", "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION." }, + "suggestDialogflowAssistsResponse": { + "$ref": "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse", + "description": "SuggestDialogflowAssistsResponse if request is for DIALOGFLOW_ASSIST." + }, "suggestFaqAnswersResponse": { "$ref": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse", "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER." diff --git a/dialogflow/v2/dialogflow-gen.go b/dialogflow/v2/dialogflow-gen.go index ad645c6c1b6..4168e6e3a2e 100644 --- a/dialogflow/v2/dialogflow-gen.go +++ b/dialogflow/v2/dialogflow-gen.go @@ -8474,9 +8474,9 @@ type GoogleCloudDialogflowV2AnswerFeedback struct { ClickTime string `json:"clickTime,omitempty"` // Clicked: Indicates whether the answer/item was clicked by the human - // agent or not. Default to false. For knowledge search, the answer - // record is considered to be clicked if the answer was copied or any - // URI was clicked. + // agent or not. Default to false. For knowledge search and knowledge + // assist, the answer record is considered to be clicked if the answer + // was copied or any URI was clicked. Clicked bool `json:"clicked,omitempty"` // CorrectnessLevel: The correctness level of the specific answer. @@ -11678,7 +11678,7 @@ type GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfig struc // until you have desired results. If this field is not set, it defaults // to 0.0, which means that all suggestions are returned. Supported // features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, - // KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST. + // KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` // ContextFilterSettings: Determines how recent conversation context is @@ -16188,9 +16188,6 @@ func (s *GoogleCloudDialogflowV2SuggestArticlesResponse) MarshalJSON() ([]byte, // GoogleCloudDialogflowV2SuggestConversationSummaryRequest: The request // message for Conversations.SuggestConversationSummary. type GoogleCloudDialogflowV2SuggestConversationSummaryRequest struct { - // AssistQueryParams: Parameters for a human assist query. - AssistQueryParams *GoogleCloudDialogflowV2AssistQueryParameters `json:"assistQueryParams,omitempty"` - // ContextSize: Max number of messages prior to and including // [latest_message] to use as context when compiling the suggestion. By // default 500 and at most 1000. @@ -16202,21 +16199,20 @@ type GoogleCloudDialogflowV2SuggestConversationSummaryRequest struct { // `projects//locations//conversations//messages/`. LatestMessage string `json:"latestMessage,omitempty"` - // ForceSendFields is a list of field names (e.g. "AssistQueryParams") - // to unconditionally include in API requests. By default, fields with + // ForceSendFields is a list of field names (e.g. "ContextSize") to + // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AssistQueryParams") to - // include in API requests with the JSON null value. By default, fields - // with empty values are omitted from API requests. However, any field - // with an empty value appearing in NullFields will be sent to the - // server as null. It is an error if a field in this list has a - // non-empty value. This may be used to include null fields in Patch - // requests. + // NullFields is a list of field names (e.g. "ContextSize") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` } @@ -17301,6 +17297,8 @@ type GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigOperationMetadata s // "ARTICLE_SUGGESTION" - Run article suggestion model for chat. // "FAQ" - Run FAQ model. // "SMART_REPLY" - Run smart reply model for chat. + // "DIALOGFLOW_ASSIST" - Run Dialogflow assist model for chat, which + // will return automated agent response as suggestion. // "CONVERSATION_SUMMARIZATION" - Run conversation summarization model // for chat. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` @@ -17462,6 +17460,42 @@ func (s *GoogleCloudDialogflowV2beta1ConversationEvent) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1DialogflowAssistAnswer: Represents a +// Dialogflow assist answer. +type GoogleCloudDialogflowV2beta1DialogflowAssistAnswer struct { + // AnswerRecord: The name of answer record, in the format of + // "projects//locations//answerRecords/" + AnswerRecord string `json:"answerRecord,omitempty"` + + // IntentSuggestion: An intent suggestion generated from conversation. + IntentSuggestion *GoogleCloudDialogflowV2beta1IntentSuggestion `json:"intentSuggestion,omitempty"` + + // QueryResult: Result from v2 agent. + QueryResult *GoogleCloudDialogflowV2beta1QueryResult `json:"queryResult,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AnswerRecord") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AnswerRecord") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1DialogflowAssistAnswer) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1DialogflowAssistAnswer + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1EntityType: 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 @@ -19729,6 +19763,44 @@ func (s *GoogleCloudDialogflowV2beta1IntentParameter) MarshalJSON() ([]byte, err return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1IntentSuggestion: Represents an intent +// suggestion. +type GoogleCloudDialogflowV2beta1IntentSuggestion struct { + // Description: Human readable description for better understanding an + // intent like its scope, content, result etc. Maximum character limit: + // 140 characters. + Description string `json:"description,omitempty"` + + // DisplayName: The display name of the intent. + DisplayName string `json:"displayName,omitempty"` + + // IntentV2: The unique identifier of this intent. Format: + // `projects//locations//agent/intents/`. + IntentV2 string `json:"intentV2,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Description") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Description") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1IntentSuggestion) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1IntentSuggestion + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1IntentTrainingPhrase: Represents an // example that the agent is trained on. type GoogleCloudDialogflowV2beta1IntentTrainingPhrase struct { @@ -20475,6 +20547,8 @@ type GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigOperationMetadata str // "ARTICLE_SUGGESTION" - Run article suggestion model for chat. // "FAQ" - Run FAQ model. // "SMART_REPLY" - Run smart reply model for chat. + // "DIALOGFLOW_ASSIST" - Run Dialogflow assist model for chat, which + // will return automated agent response as suggestion. // "CONVERSATION_SUMMARIZATION" - Run conversation summarization model // for chat. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` @@ -20597,6 +20671,48 @@ func (s *GoogleCloudDialogflowV2beta1SuggestArticlesResponse) MarshalJSON() ([]b return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse: The +// response message for Participants.SuggestDialogflowAssists. +type GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse struct { + // ContextSize: Number of messages prior to and including latest_message + // to compile the suggestion. It may be smaller than the + // SuggestDialogflowAssistsRequest.context_size field in the request if + // there aren't that many messages in the conversation. + ContextSize int64 `json:"contextSize,omitempty"` + + // DialogflowAssistAnswers: Output only. Multiple reply options provided + // by Dialogflow assist service. The order is based on the rank of the + // model prediction. + DialogflowAssistAnswers []*GoogleCloudDialogflowV2beta1DialogflowAssistAnswer `json:"dialogflowAssistAnswers,omitempty"` + + // LatestMessage: The name of the latest conversation message used to + // suggest answer. Format: + // `projects//locations//conversations//messages/`. + LatestMessage string `json:"latestMessage,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ContextSize") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ContextSize") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse: The request // message for Participants.SuggestFaqAnswers. type GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse struct { @@ -20692,6 +20808,10 @@ type GoogleCloudDialogflowV2beta1SuggestionResult struct { // ARTICLE_SUGGESTION. SuggestArticlesResponse *GoogleCloudDialogflowV2beta1SuggestArticlesResponse `json:"suggestArticlesResponse,omitempty"` + // SuggestDialogflowAssistsResponse: SuggestDialogflowAssistsResponse if + // request is for DIALOGFLOW_ASSIST. + SuggestDialogflowAssistsResponse *GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse `json:"suggestDialogflowAssistsResponse,omitempty"` + // SuggestFaqAnswersResponse: SuggestFaqAnswersResponse if request is // for FAQ_ANSWER. SuggestFaqAnswersResponse *GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse `json:"suggestFaqAnswersResponse,omitempty"` diff --git a/dialogflow/v2beta1/dialogflow-api.json b/dialogflow/v2beta1/dialogflow-api.json index 588f0be44ee..c64e2841b93 100644 --- a/dialogflow/v2beta1/dialogflow-api.json +++ b/dialogflow/v2beta1/dialogflow-api.json @@ -7577,7 +7577,7 @@ } } }, - "revision": "20230508", + "revision": "20230516", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AudioInput": { @@ -13738,6 +13738,11 @@ "description": "Output only. The article suggestion answer.", "readOnly": true }, + "dialogflowAssistAnswer": { + "$ref": "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer", + "description": "Output only. The Dialogflow assist answer.", + "readOnly": true + }, "faqAnswer": { "$ref": "GoogleCloudDialogflowV2beta1FaqAnswer", "description": "Output only. The FAQ answer.", @@ -13791,6 +13796,10 @@ "description": "A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided.", "type": "string" }, + "suggestionInput": { + "$ref": "GoogleCloudDialogflowV2beta1SuggestionInput", + "description": "An input representing the selection of a suggestion." + }, "textInput": { "$ref": "GoogleCloudDialogflowV2beta1TextInput", "description": "The natural language text to be processed." @@ -14321,6 +14330,7 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", + "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION" ], "enumDescriptions": [ @@ -14328,6 +14338,7 @@ "Run article suggestion model for chat.", "Run FAQ model.", "Run smart reply model for chat.", + "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat." ], "type": "string" @@ -14362,6 +14373,7 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", + "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION" ], "enumDescriptions": [ @@ -14369,6 +14381,7 @@ "Run article suggestion model for chat.", "Run FAQ model.", "Run smart reply model for chat.", + "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat." ], "type": "string" @@ -14705,6 +14718,25 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer": { + "description": "Represents a Dialogflow assist answer.", + "id": "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer", + "properties": { + "answerRecord": { + "description": "The name of answer record, in the format of \"projects//locations//answerRecords/\"", + "type": "string" + }, + "intentSuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1IntentSuggestion", + "description": "An intent suggestion generated from conversation." + }, + "queryResult": { + "$ref": "GoogleCloudDialogflowV2beta1QueryResult", + "description": "Result from v2 agent." + } + }, + "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", @@ -15412,7 +15444,7 @@ "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfig", "properties": { "confidenceThreshold": { - "description": "Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST.", + "description": "Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION.", "format": "float", "type": "number" }, @@ -15466,6 +15498,21 @@ "agent": { "description": "Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project.", "type": "string" + }, + "humanAgentSideConfig": { + "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySourceHumanAgentSideConfig", + "description": "The Dialogflow assist configuration for human agent." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySourceHumanAgentSideConfig": { + "description": "The configuration used for human agent side Dialogflow assist suggestion.", + "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySourceHumanAgentSideConfig", + "properties": { + "agent": { + "description": "Optional. The name of a dialogflow virtual agent used for intent detection and suggestion triggered by human agent. Format: `projects//locations//agent`.", + "type": "string" } }, "type": "object" @@ -15951,6 +15998,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1IntentInput": { + "description": "Represents the intent to trigger programmatically rather than as a result of natural language processing. The intent input is only used for V3 agent.", + "id": "GoogleCloudDialogflowV2beta1IntentInput", + "properties": { + "intent": { + "description": "Required. The unique identifier of the intent in V3 agent. Format: `projects//locations//locations//agents//intents/`.", + "type": "string" + }, + "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.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1IntentMessage": { "description": "Corresponds to the `Response` field in the Dialogflow console.", "id": "GoogleCloudDialogflowV2beta1IntentMessage", @@ -16928,6 +16990,25 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1IntentSuggestion": { + "description": "Represents an intent suggestion.", + "id": "GoogleCloudDialogflowV2beta1IntentSuggestion", + "properties": { + "description": { + "description": "Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", + "type": "string" + }, + "displayName": { + "description": "The display name of the intent.", + "type": "string" + }, + "intentV2": { + "description": "The unique identifier of this intent. Format: `projects//locations//agent/intents/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1IntentTrainingPhrase": { "description": "Represents an example that the agent is trained on.", "id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase", @@ -18033,6 +18114,7 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", + "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION" ], "enumDescriptions": [ @@ -18040,6 +18122,7 @@ "Run article suggestion model for chat.", "Run FAQ model.", "Run smart reply model for chat.", + "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat." ], "type": "string" @@ -18202,10 +18285,6 @@ "description": "The request message for Conversations.SuggestConversationSummary.", "id": "GoogleCloudDialogflowV2beta1SuggestConversationSummaryRequest", "properties": { - "assistQueryParams": { - "$ref": "GoogleCloudDialogflowV2beta1AssistQueryParameters", - "description": "Parameters for a human assist query." - }, "contextSize": { "description": "Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 500 and at most 1000.", "format": "int32", @@ -18260,6 +18339,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse": { + "description": "The response message for Participants.SuggestDialogflowAssists.", + "id": "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse", + "properties": { + "contextSize": { + "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestDialogflowAssistsRequest.context_size field in the request if there aren't that many messages in the conversation.", + "format": "int32", + "type": "integer" + }, + "dialogflowAssistAnswers": { + "description": "Output only. Multiple reply options provided by Dialogflow assist service. The order is based on the rank of the model prediction.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer" + }, + "type": "array" + }, + "latestMessage": { + "description": "The name of the latest conversation message used to suggest answer. Format: `projects//locations//conversations//messages/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1SuggestFaqAnswersRequest": { "description": "The request message for Participants.SuggestFaqAnswers.", "id": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersRequest", @@ -18459,6 +18561,7 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", + "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION" ], "enumDescriptions": [ @@ -18466,6 +18569,7 @@ "Run article suggestion model for chat.", "Run FAQ model.", "Run smart reply model for chat.", + "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat." ], "type": "string" @@ -18473,6 +18577,33 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1SuggestionInput": { + "description": "Represents the selection of a suggestion.", + "id": "GoogleCloudDialogflowV2beta1SuggestionInput", + "properties": { + "answerRecord": { + "description": "Required. The ID of a suggestion selected by the human agent. The suggestion(s) were generated in a previous call to request Dialogflow assist. The format is: `projects//locations//answerRecords/` where is an alphanumeric string.", + "type": "string" + }, + "intentInput": { + "$ref": "GoogleCloudDialogflowV2beta1IntentInput", + "description": "The intent to be triggered on V3 agent." + }, + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "In Dialogflow assist for v3, the user can submit a form by sending a SuggestionInput. The form is uniquely determined by the answer_record field, which identifies a v3 QueryResult containing the current page. The form parameters are specified via the parameters field. 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" + }, + "textOverride": { + "$ref": "GoogleCloudDialogflowV2beta1TextInput", + "description": "Optional. If the customer edited the suggestion before using it, include the revised text here." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1SuggestionResult": { "description": "One response of different type of suggestion response which is used in the response of Participants.AnalyzeContent and Participants.AnalyzeContent, as well as HumanAgentAssistantEvent.", "id": "GoogleCloudDialogflowV2beta1SuggestionResult", @@ -18485,6 +18616,10 @@ "$ref": "GoogleCloudDialogflowV2beta1SuggestArticlesResponse", "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION." }, + "suggestDialogflowAssistsResponse": { + "$ref": "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse", + "description": "SuggestDialogflowAssistsResponse if request is for DIALOGFLOW_ASSIST." + }, "suggestFaqAnswersResponse": { "$ref": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse", "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER." diff --git a/dialogflow/v2beta1/dialogflow-gen.go b/dialogflow/v2beta1/dialogflow-gen.go index 43129ea041b..509836f46ad 100644 --- a/dialogflow/v2beta1/dialogflow-gen.go +++ b/dialogflow/v2beta1/dialogflow-gen.go @@ -11749,6 +11749,9 @@ type GoogleCloudDialogflowV2beta1AgentAssistantRecord struct { // ArticleSuggestionAnswer: Output only. The article suggestion answer. ArticleSuggestionAnswer *GoogleCloudDialogflowV2beta1ArticleAnswer `json:"articleSuggestionAnswer,omitempty"` + // DialogflowAssistAnswer: Output only. The Dialogflow assist answer. + DialogflowAssistAnswer *GoogleCloudDialogflowV2beta1DialogflowAssistAnswer `json:"dialogflowAssistAnswer,omitempty"` + // FaqAnswer: Output only. The FAQ answer. FaqAnswer *GoogleCloudDialogflowV2beta1FaqAnswer `json:"faqAnswer,omitempty"` @@ -11834,6 +11837,9 @@ type GoogleCloudDialogflowV2beta1AnalyzeContentRequest struct { // idempotent if a `request_id` is provided. RequestId string `json:"requestId,omitempty"` + // SuggestionInput: An input representing the selection of a suggestion. + SuggestionInput *GoogleCloudDialogflowV2beta1SuggestionInput `json:"suggestionInput,omitempty"` + // TextInput: The natural language text to be processed. TextInput *GoogleCloudDialogflowV2beta1TextInput `json:"textInput,omitempty"` @@ -12839,6 +12845,8 @@ type GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigOperationMetadata s // "ARTICLE_SUGGESTION" - Run article suggestion model for chat. // "FAQ" - Run FAQ model. // "SMART_REPLY" - Run smart reply model for chat. + // "DIALOGFLOW_ASSIST" - Run Dialogflow assist model for chat, which + // will return automated agent response as suggestion. // "CONVERSATION_SUMMARIZATION" - Run conversation summarization model // for chat. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` @@ -12890,6 +12898,8 @@ type GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigRequest struct { // "ARTICLE_SUGGESTION" - Run article suggestion model for chat. // "FAQ" - Run FAQ model. // "SMART_REPLY" - Run smart reply model for chat. + // "DIALOGFLOW_ASSIST" - Run Dialogflow assist model for chat, which + // will return automated agent response as suggestion. // "CONVERSATION_SUMMARIZATION" - Run conversation summarization model // for chat. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` @@ -13506,6 +13516,42 @@ func (s *GoogleCloudDialogflowV2beta1DetectIntentResponse) MarshalJSON() ([]byte return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1DialogflowAssistAnswer: Represents a +// Dialogflow assist answer. +type GoogleCloudDialogflowV2beta1DialogflowAssistAnswer struct { + // AnswerRecord: The name of answer record, in the format of + // "projects//locations//answerRecords/" + AnswerRecord string `json:"answerRecord,omitempty"` + + // IntentSuggestion: An intent suggestion generated from conversation. + IntentSuggestion *GoogleCloudDialogflowV2beta1IntentSuggestion `json:"intentSuggestion,omitempty"` + + // QueryResult: Result from v2 agent. + QueryResult *GoogleCloudDialogflowV2beta1QueryResult `json:"queryResult,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AnswerRecord") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AnswerRecord") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1DialogflowAssistAnswer) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1DialogflowAssistAnswer + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1Document: 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). @@ -14894,7 +14940,7 @@ type GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfig // until you have desired results. If this field is not set, it is // default to 0.0, which means that all suggestions are returned. // Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, - // SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST. + // SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` // ContextFilterSettings: Determines how recent conversation context is @@ -15007,6 +15053,10 @@ type GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigD // same Dialogflow project. Agent string `json:"agent,omitempty"` + // HumanAgentSideConfig: The Dialogflow assist configuration for human + // agent. + HumanAgentSideConfig *GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySourceHumanAgentSideConfig `json:"humanAgentSideConfig,omitempty"` + // ForceSendFields is a list of field names (e.g. "Agent") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -15030,6 +15080,38 @@ func (s *GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryCon return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryCo +// nfigDialogflowQuerySourceHumanAgentSideConfig: The configuration used +// for human agent side Dialogflow assist suggestion. +type GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySourceHumanAgentSideConfig struct { + // Agent: Optional. The name of a dialogflow virtual agent used for + // intent detection and suggestion triggered by human agent. Format: + // `projects//locations//agent`. + Agent string `json:"agent,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Agent") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Agent") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySourceHumanAgentSideConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySourceHumanAgentSideConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryCo // nfigDocumentQuerySource: Document source settings. Supported // features: SMART_REPLY, SMART_COMPOSE. @@ -15850,6 +15932,43 @@ func (s *GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo) MarshalJSON() ([] return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1IntentInput: Represents the intent to +// trigger programmatically rather than as a result of natural language +// processing. The intent input is only used for V3 agent. +type GoogleCloudDialogflowV2beta1IntentInput struct { + // Intent: Required. The unique identifier of the intent in V3 agent. + // Format: `projects//locations//locations//agents//intents/`. + Intent string `json:"intent,omitempty"` + + // LanguageCode: 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. + LanguageCode string `json:"languageCode,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Intent") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Intent") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1IntentInput) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1IntentInput + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1IntentMessage: Corresponds to the // `Response` field in the Dialogflow console. type GoogleCloudDialogflowV2beta1IntentMessage struct { @@ -17506,6 +17625,44 @@ func (s *GoogleCloudDialogflowV2beta1IntentParameter) MarshalJSON() ([]byte, err return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1IntentSuggestion: Represents an intent +// suggestion. +type GoogleCloudDialogflowV2beta1IntentSuggestion struct { + // Description: Human readable description for better understanding an + // intent like its scope, content, result etc. Maximum character limit: + // 140 characters. + Description string `json:"description,omitempty"` + + // DisplayName: The display name of the intent. + DisplayName string `json:"displayName,omitempty"` + + // IntentV2: The unique identifier of this intent. Format: + // `projects//locations//agent/intents/`. + IntentV2 string `json:"intentV2,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Description") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Description") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1IntentSuggestion) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1IntentSuggestion + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1IntentTrainingPhrase: Represents an // example that the agent is trained on. type GoogleCloudDialogflowV2beta1IntentTrainingPhrase struct { @@ -19595,6 +19752,8 @@ type GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigOperationMetadata str // "ARTICLE_SUGGESTION" - Run article suggestion model for chat. // "FAQ" - Run FAQ model. // "SMART_REPLY" - Run smart reply model for chat. + // "DIALOGFLOW_ASSIST" - Run Dialogflow assist model for chat, which + // will return automated agent response as suggestion. // "CONVERSATION_SUMMARIZATION" - Run conversation summarization model // for chat. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` @@ -19965,9 +20124,6 @@ func (s *GoogleCloudDialogflowV2beta1SuggestArticlesResponse) MarshalJSON() ([]b // GoogleCloudDialogflowV2beta1SuggestConversationSummaryRequest: The // request message for Conversations.SuggestConversationSummary. type GoogleCloudDialogflowV2beta1SuggestConversationSummaryRequest struct { - // AssistQueryParams: Parameters for a human assist query. - AssistQueryParams *GoogleCloudDialogflowV2beta1AssistQueryParameters `json:"assistQueryParams,omitempty"` - // ContextSize: Max number of messages prior to and including // [latest_message] to use as context when compiling the suggestion. By // default 500 and at most 1000. @@ -19979,21 +20135,20 @@ type GoogleCloudDialogflowV2beta1SuggestConversationSummaryRequest struct { // `projects//locations//conversations//messages/`. LatestMessage string `json:"latestMessage,omitempty"` - // ForceSendFields is a list of field names (e.g. "AssistQueryParams") - // to unconditionally include in API requests. By default, fields with + // ForceSendFields is a list of field names (e.g. "ContextSize") to + // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AssistQueryParams") to - // include in API requests with the JSON null value. By default, fields - // with empty values are omitted from API requests. However, any field - // with an empty value appearing in NullFields will be sent to the - // server as null. It is an error if a field in this list has a - // non-empty value. This may be used to include null fields in Patch - // requests. + // NullFields is a list of field names (e.g. "ContextSize") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` } @@ -20086,6 +20241,48 @@ func (s *GoogleCloudDialogflowV2beta1SuggestConversationSummaryResponseSummary) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse: The +// response message for Participants.SuggestDialogflowAssists. +type GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse struct { + // ContextSize: Number of messages prior to and including latest_message + // to compile the suggestion. It may be smaller than the + // SuggestDialogflowAssistsRequest.context_size field in the request if + // there aren't that many messages in the conversation. + ContextSize int64 `json:"contextSize,omitempty"` + + // DialogflowAssistAnswers: Output only. Multiple reply options provided + // by Dialogflow assist service. The order is based on the rank of the + // model prediction. + DialogflowAssistAnswers []*GoogleCloudDialogflowV2beta1DialogflowAssistAnswer `json:"dialogflowAssistAnswers,omitempty"` + + // LatestMessage: The name of the latest conversation message used to + // suggest answer. Format: + // `projects//locations//conversations//messages/`. + LatestMessage string `json:"latestMessage,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ContextSize") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ContextSize") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1SuggestFaqAnswersRequest: The request // message for Participants.SuggestFaqAnswers. type GoogleCloudDialogflowV2beta1SuggestFaqAnswersRequest struct { @@ -20425,6 +20622,8 @@ type GoogleCloudDialogflowV2beta1SuggestionFeature struct { // "ARTICLE_SUGGESTION" - Run article suggestion model for chat. // "FAQ" - Run FAQ model. // "SMART_REPLY" - Run smart reply model for chat. + // "DIALOGFLOW_ASSIST" - Run Dialogflow assist model for chat, which + // will return automated agent response as suggestion. // "CONVERSATION_SUMMARIZATION" - Run conversation summarization model // for chat. Type string `json:"type,omitempty"` @@ -20452,6 +20651,61 @@ func (s *GoogleCloudDialogflowV2beta1SuggestionFeature) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1SuggestionInput: Represents the selection +// of a suggestion. +type GoogleCloudDialogflowV2beta1SuggestionInput struct { + // AnswerRecord: Required. The ID of a suggestion selected by the human + // agent. The suggestion(s) were generated in a previous call to request + // Dialogflow assist. The format is: + // `projects//locations//answerRecords/` where is an alphanumeric + // string. + AnswerRecord string `json:"answerRecord,omitempty"` + + // IntentInput: The intent to be triggered on V3 agent. + IntentInput *GoogleCloudDialogflowV2beta1IntentInput `json:"intentInput,omitempty"` + + // Parameters: In Dialogflow assist for v3, the user can submit a form + // by sending a SuggestionInput. The form is uniquely determined by the + // answer_record field, which identifies a v3 QueryResult containing the + // current page. The form parameters are specified via the parameters + // field. 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 + Parameters googleapi.RawMessage `json:"parameters,omitempty"` + + // TextOverride: Optional. If the customer edited the suggestion before + // using it, include the revised text here. + TextOverride *GoogleCloudDialogflowV2beta1TextInput `json:"textOverride,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AnswerRecord") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AnswerRecord") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1SuggestionInput) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1SuggestionInput + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1SuggestionResult: One response of // different type of suggestion response which is used in the response // of Participants.AnalyzeContent and Participants.AnalyzeContent, as @@ -20464,6 +20718,10 @@ type GoogleCloudDialogflowV2beta1SuggestionResult struct { // ARTICLE_SUGGESTION. SuggestArticlesResponse *GoogleCloudDialogflowV2beta1SuggestArticlesResponse `json:"suggestArticlesResponse,omitempty"` + // SuggestDialogflowAssistsResponse: SuggestDialogflowAssistsResponse if + // request is for DIALOGFLOW_ASSIST. + SuggestDialogflowAssistsResponse *GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse `json:"suggestDialogflowAssistsResponse,omitempty"` + // SuggestFaqAnswersResponse: SuggestFaqAnswersResponse if request is // for FAQ_ANSWER. SuggestFaqAnswersResponse *GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse `json:"suggestFaqAnswersResponse,omitempty"` diff --git a/dialogflow/v3/dialogflow-api.json b/dialogflow/v3/dialogflow-api.json index 7ad0f8d04b2..f5a244400c9 100644 --- a/dialogflow/v3/dialogflow-api.json +++ b/dialogflow/v3/dialogflow-api.json @@ -3820,7 +3820,7 @@ } } }, - "revision": "20230508", + "revision": "20230516", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -12317,6 +12317,7 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", + "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION" ], "enumDescriptions": [ @@ -12324,6 +12325,7 @@ "Run article suggestion model for chat.", "Run FAQ model.", "Run smart reply model for chat.", + "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat." ], "type": "string" @@ -12394,6 +12396,25 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer": { + "description": "Represents a Dialogflow assist answer.", + "id": "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer", + "properties": { + "answerRecord": { + "description": "The name of answer record, in the format of \"projects//locations//answerRecords/\"", + "type": "string" + }, + "intentSuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1IntentSuggestion", + "description": "An intent suggestion generated from conversation." + }, + "queryResult": { + "$ref": "GoogleCloudDialogflowV2beta1QueryResult", + "description": "Result from v2 agent." + } + }, + "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", @@ -13744,6 +13765,25 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1IntentSuggestion": { + "description": "Represents an intent suggestion.", + "id": "GoogleCloudDialogflowV2beta1IntentSuggestion", + "properties": { + "description": { + "description": "Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", + "type": "string" + }, + "displayName": { + "description": "The display name of the intent.", + "type": "string" + }, + "intentV2": { + "description": "The unique identifier of this intent. Format: `projects//locations//agent/intents/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1IntentTrainingPhrase": { "description": "Represents an example that the agent is trained on.", "id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase", @@ -14184,6 +14224,7 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", + "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION" ], "enumDescriptions": [ @@ -14191,6 +14232,7 @@ "Run article suggestion model for chat.", "Run FAQ model.", "Run smart reply model for chat.", + "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat." ], "type": "string" @@ -14241,6 +14283,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse": { + "description": "The response message for Participants.SuggestDialogflowAssists.", + "id": "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse", + "properties": { + "contextSize": { + "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestDialogflowAssistsRequest.context_size field in the request if there aren't that many messages in the conversation.", + "format": "int32", + "type": "integer" + }, + "dialogflowAssistAnswers": { + "description": "Output only. Multiple reply options provided by Dialogflow assist service. The order is based on the rank of the model prediction.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer" + }, + "type": "array" + }, + "latestMessage": { + "description": "The name of the latest conversation message used to suggest answer. Format: `projects//locations//conversations//messages/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse": { "description": "The request message for Participants.SuggestFaqAnswers.", "id": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse", @@ -14299,6 +14364,10 @@ "$ref": "GoogleCloudDialogflowV2beta1SuggestArticlesResponse", "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION." }, + "suggestDialogflowAssistsResponse": { + "$ref": "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse", + "description": "SuggestDialogflowAssistsResponse if request is for DIALOGFLOW_ASSIST." + }, "suggestFaqAnswersResponse": { "$ref": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse", "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER." diff --git a/dialogflow/v3/dialogflow-gen.go b/dialogflow/v3/dialogflow-gen.go index a2da72a1de3..926ecf36959 100644 --- a/dialogflow/v3/dialogflow-gen.go +++ b/dialogflow/v3/dialogflow-gen.go @@ -15789,6 +15789,8 @@ type GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigOperationMetadata s // "ARTICLE_SUGGESTION" - Run article suggestion model for chat. // "FAQ" - Run FAQ model. // "SMART_REPLY" - Run smart reply model for chat. + // "DIALOGFLOW_ASSIST" - Run Dialogflow assist model for chat, which + // will return automated agent response as suggestion. // "CONVERSATION_SUMMARIZATION" - Run conversation summarization model // for chat. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` @@ -15950,6 +15952,42 @@ func (s *GoogleCloudDialogflowV2beta1ConversationEvent) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1DialogflowAssistAnswer: Represents a +// Dialogflow assist answer. +type GoogleCloudDialogflowV2beta1DialogflowAssistAnswer struct { + // AnswerRecord: The name of answer record, in the format of + // "projects//locations//answerRecords/" + AnswerRecord string `json:"answerRecord,omitempty"` + + // IntentSuggestion: An intent suggestion generated from conversation. + IntentSuggestion *GoogleCloudDialogflowV2beta1IntentSuggestion `json:"intentSuggestion,omitempty"` + + // QueryResult: Result from v2 agent. + QueryResult *GoogleCloudDialogflowV2beta1QueryResult `json:"queryResult,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AnswerRecord") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AnswerRecord") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1DialogflowAssistAnswer) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1DialogflowAssistAnswer + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1EntityType: 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 @@ -18217,6 +18255,44 @@ func (s *GoogleCloudDialogflowV2beta1IntentParameter) MarshalJSON() ([]byte, err return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1IntentSuggestion: Represents an intent +// suggestion. +type GoogleCloudDialogflowV2beta1IntentSuggestion struct { + // Description: Human readable description for better understanding an + // intent like its scope, content, result etc. Maximum character limit: + // 140 characters. + Description string `json:"description,omitempty"` + + // DisplayName: The display name of the intent. + DisplayName string `json:"displayName,omitempty"` + + // IntentV2: The unique identifier of this intent. Format: + // `projects//locations//agent/intents/`. + IntentV2 string `json:"intentV2,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Description") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Description") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1IntentSuggestion) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1IntentSuggestion + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1IntentTrainingPhrase: Represents an // example that the agent is trained on. type GoogleCloudDialogflowV2beta1IntentTrainingPhrase struct { @@ -18963,6 +19039,8 @@ type GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigOperationMetadata str // "ARTICLE_SUGGESTION" - Run article suggestion model for chat. // "FAQ" - Run FAQ model. // "SMART_REPLY" - Run smart reply model for chat. + // "DIALOGFLOW_ASSIST" - Run Dialogflow assist model for chat, which + // will return automated agent response as suggestion. // "CONVERSATION_SUMMARIZATION" - Run conversation summarization model // for chat. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` @@ -19085,6 +19163,48 @@ func (s *GoogleCloudDialogflowV2beta1SuggestArticlesResponse) MarshalJSON() ([]b return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse: The +// response message for Participants.SuggestDialogflowAssists. +type GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse struct { + // ContextSize: Number of messages prior to and including latest_message + // to compile the suggestion. It may be smaller than the + // SuggestDialogflowAssistsRequest.context_size field in the request if + // there aren't that many messages in the conversation. + ContextSize int64 `json:"contextSize,omitempty"` + + // DialogflowAssistAnswers: Output only. Multiple reply options provided + // by Dialogflow assist service. The order is based on the rank of the + // model prediction. + DialogflowAssistAnswers []*GoogleCloudDialogflowV2beta1DialogflowAssistAnswer `json:"dialogflowAssistAnswers,omitempty"` + + // LatestMessage: The name of the latest conversation message used to + // suggest answer. Format: + // `projects//locations//conversations//messages/`. + LatestMessage string `json:"latestMessage,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ContextSize") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ContextSize") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse: The request // message for Participants.SuggestFaqAnswers. type GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse struct { @@ -19180,6 +19300,10 @@ type GoogleCloudDialogflowV2beta1SuggestionResult struct { // ARTICLE_SUGGESTION. SuggestArticlesResponse *GoogleCloudDialogflowV2beta1SuggestArticlesResponse `json:"suggestArticlesResponse,omitempty"` + // SuggestDialogflowAssistsResponse: SuggestDialogflowAssistsResponse if + // request is for DIALOGFLOW_ASSIST. + SuggestDialogflowAssistsResponse *GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse `json:"suggestDialogflowAssistsResponse,omitempty"` + // SuggestFaqAnswersResponse: SuggestFaqAnswersResponse if request is // for FAQ_ANSWER. SuggestFaqAnswersResponse *GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse `json:"suggestFaqAnswersResponse,omitempty"` diff --git a/dialogflow/v3beta1/dialogflow-api.json b/dialogflow/v3beta1/dialogflow-api.json index f68b76f79cc..41820e20977 100644 --- a/dialogflow/v3beta1/dialogflow-api.json +++ b/dialogflow/v3beta1/dialogflow-api.json @@ -3820,7 +3820,7 @@ } } }, - "revision": "20230508", + "revision": "20230516", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AudioInput": { @@ -12317,6 +12317,7 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", + "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION" ], "enumDescriptions": [ @@ -12324,6 +12325,7 @@ "Run article suggestion model for chat.", "Run FAQ model.", "Run smart reply model for chat.", + "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat." ], "type": "string" @@ -12394,6 +12396,25 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer": { + "description": "Represents a Dialogflow assist answer.", + "id": "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer", + "properties": { + "answerRecord": { + "description": "The name of answer record, in the format of \"projects//locations//answerRecords/\"", + "type": "string" + }, + "intentSuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1IntentSuggestion", + "description": "An intent suggestion generated from conversation." + }, + "queryResult": { + "$ref": "GoogleCloudDialogflowV2beta1QueryResult", + "description": "Result from v2 agent." + } + }, + "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", @@ -13744,6 +13765,25 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1IntentSuggestion": { + "description": "Represents an intent suggestion.", + "id": "GoogleCloudDialogflowV2beta1IntentSuggestion", + "properties": { + "description": { + "description": "Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", + "type": "string" + }, + "displayName": { + "description": "The display name of the intent.", + "type": "string" + }, + "intentV2": { + "description": "The unique identifier of this intent. Format: `projects//locations//agent/intents/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1IntentTrainingPhrase": { "description": "Represents an example that the agent is trained on.", "id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase", @@ -14184,6 +14224,7 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", + "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION" ], "enumDescriptions": [ @@ -14191,6 +14232,7 @@ "Run article suggestion model for chat.", "Run FAQ model.", "Run smart reply model for chat.", + "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat." ], "type": "string" @@ -14241,6 +14283,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse": { + "description": "The response message for Participants.SuggestDialogflowAssists.", + "id": "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse", + "properties": { + "contextSize": { + "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestDialogflowAssistsRequest.context_size field in the request if there aren't that many messages in the conversation.", + "format": "int32", + "type": "integer" + }, + "dialogflowAssistAnswers": { + "description": "Output only. Multiple reply options provided by Dialogflow assist service. The order is based on the rank of the model prediction.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer" + }, + "type": "array" + }, + "latestMessage": { + "description": "The name of the latest conversation message used to suggest answer. Format: `projects//locations//conversations//messages/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse": { "description": "The request message for Participants.SuggestFaqAnswers.", "id": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse", @@ -14299,6 +14364,10 @@ "$ref": "GoogleCloudDialogflowV2beta1SuggestArticlesResponse", "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION." }, + "suggestDialogflowAssistsResponse": { + "$ref": "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse", + "description": "SuggestDialogflowAssistsResponse if request is for DIALOGFLOW_ASSIST." + }, "suggestFaqAnswersResponse": { "$ref": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse", "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER." diff --git a/dialogflow/v3beta1/dialogflow-gen.go b/dialogflow/v3beta1/dialogflow-gen.go index 76d62289ef9..3e526843c6c 100644 --- a/dialogflow/v3beta1/dialogflow-gen.go +++ b/dialogflow/v3beta1/dialogflow-gen.go @@ -15796,6 +15796,8 @@ type GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigOperationMetadata s // "ARTICLE_SUGGESTION" - Run article suggestion model for chat. // "FAQ" - Run FAQ model. // "SMART_REPLY" - Run smart reply model for chat. + // "DIALOGFLOW_ASSIST" - Run Dialogflow assist model for chat, which + // will return automated agent response as suggestion. // "CONVERSATION_SUMMARIZATION" - Run conversation summarization model // for chat. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` @@ -15957,6 +15959,42 @@ func (s *GoogleCloudDialogflowV2beta1ConversationEvent) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1DialogflowAssistAnswer: Represents a +// Dialogflow assist answer. +type GoogleCloudDialogflowV2beta1DialogflowAssistAnswer struct { + // AnswerRecord: The name of answer record, in the format of + // "projects//locations//answerRecords/" + AnswerRecord string `json:"answerRecord,omitempty"` + + // IntentSuggestion: An intent suggestion generated from conversation. + IntentSuggestion *GoogleCloudDialogflowV2beta1IntentSuggestion `json:"intentSuggestion,omitempty"` + + // QueryResult: Result from v2 agent. + QueryResult *GoogleCloudDialogflowV2beta1QueryResult `json:"queryResult,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AnswerRecord") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AnswerRecord") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1DialogflowAssistAnswer) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1DialogflowAssistAnswer + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1EntityType: 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 @@ -18224,6 +18262,44 @@ func (s *GoogleCloudDialogflowV2beta1IntentParameter) MarshalJSON() ([]byte, err return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1IntentSuggestion: Represents an intent +// suggestion. +type GoogleCloudDialogflowV2beta1IntentSuggestion struct { + // Description: Human readable description for better understanding an + // intent like its scope, content, result etc. Maximum character limit: + // 140 characters. + Description string `json:"description,omitempty"` + + // DisplayName: The display name of the intent. + DisplayName string `json:"displayName,omitempty"` + + // IntentV2: The unique identifier of this intent. Format: + // `projects//locations//agent/intents/`. + IntentV2 string `json:"intentV2,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Description") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Description") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1IntentSuggestion) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1IntentSuggestion + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1IntentTrainingPhrase: Represents an // example that the agent is trained on. type GoogleCloudDialogflowV2beta1IntentTrainingPhrase struct { @@ -18970,6 +19046,8 @@ type GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigOperationMetadata str // "ARTICLE_SUGGESTION" - Run article suggestion model for chat. // "FAQ" - Run FAQ model. // "SMART_REPLY" - Run smart reply model for chat. + // "DIALOGFLOW_ASSIST" - Run Dialogflow assist model for chat, which + // will return automated agent response as suggestion. // "CONVERSATION_SUMMARIZATION" - Run conversation summarization model // for chat. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` @@ -19092,6 +19170,48 @@ func (s *GoogleCloudDialogflowV2beta1SuggestArticlesResponse) MarshalJSON() ([]b return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse: The +// response message for Participants.SuggestDialogflowAssists. +type GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse struct { + // ContextSize: Number of messages prior to and including latest_message + // to compile the suggestion. It may be smaller than the + // SuggestDialogflowAssistsRequest.context_size field in the request if + // there aren't that many messages in the conversation. + ContextSize int64 `json:"contextSize,omitempty"` + + // DialogflowAssistAnswers: Output only. Multiple reply options provided + // by Dialogflow assist service. The order is based on the rank of the + // model prediction. + DialogflowAssistAnswers []*GoogleCloudDialogflowV2beta1DialogflowAssistAnswer `json:"dialogflowAssistAnswers,omitempty"` + + // LatestMessage: The name of the latest conversation message used to + // suggest answer. Format: + // `projects//locations//conversations//messages/`. + LatestMessage string `json:"latestMessage,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ContextSize") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ContextSize") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse: The request // message for Participants.SuggestFaqAnswers. type GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse struct { @@ -19187,6 +19307,10 @@ type GoogleCloudDialogflowV2beta1SuggestionResult struct { // ARTICLE_SUGGESTION. SuggestArticlesResponse *GoogleCloudDialogflowV2beta1SuggestArticlesResponse `json:"suggestArticlesResponse,omitempty"` + // SuggestDialogflowAssistsResponse: SuggestDialogflowAssistsResponse if + // request is for DIALOGFLOW_ASSIST. + SuggestDialogflowAssistsResponse *GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse `json:"suggestDialogflowAssistsResponse,omitempty"` + // SuggestFaqAnswersResponse: SuggestFaqAnswersResponse if request is // for FAQ_ANSWER. SuggestFaqAnswersResponse *GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse `json:"suggestFaqAnswersResponse,omitempty"` diff --git a/displayvideo/v1/displayvideo-api.json b/displayvideo/v1/displayvideo-api.json index a326fa9692e..2967601b3bc 100644 --- a/displayvideo/v1/displayvideo-api.json +++ b/displayvideo/v1/displayvideo-api.json @@ -3520,7 +3520,7 @@ "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. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + "description": "Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", "flatPath": "v1/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}:activate", "httpMethod": "POST", "id": "displayvideo.advertisers.manualTriggers.activate", @@ -3558,7 +3558,7 @@ ] }, "create": { - "description": "Creates a new manual trigger. Returns the newly created manual trigger if successful. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + "description": "Creates a new manual trigger. Returns the newly created manual trigger if successful. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", "flatPath": "v1/advertisers/{advertisersId}/manualTriggers", "httpMethod": "POST", "id": "displayvideo.advertisers.manualTriggers.create", @@ -3587,7 +3587,7 @@ ] }, "deactivate": { - "description": "Deactivates a manual trigger. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + "description": "Deactivates a manual trigger. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", "flatPath": "v1/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}:deactivate", "httpMethod": "POST", "id": "displayvideo.advertisers.manualTriggers.deactivate", @@ -3625,7 +3625,7 @@ ] }, "get": { - "description": "Gets a manual trigger. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + "description": "Gets a manual trigger. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", "flatPath": "v1/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}", "httpMethod": "GET", "id": "displayvideo.advertisers.manualTriggers.get", @@ -3660,7 +3660,7 @@ ] }, "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. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + "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. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", "flatPath": "v1/advertisers/{advertisersId}/manualTriggers", "httpMethod": "GET", "id": "displayvideo.advertisers.manualTriggers.list", @@ -3707,7 +3707,7 @@ ] }, "patch": { - "description": "Updates a manual trigger. Returns the updated manual trigger if successful. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + "description": "Updates a manual trigger. Returns the updated manual trigger if successful. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", "flatPath": "v1/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}", "httpMethod": "PATCH", "id": "displayvideo.advertisers.manualTriggers.patch", @@ -8146,7 +8146,7 @@ } } }, - "revision": "20230504", + "revision": "20230518", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -15426,7 +15426,7 @@ }, "targetingExpansion": { "$ref": "TargetingExpansionConfig", - "description": "The [targeting expansion](//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. Beginning **March 25, 2023**, these settings may represent the [optimized targeting feature](//support.google.com/displayvideo/answer/12060859) in place of targeting expansion. This feature will be rolled out to all partners by early May 2023." + "description": "The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists." }, "updateTime": { "description": "Output only. The timestamp when the line item was last updated. Assigned by the system.", @@ -15550,12 +15550,12 @@ "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 a trigger. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information." + "The line item uses a trigger. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This value will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information." ], "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. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + "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. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This field will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", "format": "int64", "type": "string" } @@ -16169,7 +16169,7 @@ "type": "object" }, "ManualTrigger": { - "description": "A single manual trigger in Display \u0026 Video 360. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + "description": "A single manual trigger in Display \u0026 Video 360. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This resource will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", "id": "ManualTrigger", "properties": { "activationDurationMinutes": { @@ -17960,15 +17960,15 @@ "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. Beginning **March 25, 2023**, these settings may represent the [optimized targeting feature](//support.google.com/displayvideo/answer/12060859) in place of targeting expansion. This feature will be rolled out to all partners by early May 2023.", + "description": "Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item.", "id": "TargetingExpansionConfig", "properties": { "excludeFirstPartyAudience": { - "description": "Required. Whether to exclude first-party audiences from use in targeting expansion or optimized 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. Beginning **March 25, 2023**, this field may be deprecated with the replacement of targeting expansion with [optimized targeting](//support.google.com/displayvideo/answer/12060859). Upon deprecation, this field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. This field will be deprecated for all partners by early May 2023.", + "description": "Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences.", "type": "boolean" }, "targetingExpansionLevel": { - "description": "Required. Magnitude of expansion for applicable targeting under this line item. Beginning **March 25, 2023**, the behavior of this field may change in the following ways with the replacement of targeting expansion with [optimized targeting](//support.google.com/displayvideo/answer/12060859): * This field will represent the optimized targeting checkbox, with a `NO_EXPANSION` value representing optimized targeting turned off and a `LEAST_EXPANSION` value representing optimized targeting turned on. * `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. * If you set the field to any value other than `NO_EXPANSION`, it will automatically be set to `LEAST_EXPANSION`. This behavior will be rolled out to all partners by early May 2023.", + "description": "Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field.", "enum": [ "TARGETING_EXPANSION_LEVEL_UNSPECIFIED", "NO_EXPANSION", @@ -17979,13 +17979,13 @@ "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." + "The optimized targeting setting is not specified or is unknown in this version.", + "Optimized targeting is off.", + "Optimized targeting is on.", + "If used, will automatically be set to `LEAST_EXPANSION`.", + "If used, will automatically be set to `LEAST_EXPANSION`.", + "If used, will automatically be set to `LEAST_EXPANSION`.", + "If used, will automatically be set to `LEAST_EXPANSION`." ], "type": "string" } diff --git a/displayvideo/v1/displayvideo-gen.go b/displayvideo/v1/displayvideo-gen.go index 079e6d28a43..a02459ab1af 100644 --- a/displayvideo/v1/displayvideo-gen.go +++ b/displayvideo/v1/displayvideo-gen.go @@ -10733,14 +10733,11 @@ type LineItem struct { // guaranteed inventory source. ReservationType string `json:"reservationType,omitempty"` - // TargetingExpansion: The targeting expansion - // (//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. Beginning **March 25, 2023**, - // these settings may represent the optimized targeting feature - // (//support.google.com/displayvideo/answer/12060859) in place of - // targeting expansion. This feature will be rolled out to all partners - // by early May 2023. + // TargetingExpansion: The optimized targeting + // (//support.google.com/displayvideo/answer/12060859) settings of the + // line item. This config is only applicable for display, video, or + // audio line items that use automated bidding and positively target + // eligible audience lists. TargetingExpansion *TargetingExpansionConfig `json:"targetingExpansion,omitempty"` // UpdateTime: Output only. The timestamp when the line item was last @@ -10919,9 +10916,9 @@ type LineItemFlight struct { // "LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM" - The line item uses its own // custom flight dates. // "LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER" - The line item uses a - // trigger. **Warning:** Line Items using manual triggers will stop - // serving in Display & Video 360 on **May 17, 2023**. Read our [feature - // deprecation + // trigger. **Warning:** Line Items using manual triggers no longer + // serve in Display & Video 360. This value will sunset on August 1, + // 2023. Read our [feature deprecation // announcement](/display-video/api/deprecations#features.manual_triggers // ) for more information. FlightDateType string `json:"flightDateType,omitempty"` @@ -10932,9 +10929,9 @@ type LineItemFlight struct { // 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. **Warning:** Line Items using manual triggers will stop - // serving in Display & Video 360 on **May 17, 2023**. Read our feature - // deprecation announcement + // dates. **Warning:** Line Items using manual triggers no longer serve + // in Display & Video 360. This field will sunset on August 1, 2023. + // Read our feature deprecation announcement // (/display-video/api/deprecations#features.manual_triggers) for more // information. TriggerId int64 `json:"triggerId,omitempty,string"` @@ -12294,9 +12291,9 @@ func (s *LookupInvoiceCurrencyResponse) MarshalJSON() ([]byte, error) { } // ManualTrigger: A single manual trigger in Display & Video 360. -// **Warning:** Line Items using manual triggers will stop serving in -// Display & Video 360 on **May 17, 2023**. Read our feature deprecation -// announcement +// **Warning:** Line Items using manual triggers no longer serve in +// Display & Video 360. This resource will sunset on August 1, 2023. +// Read our feature deprecation announcement // (/display-video/api/deprecations#features.manual_triggers) for more // information. type ManualTrigger struct { @@ -15202,57 +15199,41 @@ func (s *SubExchangeTargetingOptionDetails) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// TargetingExpansionConfig: 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. Beginning **March 25, 2023**, these -// settings may represent the optimized targeting feature -// (//support.google.com/displayvideo/answer/12060859) in place of -// targeting expansion. This feature will be rolled out to all partners -// by early May 2023. +// TargetingExpansionConfig: Settings that control the optimized +// targeting (//support.google.com/displayvideo/answer/12060859) +// settings of the line item. type TargetingExpansionConfig struct { - // ExcludeFirstPartyAudience: Required. Whether to exclude first-party - // audiences from use in targeting expansion or optimized 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. Beginning **March 25, 2023**, this - // field may be deprecated with the replacement of targeting expansion - // with optimized targeting - // (//support.google.com/displayvideo/answer/12060859). Upon - // deprecation, this field will be set to `false`. If this field is set - // to `true` when deprecated, all positive first-party audience - // targeting assigned to this line item will be replaced with negative - // targeting of the same first-party audiences to ensure the continued - // exclusion of those audiences. This field will be deprecated for all - // partners by early May 2023. + // ExcludeFirstPartyAudience: Whether to exclude first-party audiences + // from use in targeting expansion. This field was deprecated with the + // launch of optimized targeting + // (//support.google.com/displayvideo/answer/12060859). This field will + // be set to `false`. If this field is set to `true` when deprecated, + // all positive first-party audience targeting assigned to this line + // item will be replaced with negative targeting of the same first-party + // audiences to ensure the continued exclusion of those audiences. ExcludeFirstPartyAudience bool `json:"excludeFirstPartyAudience,omitempty"` - // TargetingExpansionLevel: Required. Magnitude of expansion for - // applicable targeting under this line item. Beginning **March 25, - // 2023**, the behavior of this field may change in the following ways - // with the replacement of targeting expansion with optimized targeting - // (//support.google.com/displayvideo/answer/12060859): * This field - // will represent the optimized targeting checkbox, with a - // `NO_EXPANSION` value representing optimized targeting turned off and - // a `LEAST_EXPANSION` value representing optimized targeting turned on. - // * `NO_EXPANSION` will be the default value for the field and will be - // automatically assigned if you do not set the field. * If you set the - // field to any value other than `NO_EXPANSION`, it will automatically - // be set to `LEAST_EXPANSION`. This behavior will be rolled out to all - // partners by early May 2023. + // TargetingExpansionLevel: Required. Whether optimized targeting is + // turned on. This field supports the following values: * + // `NO_EXPANSION`: optimized targeting is turned off * + // `LEAST_EXPANSION`: optimized targeting is turned on If this field is + // set to any other value, it will automatically be set to + // `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the + // field and will be automatically assigned if you do not set the field. // // Possible values: - // "TARGETING_EXPANSION_LEVEL_UNSPECIFIED" - Targeting expansion level - // is not specified or is unknown in this version. - // "NO_EXPANSION" - Targeting expansion off. - // "LEAST_EXPANSION" - Conservative targeting expansion, lowest reach. - // "SOME_EXPANSION" - Moderately conservative targeting expansion, - // lower reach. - // "BALANCED_EXPANSION" - Moderate targeting expansion, medium reach. - // "MORE_EXPANSION" - Moderately aggressive targeting expansion, - // higher reach. - // "MOST_EXPANSION" - Aggressive targeting expansion, highest reach. + // "TARGETING_EXPANSION_LEVEL_UNSPECIFIED" - The optimized targeting + // setting is not specified or is unknown in this version. + // "NO_EXPANSION" - Optimized targeting is off. + // "LEAST_EXPANSION" - Optimized targeting is on. + // "SOME_EXPANSION" - If used, will automatically be set to + // `LEAST_EXPANSION`. + // "BALANCED_EXPANSION" - If used, will automatically be set to + // `LEAST_EXPANSION`. + // "MORE_EXPANSION" - If used, will automatically be set to + // `LEAST_EXPANSION`. + // "MOST_EXPANSION" - If used, will automatically be set to + // `LEAST_EXPANSION`. TargetingExpansionLevel string `json:"targetingExpansionLevel,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -28756,9 +28737,9 @@ type AdvertisersManualTriggersActivateCall struct { // Activate: Activates a manual trigger. Each activation of the manual // trigger must be at least 5 minutes apart, otherwise an error will be -// returned. **Warning:** Line Items using manual triggers will stop -// serving in Display & Video 360 on **May 17, 2023**. Read our feature -// deprecation announcement +// returned. **Warning:** Line Items using manual triggers no longer +// serve in Display & Video 360. This method will sunset on August 1, +// 2023. Read our feature deprecation announcement // (/display-video/api/deprecations#features.manual_triggers) for more // information. // @@ -28865,7 +28846,7 @@ func (c *AdvertisersManualTriggersActivateCall) Do(opts ...googleapi.CallOption) } return ret, nil // { - // "description": "Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + // "description": "Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", // "flatPath": "v1/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}:activate", // "httpMethod": "POST", // "id": "displayvideo.advertisers.manualTriggers.activate", @@ -28918,8 +28899,8 @@ type AdvertisersManualTriggersCreateCall struct { // Create: Creates a new manual trigger. Returns the newly created // manual trigger if successful. **Warning:** Line Items using manual -// triggers will stop serving in Display & Video 360 on **May 17, -// 2023**. Read our feature deprecation announcement +// triggers no longer serve in Display & Video 360. This method will +// sunset on August 1, 2023. Read our feature deprecation announcement // (/display-video/api/deprecations#features.manual_triggers) for more // information. // @@ -29023,7 +29004,7 @@ func (c *AdvertisersManualTriggersCreateCall) Do(opts ...googleapi.CallOption) ( } return ret, nil // { - // "description": "Creates a new manual trigger. Returns the newly created manual trigger if successful. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + // "description": "Creates a new manual trigger. Returns the newly created manual trigger if successful. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", // "flatPath": "v1/advertisers/{advertisersId}/manualTriggers", // "httpMethod": "POST", // "id": "displayvideo.advertisers.manualTriggers.create", @@ -29067,8 +29048,9 @@ type AdvertisersManualTriggersDeactivateCall struct { } // Deactivate: Deactivates a manual trigger. **Warning:** Line Items -// using manual triggers will stop serving in Display & Video 360 on -// **May 17, 2023**. Read our feature deprecation announcement +// using manual triggers no longer serve in Display & Video 360. This +// method will sunset on August 1, 2023. Read our feature deprecation +// announcement // (/display-video/api/deprecations#features.manual_triggers) for more // information. // @@ -29175,7 +29157,7 @@ func (c *AdvertisersManualTriggersDeactivateCall) Do(opts ...googleapi.CallOptio } return ret, nil // { - // "description": "Deactivates a manual trigger. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + // "description": "Deactivates a manual trigger. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", // "flatPath": "v1/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}:deactivate", // "httpMethod": "POST", // "id": "displayvideo.advertisers.manualTriggers.deactivate", @@ -29228,8 +29210,8 @@ type AdvertisersManualTriggersGetCall struct { } // Get: Gets a manual trigger. **Warning:** Line Items using manual -// triggers will stop serving in Display & Video 360 on **May 17, -// 2023**. Read our feature deprecation announcement +// triggers no longer serve in Display & Video 360. This method will +// sunset on August 1, 2023. Read our feature deprecation announcement // (/display-video/api/deprecations#features.manual_triggers) for more // information. // @@ -29343,7 +29325,7 @@ func (c *AdvertisersManualTriggersGetCall) Do(opts ...googleapi.CallOption) (*Ma } return ret, nil // { - // "description": "Gets a manual trigger. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + // "description": "Gets a manual trigger. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", // "flatPath": "v1/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}", // "httpMethod": "GET", // "id": "displayvideo.advertisers.manualTriggers.get", @@ -29394,8 +29376,9 @@ type AdvertisersManualTriggersListCall struct { // List: 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. **Warning:** Line -// Items using manual triggers will stop serving in Display & Video 360 -// on **May 17, 2023**. Read our feature deprecation announcement +// Items using manual triggers no longer serve in Display & Video 360. +// This method will sunset on August 1, 2023. Read our feature +// deprecation announcement // (/display-video/api/deprecations#features.manual_triggers) for more // information. // @@ -29549,7 +29532,7 @@ func (c *AdvertisersManualTriggersListCall) Do(opts ...googleapi.CallOption) (*L } return ret, nil // { - // "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. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + // "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. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", // "flatPath": "v1/advertisers/{advertisersId}/manualTriggers", // "httpMethod": "GET", // "id": "displayvideo.advertisers.manualTriggers.list", @@ -29632,9 +29615,9 @@ type AdvertisersManualTriggersPatchCall struct { } // Patch: Updates a manual trigger. Returns the updated manual trigger -// if successful. **Warning:** Line Items using manual triggers will -// stop serving in Display & Video 360 on **May 17, 2023**. Read our -// feature deprecation announcement +// if successful. **Warning:** Line Items using manual triggers no +// longer serve in Display & Video 360. This method will sunset on +// August 1, 2023. Read our feature deprecation announcement // (/display-video/api/deprecations#features.manual_triggers) for more // information. // @@ -29748,7 +29731,7 @@ func (c *AdvertisersManualTriggersPatchCall) Do(opts ...googleapi.CallOption) (* } return ret, nil // { - // "description": "Updates a manual trigger. Returns the updated manual trigger if successful. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + // "description": "Updates a manual trigger. Returns the updated manual trigger if successful. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", // "flatPath": "v1/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}", // "httpMethod": "PATCH", // "id": "displayvideo.advertisers.manualTriggers.patch", diff --git a/displayvideo/v2/displayvideo-api.json b/displayvideo/v2/displayvideo-api.json index d7bb0a3ec7a..a6627e3b219 100644 --- a/displayvideo/v2/displayvideo-api.json +++ b/displayvideo/v2/displayvideo-api.json @@ -3925,7 +3925,7 @@ "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. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + "description": "Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", "flatPath": "v2/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}:activate", "httpMethod": "POST", "id": "displayvideo.advertisers.manualTriggers.activate", @@ -3963,7 +3963,7 @@ ] }, "create": { - "description": "Creates a new manual trigger. Returns the newly created manual trigger if successful. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + "description": "Creates a new manual trigger. Returns the newly created manual trigger if successful. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", "flatPath": "v2/advertisers/{advertisersId}/manualTriggers", "httpMethod": "POST", "id": "displayvideo.advertisers.manualTriggers.create", @@ -3992,7 +3992,7 @@ ] }, "deactivate": { - "description": "Deactivates a manual trigger. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + "description": "Deactivates a manual trigger. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", "flatPath": "v2/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}:deactivate", "httpMethod": "POST", "id": "displayvideo.advertisers.manualTriggers.deactivate", @@ -4030,7 +4030,7 @@ ] }, "get": { - "description": "Gets a manual trigger. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + "description": "Gets a manual trigger. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", "flatPath": "v2/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}", "httpMethod": "GET", "id": "displayvideo.advertisers.manualTriggers.get", @@ -4065,7 +4065,7 @@ ] }, "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. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + "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. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", "flatPath": "v2/advertisers/{advertisersId}/manualTriggers", "httpMethod": "GET", "id": "displayvideo.advertisers.manualTriggers.list", @@ -4112,7 +4112,7 @@ ] }, "patch": { - "description": "Updates a manual trigger. Returns the updated manual trigger if successful. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + "description": "Updates a manual trigger. Returns the updated manual trigger if successful. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", "flatPath": "v2/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}", "httpMethod": "PATCH", "id": "displayvideo.advertisers.manualTriggers.patch", @@ -9172,7 +9172,7 @@ } } }, - "revision": "20230504", + "revision": "20230518", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -17021,7 +17021,7 @@ }, "targetingExpansion": { "$ref": "TargetingExpansionConfig", - "description": "The [targeting expansion](//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. Beginning **March 25, 2023**, these settings may represent the [optimized targeting feature](//support.google.com/displayvideo/answer/12060859) in place of targeting expansion. This feature will be rolled out to all partners by early May 2023." + "description": "The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists." }, "updateTime": { "description": "Output only. The timestamp when the line item was last updated. Assigned by the system.", @@ -17816,7 +17816,7 @@ "type": "object" }, "ManualTrigger": { - "description": "A single manual trigger in Display \u0026 Video 360. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + "description": "A single manual trigger in Display \u0026 Video 360. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This resource will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", "id": "ManualTrigger", "properties": { "activationDurationMinutes": { @@ -19792,15 +19792,15 @@ "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. Beginning **March 25, 2023**, these settings may represent the [optimized targeting feature](//support.google.com/displayvideo/answer/12060859) in place of targeting expansion. This feature will be rolled out to all partners by early May 2023.", + "description": "Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item.", "id": "TargetingExpansionConfig", "properties": { "excludeFirstPartyAudience": { - "description": "Required. Whether to exclude first-party audiences from use in targeting expansion or optimized 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. Beginning **March 25, 2023**, this field may be deprecated with the replacement of targeting expansion with [optimized targeting](//support.google.com/displayvideo/answer/12060859). Upon deprecation, this field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. This field will be deprecated for all partners by early May 2023.", + "description": "Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences.", "type": "boolean" }, "targetingExpansionLevel": { - "description": "Required. Magnitude of expansion for applicable targeting under this line item. Beginning **March 25, 2023**, the behavior of this field may change in the following ways with the replacement of targeting expansion with [optimized targeting](//support.google.com/displayvideo/answer/12060859): * This field will represent the optimized targeting checkbox, with a `NO_EXPANSION` value representing optimized targeting turned off and a `LEAST_EXPANSION` value representing optimized targeting turned on. * `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. * If you set the field to any value other than `NO_EXPANSION`, it will automatically be set to `LEAST_EXPANSION`. This behavior will be rolled out to all partners by early May 2023.", + "description": "Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field.", "enum": [ "TARGETING_EXPANSION_LEVEL_UNSPECIFIED", "NO_EXPANSION", @@ -19811,13 +19811,13 @@ "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." + "The optimized targeting setting is not specified or is unknown in this version.", + "Optimized targeting is off.", + "Optimized targeting is on.", + "If used, will automatically be set to `LEAST_EXPANSION`.", + "If used, will automatically be set to `LEAST_EXPANSION`.", + "If used, will automatically be set to `LEAST_EXPANSION`.", + "If used, will automatically be set to `LEAST_EXPANSION`." ], "type": "string" } diff --git a/displayvideo/v2/displayvideo-gen.go b/displayvideo/v2/displayvideo-gen.go index 2a5710f7e19..e9a5d67465a 100644 --- a/displayvideo/v2/displayvideo-gen.go +++ b/displayvideo/v2/displayvideo-gen.go @@ -11656,14 +11656,11 @@ type LineItem struct { // Only applicable to YouTube and partners line items. ReservationType string `json:"reservationType,omitempty"` - // TargetingExpansion: The targeting expansion - // (//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. Beginning **March 25, 2023**, - // these settings may represent the optimized targeting feature - // (//support.google.com/displayvideo/answer/12060859) in place of - // targeting expansion. This feature will be rolled out to all partners - // by early May 2023. + // TargetingExpansion: The optimized targeting + // (//support.google.com/displayvideo/answer/12060859) settings of the + // line item. This config is only applicable for display, video, or + // audio line items that use automated bidding and positively target + // eligible audience lists. TargetingExpansion *TargetingExpansionConfig `json:"targetingExpansion,omitempty"` // UpdateTime: Output only. The timestamp when the line item was last @@ -13337,9 +13334,9 @@ func (s *LookupInvoiceCurrencyResponse) MarshalJSON() ([]byte, error) { } // ManualTrigger: A single manual trigger in Display & Video 360. -// **Warning:** Line Items using manual triggers will stop serving in -// Display & Video 360 on **May 17, 2023**. Read our feature deprecation -// announcement +// **Warning:** Line Items using manual triggers no longer serve in +// Display & Video 360. This resource will sunset on August 1, 2023. +// Read our feature deprecation announcement // (/display-video/api/deprecations#features.manual_triggers) for more // information. type ManualTrigger struct { @@ -16530,57 +16527,41 @@ func (s *TargetFrequency) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// TargetingExpansionConfig: 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. Beginning **March 25, 2023**, these -// settings may represent the optimized targeting feature -// (//support.google.com/displayvideo/answer/12060859) in place of -// targeting expansion. This feature will be rolled out to all partners -// by early May 2023. +// TargetingExpansionConfig: Settings that control the optimized +// targeting (//support.google.com/displayvideo/answer/12060859) +// settings of the line item. type TargetingExpansionConfig struct { - // ExcludeFirstPartyAudience: Required. Whether to exclude first-party - // audiences from use in targeting expansion or optimized 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. Beginning **March 25, 2023**, this - // field may be deprecated with the replacement of targeting expansion - // with optimized targeting - // (//support.google.com/displayvideo/answer/12060859). Upon - // deprecation, this field will be set to `false`. If this field is set - // to `true` when deprecated, all positive first-party audience - // targeting assigned to this line item will be replaced with negative - // targeting of the same first-party audiences to ensure the continued - // exclusion of those audiences. This field will be deprecated for all - // partners by early May 2023. + // ExcludeFirstPartyAudience: Whether to exclude first-party audiences + // from use in targeting expansion. This field was deprecated with the + // launch of optimized targeting + // (//support.google.com/displayvideo/answer/12060859). This field will + // be set to `false`. If this field is set to `true` when deprecated, + // all positive first-party audience targeting assigned to this line + // item will be replaced with negative targeting of the same first-party + // audiences to ensure the continued exclusion of those audiences. ExcludeFirstPartyAudience bool `json:"excludeFirstPartyAudience,omitempty"` - // TargetingExpansionLevel: Required. Magnitude of expansion for - // applicable targeting under this line item. Beginning **March 25, - // 2023**, the behavior of this field may change in the following ways - // with the replacement of targeting expansion with optimized targeting - // (//support.google.com/displayvideo/answer/12060859): * This field - // will represent the optimized targeting checkbox, with a - // `NO_EXPANSION` value representing optimized targeting turned off and - // a `LEAST_EXPANSION` value representing optimized targeting turned on. - // * `NO_EXPANSION` will be the default value for the field and will be - // automatically assigned if you do not set the field. * If you set the - // field to any value other than `NO_EXPANSION`, it will automatically - // be set to `LEAST_EXPANSION`. This behavior will be rolled out to all - // partners by early May 2023. + // TargetingExpansionLevel: Required. Whether optimized targeting is + // turned on. This field supports the following values: * + // `NO_EXPANSION`: optimized targeting is turned off * + // `LEAST_EXPANSION`: optimized targeting is turned on If this field is + // set to any other value, it will automatically be set to + // `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the + // field and will be automatically assigned if you do not set the field. // // Possible values: - // "TARGETING_EXPANSION_LEVEL_UNSPECIFIED" - Targeting expansion level - // is not specified or is unknown in this version. - // "NO_EXPANSION" - Targeting expansion off. - // "LEAST_EXPANSION" - Conservative targeting expansion, lowest reach. - // "SOME_EXPANSION" - Moderately conservative targeting expansion, - // lower reach. - // "BALANCED_EXPANSION" - Moderate targeting expansion, medium reach. - // "MORE_EXPANSION" - Moderately aggressive targeting expansion, - // higher reach. - // "MOST_EXPANSION" - Aggressive targeting expansion, highest reach. + // "TARGETING_EXPANSION_LEVEL_UNSPECIFIED" - The optimized targeting + // setting is not specified or is unknown in this version. + // "NO_EXPANSION" - Optimized targeting is off. + // "LEAST_EXPANSION" - Optimized targeting is on. + // "SOME_EXPANSION" - If used, will automatically be set to + // `LEAST_EXPANSION`. + // "BALANCED_EXPANSION" - If used, will automatically be set to + // `LEAST_EXPANSION`. + // "MORE_EXPANSION" - If used, will automatically be set to + // `LEAST_EXPANSION`. + // "MOST_EXPANSION" - If used, will automatically be set to + // `LEAST_EXPANSION`. TargetingExpansionLevel string `json:"targetingExpansionLevel,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -31878,9 +31859,9 @@ type AdvertisersManualTriggersActivateCall struct { // Activate: Activates a manual trigger. Each activation of the manual // trigger must be at least 5 minutes apart, otherwise an error will be -// returned. **Warning:** Line Items using manual triggers will stop -// serving in Display & Video 360 on **May 17, 2023**. Read our feature -// deprecation announcement +// returned. **Warning:** Line Items using manual triggers no longer +// serve in Display & Video 360. This method will sunset on August 1, +// 2023. Read our feature deprecation announcement // (/display-video/api/deprecations#features.manual_triggers) for more // information. // @@ -31987,7 +31968,7 @@ func (c *AdvertisersManualTriggersActivateCall) Do(opts ...googleapi.CallOption) } return ret, nil // { - // "description": "Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + // "description": "Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", // "flatPath": "v2/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}:activate", // "httpMethod": "POST", // "id": "displayvideo.advertisers.manualTriggers.activate", @@ -32040,8 +32021,8 @@ type AdvertisersManualTriggersCreateCall struct { // Create: Creates a new manual trigger. Returns the newly created // manual trigger if successful. **Warning:** Line Items using manual -// triggers will stop serving in Display & Video 360 on **May 17, -// 2023**. Read our feature deprecation announcement +// triggers no longer serve in Display & Video 360. This method will +// sunset on August 1, 2023. Read our feature deprecation announcement // (/display-video/api/deprecations#features.manual_triggers) for more // information. // @@ -32145,7 +32126,7 @@ func (c *AdvertisersManualTriggersCreateCall) Do(opts ...googleapi.CallOption) ( } return ret, nil // { - // "description": "Creates a new manual trigger. Returns the newly created manual trigger if successful. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + // "description": "Creates a new manual trigger. Returns the newly created manual trigger if successful. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", // "flatPath": "v2/advertisers/{advertisersId}/manualTriggers", // "httpMethod": "POST", // "id": "displayvideo.advertisers.manualTriggers.create", @@ -32189,8 +32170,9 @@ type AdvertisersManualTriggersDeactivateCall struct { } // Deactivate: Deactivates a manual trigger. **Warning:** Line Items -// using manual triggers will stop serving in Display & Video 360 on -// **May 17, 2023**. Read our feature deprecation announcement +// using manual triggers no longer serve in Display & Video 360. This +// method will sunset on August 1, 2023. Read our feature deprecation +// announcement // (/display-video/api/deprecations#features.manual_triggers) for more // information. // @@ -32297,7 +32279,7 @@ func (c *AdvertisersManualTriggersDeactivateCall) Do(opts ...googleapi.CallOptio } return ret, nil // { - // "description": "Deactivates a manual trigger. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + // "description": "Deactivates a manual trigger. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", // "flatPath": "v2/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}:deactivate", // "httpMethod": "POST", // "id": "displayvideo.advertisers.manualTriggers.deactivate", @@ -32350,8 +32332,8 @@ type AdvertisersManualTriggersGetCall struct { } // Get: Gets a manual trigger. **Warning:** Line Items using manual -// triggers will stop serving in Display & Video 360 on **May 17, -// 2023**. Read our feature deprecation announcement +// triggers no longer serve in Display & Video 360. This method will +// sunset on August 1, 2023. Read our feature deprecation announcement // (/display-video/api/deprecations#features.manual_triggers) for more // information. // @@ -32465,7 +32447,7 @@ func (c *AdvertisersManualTriggersGetCall) Do(opts ...googleapi.CallOption) (*Ma } return ret, nil // { - // "description": "Gets a manual trigger. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + // "description": "Gets a manual trigger. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", // "flatPath": "v2/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}", // "httpMethod": "GET", // "id": "displayvideo.advertisers.manualTriggers.get", @@ -32516,8 +32498,9 @@ type AdvertisersManualTriggersListCall struct { // List: 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. **Warning:** Line -// Items using manual triggers will stop serving in Display & Video 360 -// on **May 17, 2023**. Read our feature deprecation announcement +// Items using manual triggers no longer serve in Display & Video 360. +// This method will sunset on August 1, 2023. Read our feature +// deprecation announcement // (/display-video/api/deprecations#features.manual_triggers) for more // information. // @@ -32671,7 +32654,7 @@ func (c *AdvertisersManualTriggersListCall) Do(opts ...googleapi.CallOption) (*L } return ret, nil // { - // "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. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + // "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. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", // "flatPath": "v2/advertisers/{advertisersId}/manualTriggers", // "httpMethod": "GET", // "id": "displayvideo.advertisers.manualTriggers.list", @@ -32754,9 +32737,9 @@ type AdvertisersManualTriggersPatchCall struct { } // Patch: Updates a manual trigger. Returns the updated manual trigger -// if successful. **Warning:** Line Items using manual triggers will -// stop serving in Display & Video 360 on **May 17, 2023**. Read our -// feature deprecation announcement +// if successful. **Warning:** Line Items using manual triggers no +// longer serve in Display & Video 360. This method will sunset on +// August 1, 2023. Read our feature deprecation announcement // (/display-video/api/deprecations#features.manual_triggers) for more // information. // @@ -32870,7 +32853,7 @@ func (c *AdvertisersManualTriggersPatchCall) Do(opts ...googleapi.CallOption) (* } return ret, nil // { - // "description": "Updates a manual trigger. Returns the updated manual trigger if successful. **Warning:** Line Items using manual triggers will stop serving in Display \u0026 Video 360 on **May 17, 2023**. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", + // "description": "Updates a manual trigger. Returns the updated manual trigger if successful. **Warning:** Line Items using manual triggers no longer serve in Display \u0026 Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.", // "flatPath": "v2/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}", // "httpMethod": "PATCH", // "id": "displayvideo.advertisers.manualTriggers.patch", diff --git a/drive/v2/drive-api.json b/drive/v2/drive-api.json index 87680b9176b..d0ff5feea78 100644 --- a/drive/v2/drive-api.json +++ b/drive/v2/drive-api.json @@ -35,32 +35,59 @@ "basePath": "/drive/v2/", "baseUrl": "https://www.googleapis.com/drive/v2/", "batchPath": "batch/drive/v2", - "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", + "description": "The Google Drive API allows clients to access resources from Google Drive.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/drive/", - "etag": "\"VYc8DWo_6wRTElVugbtvWfkARsc/vUgtTacNQXAlvuhI2YoKrF8mHHA\"", "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" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "id": "drive:v2", "kind": "discovery#restDescription", + "mtlsRootUrl": "https://www.mtls.googleapis.com/", "name": "drive", "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 the response.", + "description": "Data format for response.", "enum": [ - "json" + "json", + "media", + "proto" ], "enumDescriptions": [ - "Responses with Content-Type of application/json" + "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", @@ -83,12 +110,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" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, - "userIp": { - "description": "Deprecated. Please use quotaUser instead.", + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } @@ -99,12 +131,14 @@ "methods": { "get": { "description": "Gets the information about the current user along with Drive API settings", + "flatPath": "about", "httpMethod": "GET", "id": "drive.about.get", + "parameterOrder": [], "parameters": { "includeSubscribed": { "default": "true", - "description": "Whether to count changes outside the My Drive hierarchy. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the maxChangeIdCount.", + "description": "Whether to count changes outside the My Drive hierarchy. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the `maxChangeIdCount`.", "location": "query", "type": "boolean" }, @@ -142,6 +176,7 @@ "methods": { "get": { "description": "Gets a specific app.", + "flatPath": "apps/{appId}", "httpMethod": "GET", "id": "drive.apps.get", "parameterOrder": [ @@ -171,18 +206,20 @@ }, "list": { "description": "Lists a user's installed apps.", + "flatPath": "apps", "httpMethod": "GET", "id": "drive.apps.list", + "parameterOrder": [], "parameters": { "appFilterExtensions": { "default": "", - "description": "A comma-separated list of file extensions for open with filtering. All apps within the given app query scope which can open any of the given file extensions will be included in the response. If appFilterMimeTypes are provided as well, the result is a union of the two resulting app lists.", + "description": "A comma-separated list of file extensions for open with filtering. All apps within the given app query scope which can open any of the given file extensions will be included in the response. If `appFilterMimeTypes` are provided as well, the result is a union of the two resulting app lists.", "location": "query", "type": "string" }, "appFilterMimeTypes": { "default": "", - "description": "A comma-separated list of MIME types for open with filtering. All apps within the given app query scope which can open any of the given MIME types will be included in the response. If appFilterExtensions are provided as well, the result is a union of the two resulting app lists.", + "description": "A comma-separated list of MIME types for open with filtering. All apps within the given app query scope which can open any of the given MIME types will be included in the response. If `appFilterExtensions` are provided as well, the result is a union of the two resulting app lists.", "location": "query", "type": "string" }, @@ -205,7 +242,8 @@ "changes": { "methods": { "get": { - "description": "Deprecated - Use changes.getStartPageToken and changes.list to retrieve recent changes.", + "description": "Deprecated: Use `changes.getStartPageToken` and `changes.list` to retrieve recent changes.", + "flatPath": "changes/{changeId}", "httpMethod": "GET", "id": "drive.changes.get", "parameterOrder": [ @@ -219,7 +257,7 @@ "type": "string" }, "driveId": { - "description": "The shared drive from which the change is returned.", + "description": "The shared drive from which the change will be returned.", "location": "query", "type": "string" }, @@ -231,12 +269,12 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "teamDriveId": { - "description": "Deprecated use driveId instead.", + "description": "Deprecated: Use `driveId` instead.", "location": "query", "type": "string" } @@ -258,11 +296,13 @@ }, "getStartPageToken": { "description": "Gets the starting pageToken for listing future changes.", + "flatPath": "changes/startPageToken", "httpMethod": "GET", "id": "drive.changes.getStartPageToken", + "parameterOrder": [], "parameters": { "driveId": { - "description": "The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned.", + "description": "The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.", "location": "query", "type": "string" }, @@ -274,12 +314,12 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "teamDriveId": { - "description": "Deprecated use driveId instead.", + "description": "Deprecated: Use `driveId` instead.", "location": "query", "type": "string" } @@ -301,11 +341,13 @@ }, "list": { "description": "Lists the changes for a user or shared drive.", + "flatPath": "changes", "httpMethod": "GET", "id": "drive.changes.list", + "parameterOrder": [], "parameters": { "driveId": { - "description": "The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", + "description": "The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", "location": "query", "type": "string" }, @@ -328,24 +370,24 @@ "type": "boolean" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "includeSubscribed": { "default": "true", - "description": "Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result.", + "description": "Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.", "location": "query", "type": "boolean" }, "includeTeamDriveItems": { "default": "false", - "description": "Deprecated use includeItemsFromAllDrives instead.", + "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -358,17 +400,17 @@ "type": "integer" }, "pageToken": { - "description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.", + "description": "The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response or to the response from the getStartPageToken method.", "location": "query", "type": "string" }, "spaces": { - "description": "A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.", + "description": "A comma-separated list of spaces to query. Supported values are `drive`, `appDataFolder` and `photos`.", "location": "query", "type": "string" }, "startChangeId": { - "description": "Deprecated - use pageToken instead.", + "description": "Deprecated: Use `pageToken` instead.", "format": "int64", "location": "query", "type": "string" @@ -381,12 +423,12 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "teamDriveId": { - "description": "Deprecated use driveId instead.", + "description": "Deprecated: Use `driveId` instead.", "location": "query", "type": "string" } @@ -409,11 +451,13 @@ }, "watch": { "description": "Subscribe to changes for a user.", + "flatPath": "changes/watch", "httpMethod": "POST", "id": "drive.changes.watch", + "parameterOrder": [], "parameters": { "driveId": { - "description": "The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", + "description": "The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", "location": "query", "type": "string" }, @@ -436,24 +480,24 @@ "type": "boolean" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "includeSubscribed": { "default": "true", - "description": "Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result.", + "description": "Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.", "location": "query", "type": "boolean" }, "includeTeamDriveItems": { "default": "false", - "description": "Deprecated use includeItemsFromAllDrives instead.", + "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -466,17 +510,17 @@ "type": "integer" }, "pageToken": { - "description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.", + "description": "The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response or to the response from the getStartPageToken method.", "location": "query", "type": "string" }, "spaces": { - "description": "A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.", + "description": "A comma-separated list of spaces to query. Supported values are `drive`, `appDataFolder` and `photos`.", "location": "query", "type": "string" }, "startChangeId": { - "description": "Deprecated - use pageToken instead.", + "description": "Deprecated: Use `pageToken` instead.", "format": "int64", "location": "query", "type": "string" @@ -489,12 +533,12 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "teamDriveId": { - "description": "Deprecated use driveId instead.", + "description": "Deprecated: Use `driveId` instead.", "location": "query", "type": "string" } @@ -524,9 +568,12 @@ "channels": { "methods": { "stop": { - "description": "Stop watching resources through this channel", + "description": "Stops watching resources through this channel.", + "flatPath": "channels/stop", "httpMethod": "POST", "id": "drive.channels.stop", + "parameterOrder": [], + "parameters": {}, "path": "channels/stop", "request": { "$ref": "Channel", @@ -549,6 +596,7 @@ "methods": { "delete": { "description": "Removes a child from a folder.", + "flatPath": "files/{folderId}/children/{childId}", "httpMethod": "DELETE", "id": "drive.children.delete", "parameterOrder": [ @@ -564,7 +612,7 @@ }, "enforceSingleParent": { "default": "false", - "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.", + "description": "Deprecated: If an item is not in a shared drive and its last parent is removed, the item is placed under its owner's root.", "location": "query", "type": "boolean" }, @@ -583,6 +631,7 @@ }, "get": { "description": "Gets a specific child reference.", + "flatPath": "files/{folderId}/children/{childId}", "httpMethod": "GET", "id": "drive.children.get", "parameterOrder": [ @@ -619,6 +668,7 @@ }, "insert": { "description": "Inserts a file into a folder.", + "flatPath": "files/{folderId}/children", "httpMethod": "POST", "id": "drive.children.insert", "parameterOrder": [ @@ -627,7 +677,7 @@ "parameters": { "enforceSingleParent": { "default": "false", - "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", + "description": "Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead.", "location": "query", "type": "boolean" }, @@ -645,7 +695,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" } @@ -665,6 +715,7 @@ }, "list": { "description": "Lists a folder's children.", + "flatPath": "files/{folderId}/children", "httpMethod": "GET", "id": "drive.children.list", "parameterOrder": [ @@ -686,7 +737,7 @@ "type": "integer" }, "orderBy": { - "description": "A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', and 'title'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.", + "description": "A comma-separated list of sort keys. Valid keys are `createdDate`, `folder`, `lastViewedByMeDate`, `modifiedByMeDate`, `modifiedDate`, `quotaBytesUsed`, `recency`, `sharedWithMeDate`, `starred`, and `title`. Each key sorts ascending by default, but may be reversed with the `desc` modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.", "location": "query", "type": "string" }, @@ -721,6 +772,7 @@ "methods": { "delete": { "description": "Deletes a comment.", + "flatPath": "files/{fileId}/comments/{commentId}", "httpMethod": "DELETE", "id": "drive.comments.delete", "parameterOrder": [ @@ -749,6 +801,7 @@ }, "get": { "description": "Gets a comment by ID.", + "flatPath": "files/{fileId}/comments/{commentId}", "httpMethod": "GET", "id": "drive.comments.get", "parameterOrder": [ @@ -787,6 +840,7 @@ }, "insert": { "description": "Creates a new comment on the given file.", + "flatPath": "files/{fileId}/comments", "httpMethod": "POST", "id": "drive.comments.insert", "parameterOrder": [ @@ -814,6 +868,7 @@ }, "list": { "description": "Lists a file's comments.", + "flatPath": "files/{fileId}/comments", "httpMethod": "GET", "id": "drive.comments.list", "parameterOrder": [ @@ -864,6 +919,7 @@ }, "patch": { "description": "Updates an existing comment.", + "flatPath": "files/{fileId}/comments/{commentId}", "httpMethod": "PATCH", "id": "drive.comments.patch", "parameterOrder": [ @@ -898,6 +954,7 @@ }, "update": { "description": "Updates an existing comment.", + "flatPath": "files/{fileId}/comments/{commentId}", "httpMethod": "PUT", "id": "drive.comments.update", "parameterOrder": [ @@ -936,6 +993,7 @@ "methods": { "delete": { "description": "Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.", + "flatPath": "drives/{driveId}", "httpMethod": "DELETE", "id": "drive.drives.delete", "parameterOrder": [ @@ -944,7 +1002,7 @@ "parameters": { "allowItemDeletion": { "default": "false", - "description": "Whether any items inside the shared drive should also be deleted. This option is only supported when useDomainAdminAccess is also set to true.", + "description": "Whether any items inside the shared drive should also be deleted. This option is only supported when `useDomainAdminAccess` is also set to `true`.", "location": "query", "type": "boolean" }, @@ -968,6 +1026,7 @@ }, "get": { "description": "Gets a shared drive's metadata by ID.", + "flatPath": "drives/{driveId}", "httpMethod": "GET", "id": "drive.drives.get", "parameterOrder": [ @@ -998,6 +1057,7 @@ }, "hide": { "description": "Hides a shared drive from the default view.", + "flatPath": "drives/{driveId}/hide", "httpMethod": "POST", "id": "drive.drives.hide", "parameterOrder": [ @@ -1021,6 +1081,7 @@ }, "insert": { "description": "Creates a new shared drive.", + "flatPath": "drives", "httpMethod": "POST", "id": "drive.drives.insert", "parameterOrder": [ @@ -1028,7 +1089,7 @@ ], "parameters": { "requestId": { - "description": "An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.", + "description": "Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.", "location": "query", "required": true, "type": "string" @@ -1046,9 +1107,11 @@ ] }, "list": { - "description": "Lists the user's shared drives.", + "description": " Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/drive/api/guides/search-shareddrives) guide.", + "flatPath": "drives", "httpMethod": "GET", "id": "drive.drives.list", + "parameterOrder": [], "parameters": { "maxResults": { "default": "10", @@ -1087,6 +1150,7 @@ }, "unhide": { "description": "Restores a shared drive to the default view.", + "flatPath": "drives/{driveId}/unhide", "httpMethod": "POST", "id": "drive.drives.unhide", "parameterOrder": [ @@ -1110,6 +1174,7 @@ }, "update": { "description": "Updates the metadata for a shared drive.", + "flatPath": "drives/{driveId}", "httpMethod": "PUT", "id": "drive.drives.update", "parameterOrder": [ @@ -1145,7 +1210,8 @@ "files": { "methods": { "copy": { - "description": "Creates a copy of the specified file. Folders cannot be copied.", + "description": "Creates a copy of the specified file.", + "flatPath": "files/{fileId}/copy", "httpMethod": "POST", "id": "drive.files.copy", "parameterOrder": [ @@ -1160,7 +1226,7 @@ }, "enforceSingleParent": { "default": "false", - "description": "Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.", + "description": "Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead.", "location": "query", "type": "boolean" }, @@ -1171,12 +1237,12 @@ "type": "string" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, @@ -1187,7 +1253,7 @@ "type": "boolean" }, "ocrLanguage": { - "description": "If ocr is true, hints at the language to use. Valid values are BCP 47 codes.", + "description": "If `ocr` is true, hints at the language to use. Valid values are BCP 47 codes.", "location": "query", "type": "string" }, @@ -1205,7 +1271,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -1251,6 +1317,7 @@ }, "delete": { "description": "Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for shared drive files.", + "flatPath": "files/{fileId}", "httpMethod": "DELETE", "id": "drive.files.delete", "parameterOrder": [ @@ -1259,7 +1326,7 @@ "parameters": { "enforceSingleParent": { "default": "false", - "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.", + "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 is placed under its owner's root.", "location": "query", "type": "boolean" }, @@ -1277,7 +1344,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" } @@ -1290,9 +1357,11 @@ ] }, "emptyTrash": { - "description": "Permanently deletes all trashed files of a user or shared drive.", + "description": "Permanently deletes all of the user's trashed files.", + "flatPath": "files/trash", "httpMethod": "DELETE", "id": "drive.files.emptyTrash", + "parameterOrder": [], "parameters": { "driveId": { "description": "If set, empties the trash of the provided shared drive.", @@ -1301,7 +1370,7 @@ }, "enforceSingleParent": { "default": "false", - "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.", + "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 is placed under its owner's root.", "location": "query", "type": "boolean" } @@ -1313,6 +1382,7 @@ }, "export": { "description": "Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.", + "flatPath": "files/{fileId}/export", "httpMethod": "GET", "id": "drive.files.export", "parameterOrder": [ @@ -1327,7 +1397,7 @@ "type": "string" }, "mimeType": { - "description": "The MIME type of the format requested for this export.", + "description": "Required. The MIME type of the format requested for this export.", "location": "query", "required": true, "type": "string" @@ -1339,12 +1409,15 @@ "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.readonly" ], - "supportsMediaDownload": true + "supportsMediaDownload": true, + "useMediaDownloadService": true }, "generateIds": { "description": "Generates a set of file IDs which can be provided in insert or copy requests.", + "flatPath": "files/generateIds", "httpMethod": "GET", "id": "drive.files.generateIds", + "parameterOrder": [], "parameters": { "maxResults": { "default": "10", @@ -1357,13 +1430,13 @@ }, "space": { "default": "drive", - "description": "The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. (Default: 'drive')", + "description": "The space in which the IDs can be used to create new files. Supported values are `drive` and `appDataFolder`. (Default: `drive`)", "location": "query", "type": "string" }, "type": { "default": "files", - "description": "The type of items which the IDs can be used for. Supported values are 'files' and 'shortcuts'. Note that 'shortcuts' are only supported in the drive 'space'. (Default: 'files')", + "description": "The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`)", "location": "query", "type": "string" } @@ -1379,7 +1452,8 @@ ] }, "get": { - "description": "Gets a file's metadata or content by ID.", + "description": " Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v2/files/export) instead. For more information, see [Download \u0026 export files](/drive/api/guides/manage-downloads).", + "flatPath": "files/{fileId}", "httpMethod": "GET", "id": "drive.files.get", "parameterOrder": [ @@ -1399,24 +1473,24 @@ "type": "string" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "projection": { - "description": "This parameter is deprecated and has no function.", + "description": "Deprecated: This parameter has no function.", "enum": [ "BASIC", "FULL" ], "enumDescriptions": [ - "Deprecated", - "Deprecated" + "Deprecated.", + "Deprecated." ], "location": "query", "type": "string" @@ -1434,13 +1508,13 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "updateViewedDate": { "default": "false", - "description": "Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.", + "description": "Deprecated: Use `files.update` with `modifiedDateBehavior=noChange, updateViewedDate=true` and an empty request body.", "location": "query", "type": "boolean" } @@ -1463,14 +1537,15 @@ "useMediaDownloadService": true }, "insert": { - "description": "Insert a new file.", + "description": " Inserts a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.insert` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `title` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"title\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.", + "flatPath": "files", "httpMethod": "POST", "id": "drive.files.insert", "mediaUpload": { "accept": [ "*/*" ], - "maxSize": "5120GB", + "maxSize": "5497558138880", "protocols": { "resumable": { "multipart": true, @@ -1482,6 +1557,7 @@ } } }, + "parameterOrder": [], "parameters": { "convert": { "default": "false", @@ -1491,17 +1567,17 @@ }, "enforceSingleParent": { "default": "false", - "description": "Deprecated. Creating files in multiple folders is no longer supported.", + "description": "Deprecated: Creating files in multiple folders is no longer supported.", "location": "query", "type": "boolean" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, @@ -1530,7 +1606,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -1578,21 +1654,22 @@ "https://www.googleapis.com/auth/drive.apps.readonly", "https://www.googleapis.com/auth/drive.file" ], - "supportsMediaUpload": true, - "supportsSubscription": true + "supportsMediaUpload": true }, "list": { - "description": "Lists the user's files.", + "description": " Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files \u0026 folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", + "flatPath": "files", "httpMethod": "GET", "id": "drive.files.list", + "parameterOrder": [], "parameters": { "corpora": { - "description": "Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency.", + "description": "Bodies of items (files/documents) to which the query applies. Supported bodies are `default`, `domain`, `drive` and `allDrives`. Prefer `default` or `drive` to `allDrives` for efficiency.", "location": "query", "type": "string" }, "corpus": { - "description": "The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead.", + "description": "Deprecated: The body of items (files/documents) to which the query applies. Use `corpora` instead.", "enum": [ "DEFAULT", "DOMAIN" @@ -1616,18 +1693,18 @@ "type": "boolean" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "includeTeamDriveItems": { "default": "false", - "description": "Deprecated use includeItemsFromAllDrives instead.", + "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -1640,7 +1717,7 @@ "type": "integer" }, "orderBy": { - "description": "A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', and 'title_natural'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.", + "description": "A comma-separated list of sort keys. Valid keys are `createdDate`, `folder`, `lastViewedByMeDate`, `modifiedByMeDate`, `modifiedDate`, `quotaBytesUsed`, `recency`, `sharedWithMeDate`, `starred`, `title`, and `title_natural`. Each key sorts ascending by default, but may be reversed with the `desc` modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.", "location": "query", "type": "string" }, @@ -1650,14 +1727,14 @@ "type": "string" }, "projection": { - "description": "This parameter is deprecated and has no function.", + "description": "Deprecated: This parameter has no function.", "enum": [ "BASIC", "FULL" ], "enumDescriptions": [ - "Deprecated", - "Deprecated" + "Deprecated.", + "Deprecated." ], "location": "query", "type": "string" @@ -1668,7 +1745,7 @@ "type": "string" }, "spaces": { - "description": "A comma-separated list of spaces to query. Supported values are 'drive' and 'appDataFolder'.", + "description": "A comma-separated list of spaces to query. Supported values are `drive`, and `appDataFolder`.", "location": "query", "type": "string" }, @@ -1680,12 +1757,12 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "teamDriveId": { - "description": "Deprecated use driveId instead.", + "description": "Deprecated: Use `driveId` instead.", "location": "query", "type": "string" } @@ -1707,6 +1784,7 @@ }, "listLabels": { "description": "Lists the labels on a file.", + "flatPath": "files/{fileId}/listLabels", "httpMethod": "GET", "id": "drive.files.listLabels", "parameterOrder": [ @@ -1714,14 +1792,14 @@ ], "parameters": { "fileId": { - "description": "The ID of the file.", + "description": "The ID for the file or shared drive.", "location": "path", "required": true, "type": "string" }, "maxResults": { "default": "100", - "description": "The maximum number of labels to return per page. When not set, this defaults to 100.", + "description": "The maximum number of labels to return per page. When not set, defaults to 100.", "format": "int32", "location": "query", "maximum": "100", @@ -1729,7 +1807,7 @@ "type": "integer" }, "pageToken": { - "description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.", + "description": "The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.", "location": "query", "type": "string" } @@ -1747,7 +1825,8 @@ ] }, "modifyLabels": { - "description": "Modifies the set of labels on a file.", + "description": "Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.", + "flatPath": "files/{fileId}/modifyLabels", "httpMethod": "POST", "id": "drive.files.modifyLabels", "parameterOrder": [ @@ -1755,7 +1834,7 @@ ], "parameters": { "fileId": { - "description": "The ID of the file for which the labels are modified.", + "description": "The ID of the file to which the labels belong.", "location": "path", "required": true, "type": "string" @@ -1776,6 +1855,7 @@ }, "patch": { "description": "Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.", + "flatPath": "files/{fileId}", "httpMethod": "PATCH", "id": "drive.files.patch", "parameterOrder": [ @@ -1789,13 +1869,13 @@ }, "convert": { "default": "false", - "description": "This parameter is deprecated and has no function.", + "description": "Deprecated: This parameter has no function.", "location": "query", "type": "boolean" }, "enforceSingleParent": { "default": "false", - "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", + "description": "Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead.", "location": "query", "type": "boolean" }, @@ -1806,17 +1886,17 @@ "type": "string" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "modifiedDateBehavior": { - "description": "Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.", + "description": "Determines the behavior in which `modifiedDate` is updated. This overrides `setModifiedDate`.", "enum": [ "fromBody", "fromBodyIfNeeded", @@ -1826,19 +1906,19 @@ "nowIfNeeded" ], "enumDescriptions": [ - "Set modifiedDate to the value provided in the body of the request. No change if no value was provided.", - "Set modifiedDate to the value provided in the body of the request depending on other contents of the update.", + "Set `modifiedDate` to the value provided in the body of the request. No change if no value was provided.", + "Set `modifiedDate` to the value provided in the body of the request depending on other contents of the update.", "Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.", - "Maintain the previous value of modifiedDate.", - "Set modifiedDate to the current time.", - "Set modifiedDate to the current time depending on contents of the update." + "Maintain the previous value of `modifiedDate`.", + "Set `modifiedDate` to the current time.", + "Set `modifiedDate` to the current time depending on contents of the update." ], "location": "query", "type": "string" }, "newRevision": { "default": "true", - "description": "Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. Note that this field is ignored if there is no payload in the request.", + "description": "Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the [Drive Help Center](https://support.google.com/drive/answer/2409045). Note that this field is ignored if there is no payload in the request.", "location": "query", "type": "boolean" }, @@ -1866,7 +1946,7 @@ }, "setModifiedDate": { "default": "false", - "description": "Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.", + "description": "Whether to set the modified date using the value supplied in the request body. Setting this field to `true` is equivalent to `modifiedDateBehavior=fromBodyOrNow`, and `false` is equivalent to `modifiedDateBehavior=now`. To prevent any changes to the modified date set `modifiedDateBehavior=noChange`.", "location": "query", "type": "boolean" }, @@ -1878,7 +1958,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -1923,6 +2003,7 @@ }, "touch": { "description": "Set the file's updated time to the current server time.", + "flatPath": "files/{fileId}/touch", "httpMethod": "POST", "id": "drive.files.touch", "parameterOrder": [ @@ -1936,12 +2017,12 @@ "type": "string" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, @@ -1953,7 +2034,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" } @@ -1971,7 +2052,8 @@ ] }, "trash": { - "description": "Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.", + "description": " Moves a file to the trash. The currently authenticated user must own the file or be at least a `fileOrganizer` on the parent for shared drive files. Only the owner may trash a file. The trashed item is excluded from all `files.list` responses returned for any user who doesn't own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file. *Note:* Files moved to the trash still appear by default in results from the `files.list` method. To permanently remove a file, use `files.delete`.", + "flatPath": "files/{fileId}/trash", "httpMethod": "POST", "id": "drive.files.trash", "parameterOrder": [ @@ -1985,12 +2067,12 @@ "type": "string" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, @@ -2002,7 +2084,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" } @@ -2019,7 +2101,8 @@ ] }, "untrash": { - "description": "Restores a file from the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may untrash a file.", + "description": "Restores a file from the trash. The currently authenticated user must own the file or be at least a `fileOrganizer` on the parent for shared drive files. Only the owner may untrash a file.", + "flatPath": "files/{fileId}/untrash", "httpMethod": "POST", "id": "drive.files.untrash", "parameterOrder": [ @@ -2033,12 +2116,12 @@ "type": "string" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, @@ -2050,7 +2133,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" } @@ -2067,14 +2150,15 @@ ] }, "update": { - "description": "Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as modifiedDate. This method supports patch semantics.", + "description": " Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads).", + "flatPath": "files/{fileId}", "httpMethod": "PUT", "id": "drive.files.update", "mediaUpload": { "accept": [ "*/*" ], - "maxSize": "5120GB", + "maxSize": "5497558138880", "protocols": { "resumable": { "multipart": true, @@ -2097,13 +2181,13 @@ }, "convert": { "default": "false", - "description": "This parameter is deprecated and has no function.", + "description": "Deprecated: This parameter has no function.", "location": "query", "type": "boolean" }, "enforceSingleParent": { "default": "false", - "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", + "description": "Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead.", "location": "query", "type": "boolean" }, @@ -2114,17 +2198,17 @@ "type": "string" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "modifiedDateBehavior": { - "description": "Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.", + "description": "Determines the behavior in which `modifiedDate` is updated. This overrides `setModifiedDate`.", "enum": [ "fromBody", "fromBodyIfNeeded", @@ -2134,19 +2218,19 @@ "nowIfNeeded" ], "enumDescriptions": [ - "Set modifiedDate to the value provided in the body of the request. No change if no value was provided.", - "Set modifiedDate to the value provided in the body of the request depending on other contents of the update.", + "Set `modifiedDate` to the value provided in the body of the request. No change if no value was provided.", + "Set `modifiedDate` to the value provided in the body of the request depending on other contents of the update.", "Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.", - "Maintain the previous value of modifiedDate.", - "Set modifiedDate to the current time.", - "Set modifiedDate to the current time depending on contents of the update." + "Maintain the previous value of `modifiedDate`.", + "Set `modifiedDate` to the current time.", + "Set `modifiedDate` to the current time depending on contents of the update." ], "location": "query", "type": "string" }, "newRevision": { "default": "true", - "description": "Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. Note that this field is ignored if there is no payload in the request.", + "description": "Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the [Drive Help Center](https://support.google.com/drive/answer/2409045).", "location": "query", "type": "boolean" }, @@ -2163,7 +2247,7 @@ }, "pinned": { "default": "false", - "description": "Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. Note that this field is ignored if there is no payload in the request.", + "description": "Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.", "location": "query", "type": "boolean" }, @@ -2174,7 +2258,7 @@ }, "setModifiedDate": { "default": "false", - "description": "Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.", + "description": "Whether to set the modified date using the value supplied in the request body. Setting this field to `true` is equivalent to `modifiedDateBehavior=fromBodyOrNow`, and `false` is equivalent to `modifiedDateBehavior=now`. To prevent any changes to the modified date set `modifiedDateBehavior=noChange`.", "location": "query", "type": "boolean" }, @@ -2186,7 +2270,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -2231,7 +2315,8 @@ "supportsMediaUpload": true }, "watch": { - "description": "Subscribe to changes on a file.", + "description": "Subscribes to changes to a file.", + "flatPath": "files/{fileId}/watch", "httpMethod": "POST", "id": "drive.files.watch", "parameterOrder": [ @@ -2251,24 +2336,24 @@ "type": "string" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "projection": { - "description": "This parameter is deprecated and has no function.", + "description": "Deprecated: This parameter has no function.", "enum": [ "BASIC", "FULL" ], "enumDescriptions": [ - "Deprecated", - "Deprecated" + "Deprecated.", + "Deprecated." ], "location": "query", "type": "string" @@ -2286,7 +2371,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -2314,9 +2399,7 @@ "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], - "supportsMediaDownload": true, - "supportsSubscription": true, - "useMediaDownloadService": true + "supportsSubscription": true } } }, @@ -2324,6 +2407,7 @@ "methods": { "delete": { "description": "Removes a parent from a file.", + "flatPath": "files/{fileId}/parents/{parentId}", "httpMethod": "DELETE", "id": "drive.parents.delete", "parameterOrder": [ @@ -2333,7 +2417,7 @@ "parameters": { "enforceSingleParent": { "default": "false", - "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.", + "description": "Deprecated: If an item is not in a shared drive and its last parent is removed, the item is placed under its owner's root.", "location": "query", "type": "boolean" }, @@ -2358,6 +2442,7 @@ }, "get": { "description": "Gets a specific parent reference.", + "flatPath": "files/{fileId}/parents/{parentId}", "httpMethod": "GET", "id": "drive.parents.get", "parameterOrder": [ @@ -2394,6 +2479,7 @@ }, "insert": { "description": "Adds a parent folder for a file.", + "flatPath": "files/{fileId}/parents", "httpMethod": "POST", "id": "drive.parents.insert", "parameterOrder": [ @@ -2402,7 +2488,7 @@ "parameters": { "enforceSingleParent": { "default": "false", - "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", + "description": "Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead.", "location": "query", "type": "boolean" }, @@ -2420,7 +2506,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" } @@ -2440,6 +2526,7 @@ }, "list": { "description": "Lists a file's parents.", + "flatPath": "files/{fileId}/parents", "httpMethod": "GET", "id": "drive.parents.list", "parameterOrder": [ @@ -2472,7 +2559,8 @@ "permissions": { "methods": { "delete": { - "description": "Deletes a permission from a file or shared drive.", + "description": "Deletes a permission from a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + "flatPath": "files/{fileId}/permissions/{permissionId}", "httpMethod": "DELETE", "id": "drive.permissions.delete", "parameterOrder": [ @@ -2500,7 +2588,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -2519,6 +2607,7 @@ }, "get": { "description": "Gets a permission by ID.", + "flatPath": "files/{fileId}/permissions/{permissionId}", "httpMethod": "GET", "id": "drive.permissions.get", "parameterOrder": [ @@ -2546,7 +2635,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -2572,6 +2661,7 @@ }, "getIdForEmail": { "description": "Returns the permission ID for an email address.", + "flatPath": "permissionIds/{email}", "httpMethod": "GET", "id": "drive.permissions.getIdForEmail", "parameterOrder": [ @@ -2601,7 +2691,8 @@ ] }, "insert": { - "description": "Inserts a permission for a file or shared drive.", + "description": "Inserts a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + "flatPath": "files/{fileId}/permissions", "httpMethod": "POST", "id": "drive.permissions.insert", "parameterOrder": [ @@ -2615,7 +2706,7 @@ }, "enforceSingleParent": { "default": "false", - "description": "Deprecated. See moveToNewOwnersRoot for details.", + "description": "Deprecated: See `moveToNewOwnersRoot` for details.", "location": "query", "type": "boolean" }, @@ -2627,13 +2718,13 @@ }, "moveToNewOwnersRoot": { "default": "false", - "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.", + "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" }, "sendNotificationEmails": { "default": "true", - "description": "Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner.", + "description": "Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the `role` is `owner`.", "location": "query", "type": "boolean" }, @@ -2645,7 +2736,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -2670,6 +2761,7 @@ }, "list": { "description": "Lists a file's or shared drive's permissions.", + "flatPath": "files/{fileId}/permissions", "httpMethod": "GET", "id": "drive.permissions.list", "parameterOrder": [ @@ -2683,7 +2775,7 @@ "type": "string" }, "includePermissionsForView": { - "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, @@ -2696,7 +2788,7 @@ "type": "integer" }, "pageToken": { - "description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.", + "description": "The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.", "location": "query", "type": "string" }, @@ -2708,7 +2800,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -2733,7 +2825,8 @@ ] }, "patch": { - "description": "Updates a permission using patch semantics.", + "description": "Updates a permission using patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + "flatPath": "files/{fileId}/permissions/{permissionId}", "httpMethod": "PATCH", "id": "drive.permissions.patch", "parameterOrder": [ @@ -2767,13 +2860,13 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "transferOwnership": { "default": "false", - "description": "Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.", + "description": "Whether changing a role to `owner` downgrades the current owners to writers. Does nothing if the specified role is not `owner`.", "location": "query", "type": "boolean" }, @@ -2797,7 +2890,8 @@ ] }, "update": { - "description": "Updates a permission.", + "description": "Updates a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + "flatPath": "files/{fileId}/permissions/{permissionId}", "httpMethod": "PUT", "id": "drive.permissions.update", "parameterOrder": [ @@ -2831,13 +2925,13 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "transferOwnership": { "default": "false", - "description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them.", + "description": "Whether changing a role to `owner` downgrades the current owners to writers. Does nothing if the specified role is not `owner`.", "location": "query", "type": "boolean" }, @@ -2866,6 +2960,7 @@ "methods": { "delete": { "description": "Deletes a property.", + "flatPath": "files/{fileId}/properties/{propertyKey}", "httpMethod": "DELETE", "id": "drive.properties.delete", "parameterOrder": [ @@ -2902,6 +2997,7 @@ }, "get": { "description": "Gets a property by its key.", + "flatPath": "files/{fileId}/properties/{propertyKey}", "httpMethod": "GET", "id": "drive.properties.get", "parameterOrder": [ @@ -2944,6 +3040,7 @@ }, "insert": { "description": "Adds a property to a file, or updates it if it already exists.", + "flatPath": "files/{fileId}/properties", "httpMethod": "POST", "id": "drive.properties.insert", "parameterOrder": [ @@ -2973,6 +3070,7 @@ }, "list": { "description": "Lists a file's properties.", + "flatPath": "files/{fileId}/properties", "httpMethod": "GET", "id": "drive.properties.list", "parameterOrder": [ @@ -3002,6 +3100,7 @@ }, "patch": { "description": "Updates a property.", + "flatPath": "files/{fileId}/properties/{propertyKey}", "httpMethod": "PATCH", "id": "drive.properties.patch", "parameterOrder": [ @@ -3044,6 +3143,7 @@ }, "update": { "description": "Updates a property.", + "flatPath": "files/{fileId}/properties/{propertyKey}", "httpMethod": "PUT", "id": "drive.properties.update", "parameterOrder": [ @@ -3090,6 +3190,7 @@ "methods": { "delete": { "description": "Deletes a reply.", + "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", "httpMethod": "DELETE", "id": "drive.replies.delete", "parameterOrder": [ @@ -3125,6 +3226,7 @@ }, "get": { "description": "Gets a reply.", + "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", "httpMethod": "GET", "id": "drive.replies.get", "parameterOrder": [ @@ -3170,6 +3272,7 @@ }, "insert": { "description": "Creates a new reply to the given comment.", + "flatPath": "files/{fileId}/comments/{commentId}/replies", "httpMethod": "POST", "id": "drive.replies.insert", "parameterOrder": [ @@ -3204,6 +3307,7 @@ }, "list": { "description": "Lists all of the replies to a comment.", + "flatPath": "files/{fileId}/comments/{commentId}/replies", "httpMethod": "GET", "id": "drive.replies.list", "parameterOrder": [ @@ -3256,6 +3360,7 @@ }, "patch": { "description": "Updates an existing reply.", + "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", "httpMethod": "PATCH", "id": "drive.replies.patch", "parameterOrder": [ @@ -3297,6 +3402,7 @@ }, "update": { "description": "Updates an existing reply.", + "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", "httpMethod": "PUT", "id": "drive.replies.update", "parameterOrder": [ @@ -3342,6 +3448,7 @@ "methods": { "delete": { "description": "Permanently deletes a file version. You can only delete revisions for files with binary content, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.", + "flatPath": "files/{fileId}/revisions/{revisionId}", "httpMethod": "DELETE", "id": "drive.revisions.delete", "parameterOrder": [ @@ -3371,6 +3478,7 @@ }, "get": { "description": "Gets a specific revision.", + "flatPath": "files/{fileId}/revisions/{revisionId}", "httpMethod": "GET", "id": "drive.revisions.get", "parameterOrder": [ @@ -3407,6 +3515,7 @@ }, "list": { "description": "Lists a file's revisions.", + "flatPath": "files/{fileId}/revisions", "httpMethod": "GET", "id": "drive.revisions.list", "parameterOrder": [ @@ -3450,6 +3559,7 @@ }, "patch": { "description": "Updates a revision.", + "flatPath": "files/{fileId}/revisions/{revisionId}", "httpMethod": "PATCH", "id": "drive.revisions.patch", "parameterOrder": [ @@ -3485,6 +3595,7 @@ }, "update": { "description": "Updates a revision.", + "flatPath": "files/{fileId}/revisions/{revisionId}", "httpMethod": "PUT", "id": "drive.revisions.update", "parameterOrder": [ @@ -3523,7 +3634,8 @@ "teamdrives": { "methods": { "delete": { - "description": "Deprecated use drives.delete instead.", + "description": "Deprecated: Use `drives.delete` instead.", + "flatPath": "teamdrives/{teamDriveId}", "httpMethod": "DELETE", "id": "drive.teamdrives.delete", "parameterOrder": [ @@ -3543,7 +3655,8 @@ ] }, "get": { - "description": "Deprecated use drives.get instead.", + "description": "Deprecated: Use `drives.get` instead.", + "flatPath": "teamdrives/{teamDriveId}", "httpMethod": "GET", "id": "drive.teamdrives.get", "parameterOrder": [ @@ -3573,7 +3686,8 @@ ] }, "insert": { - "description": "Deprecated use drives.insert instead.", + "description": "Deprecated: Use `drives.insert` instead.", + "flatPath": "teamdrives", "httpMethod": "POST", "id": "drive.teamdrives.insert", "parameterOrder": [ @@ -3581,7 +3695,7 @@ ], "parameters": { "requestId": { - "description": "An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.", + "description": "Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.", "location": "query", "required": true, "type": "string" @@ -3599,9 +3713,11 @@ ] }, "list": { - "description": "Deprecated use drives.list instead.", + "description": "Deprecated: Use `drives.list` instead.", + "flatPath": "teamdrives", "httpMethod": "GET", "id": "drive.teamdrives.list", + "parameterOrder": [], "parameters": { "maxResults": { "default": "10", @@ -3639,7 +3755,8 @@ ] }, "update": { - "description": "Deprecated use drives.update instead.", + "description": "Deprecated: Use `drives.update` instead.", + "flatPath": "teamdrives/{teamDriveId}", "httpMethod": "PUT", "id": "drive.teamdrives.update", "parameterOrder": [ @@ -3673,7 +3790,7 @@ } } }, - "revision": "20230423", + "revision": "20230517", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -3718,11 +3835,11 @@ "type": "boolean" }, "canCreateTeamDrives": { - "description": "Deprecated - use canCreateDrives instead.", + "description": "Deprecated: Use `canCreateDrives` instead.", "type": "boolean" }, "domainSharingPolicy": { - "description": "The domain sharing policy for the current user. Possible values are: \n- allowed \n- allowedWithWarning \n- incomingOnly \n- disallowed", + "description": "The domain sharing policy for the current user. Possible values are: * `allowed` * `allowedWithWarning` * `incomingOnly` * `disallowed`", "type": "string" }, "driveThemes": { @@ -3821,7 +3938,7 @@ }, "kind": { "default": "drive#about", - "description": "This is always drive#about.", + "description": "This is always `drive#about`.", "type": "string" }, "languageCode": { @@ -3898,7 +4015,7 @@ "type": "string" }, "quotaType": { - "description": "The type of the user's storage quota. Possible values are: \n- LIMITED \n- UNLIMITED", + "description": "The type of the user's storage quota. Possible values are: * `LIMITED` * `UNLIMITED`", "type": "string" }, "remainingChangeIds": { @@ -3915,19 +4032,19 @@ "type": "string" }, "teamDriveThemes": { - "description": "Deprecated - use driveThemes instead.", + "description": "Deprecated: Use `driveThemes` instead.", "items": { "properties": { "backgroundImageLink": { - "description": "Deprecated - use driveThemes/backgroundImageLink instead.", + "description": "Deprecated: Use `driveThemes/backgroundImageLink` instead.", "type": "string" }, "colorRgb": { - "description": "Deprecated - use driveThemes/colorRgb instead.", + "description": "Deprecated: Use `driveThemes/colorRgb` instead.", "type": "string" }, "id": { - "description": "Deprecated - use driveThemes/id instead.", + "description": "Deprecated: Use `driveThemes/id` instead.", "type": "string" } }, @@ -3967,7 +4084,7 @@ "items": { "properties": { "category": { - "description": "Category of the icon. Allowed values are: \n- application - icon for the application \n- document - icon for a file associated with the app \n- documentShared - icon for a shared file associated with the app", + "description": "Category of the icon. Allowed values are: * `application` - icon for the application * `document` - icon for a file associated with the app * `documentShared` - icon for a shared file associated with the app", "type": "string" }, "iconUrl": { @@ -3994,7 +4111,7 @@ }, "kind": { "default": "drive#app", - "description": "This is always drive#app.", + "description": "This is always `drive#app`.", "type": "string" }, "longDescription": { @@ -4010,7 +4127,7 @@ "type": "string" }, "openUrlTemplate": { - "description": "The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids. See Open Files for the full documentation.", + "description": "The template url for opening files with this app. The template will contain `{ids}` and/or `{exportIds}` to be replaced by the actual file ids. See Open Files for the full documentation.", "type": "string" }, "primaryFileExtensions": { @@ -4100,7 +4217,7 @@ }, "kind": { "default": "drive#appList", - "description": "This is always drive#appList.", + "description": "This is always `drive#appList`.", "type": "string" }, "selfLink": { @@ -4115,7 +4232,7 @@ "id": "Change", "properties": { "changeType": { - "description": "The type of the change. Possible values are file and drive.", + "description": "The type of the change. Possible values are `file` and `drive`.", "type": "string" }, "deleted": { @@ -4145,7 +4262,7 @@ }, "kind": { "default": "drive#change", - "description": "This is always drive#change.", + "description": "This is always `drive#change`.", "type": "string" }, "modificationDate": { @@ -4159,14 +4276,14 @@ }, "teamDrive": { "$ref": "TeamDrive", - "description": "Deprecated - use drive instead." + "description": "Deprecated: Use `drive` instead." }, "teamDriveId": { - "description": "Deprecated - use driveId instead.", + "description": "Deprecated: Use `driveId` instead.", "type": "string" }, "type": { - "description": "Deprecated - use changeType instead.", + "description": "Deprecated: Use `changeType` instead.", "type": "string" } }, @@ -4189,7 +4306,7 @@ }, "kind": { "default": "drive#changeList", - "description": "This is always drive#changeList.", + "description": "This is always `drive#changeList`.", "type": "string" }, "largestChangeId": { @@ -4217,7 +4334,7 @@ "type": "object" }, "Channel": { - "description": "An notification channel used to watch for resource changes.", + "description": "A notification channel used to watch for resource changes.", "id": "Channel", "properties": { "address": { @@ -4235,12 +4352,11 @@ }, "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": { "additionalProperties": { - "description": "Declares a new parameter by name.", "type": "string" }, "description": "Additional parameters controlling delivery channel behavior. Optional.", @@ -4263,7 +4379,7 @@ "type": "string" }, "type": { - "description": "The type of delivery mechanism used for this channel. Valid values are \"web_hook\" (or \"webhook\"). Both values refer to a channel where Http requests are used to deliver messages.", + "description": "The type of delivery mechanism used for this channel.", "type": "string" } }, @@ -4286,7 +4402,7 @@ }, "kind": { "default": "drive#childList", - "description": "This is always drive#childList.", + "description": "This is always `drive#childList`.", "type": "string" }, "nextLink": { @@ -4309,7 +4425,7 @@ "id": "ChildReference", "properties": { "childLink": { - "description": "A link to the child.", + "description": "Output only. A link to the child.", "type": "string" }, "id": { @@ -4323,11 +4439,11 @@ }, "kind": { "default": "drive#childReference", - "description": "This is always drive#childReference.", + "description": "Output only. This is always `drive#childReference`.", "type": "string" }, "selfLink": { - "description": "A link back to this reference.", + "description": "Output only. A link back to this reference.", "type": "string" } }, @@ -4338,15 +4454,15 @@ "id": "Comment", "properties": { "anchor": { - "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies.", + "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/drive/api/v2/manage-comments).", "type": "string" }, "author": { "$ref": "User", - "description": "The author of the comment. The author's email address and permission ID will not be populated." + "description": "Output only. The author of the comment. The author's email address and permission ID will not be populated." }, "commentId": { - "description": "The ID of the comment.", + "description": "Output only. The ID of the comment.", "type": "string" }, "content": { @@ -4380,24 +4496,24 @@ "type": "string" }, "deleted": { - "description": "Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.", + "description": "Output only. Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.", "type": "boolean" }, "fileId": { - "description": "The file which this comment is addressing.", + "description": "Output only. The file which this comment is addressing.", "type": "string" }, "fileTitle": { - "description": "The title of the file which this comment is addressing.", + "description": "Output only. The title of the file which this comment is addressing.", "type": "string" }, "htmlContent": { - "description": "HTML formatted content for this comment.", + "description": "Output only. HTML formatted content for this comment.", "type": "string" }, "kind": { "default": "drive#comment", - "description": "This is always drive#comment.", + "description": "Output only. This is always `drive#comment`.", "type": "string" }, "modifiedDate": { @@ -4406,18 +4522,18 @@ "type": "string" }, "replies": { - "description": "Replies to this post.", + "description": "Output only. Replies to this post.", "items": { "$ref": "CommentReply" }, "type": "array" }, "selfLink": { - "description": "A link back to this comment.", + "description": "Output only. A link back to this comment.", "type": "string" }, "status": { - "description": "The status of this comment. Status can be changed by posting a reply to a comment with the desired status. \n- \"open\" - The comment is still open. \n- \"resolved\" - The comment has been resolved by one of its replies.", + "description": "Output only. The status of this comment. Status can be changed by posting a reply to a comment with the desired status. * `open` - The comment is still open. * `resolved` - The comment has been resolved by one of its replies.", "type": "string" } }, @@ -4436,7 +4552,7 @@ }, "kind": { "default": "drive#commentList", - "description": "This is always drive#commentList.", + "description": "This is always `drive#commentList`.", "type": "string" }, "nextLink": { @@ -4460,7 +4576,7 @@ "properties": { "author": { "$ref": "User", - "description": "The author of the reply. The author's email address and permission ID will not be populated." + "description": "Output only. The author of the reply. The author's email address and permission ID will not be populated." }, "content": { "annotations": { @@ -4478,16 +4594,16 @@ "type": "string" }, "deleted": { - "description": "Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.", + "description": "Output only. Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.", "type": "boolean" }, "htmlContent": { - "description": "HTML formatted content for this reply.", + "description": "Output only. HTML formatted content for this reply.", "type": "string" }, "kind": { "default": "drive#commentReply", - "description": "This is always drive#commentReply.", + "description": "Output only. This is always `drive#commentReply`.", "type": "string" }, "modifiedDate": { @@ -4496,11 +4612,11 @@ "type": "string" }, "replyId": { - "description": "The ID of the reply.", + "description": "Output only. The ID of the reply.", "type": "string" }, "verb": { - "description": "The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: \n- \"resolve\" - To resolve a comment. \n- \"reopen\" - To reopen (un-resolve) a comment.", + "description": "The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: * `resolve` - To resolve a comment. * `reopen` - To reopen (un-resolve) a comment.", "type": "string" } }, @@ -4519,7 +4635,7 @@ }, "kind": { "default": "drive#commentReplyList", - "description": "This is always drive#commentReplyList.", + "description": "This is always `drive#commentReplyList`.", "type": "string" }, "nextLink": { @@ -4546,12 +4662,12 @@ "type": "boolean" }, "reason": { - "description": "Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.", + "description": "Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.", "type": "string" }, "restrictingUser": { "$ref": "User", - "description": "The user who set the content restriction. Only populated if readOnly is true." + "description": "Output only. The user who set the content restriction. Only populated if `readOnly` is true." }, "restrictionDate": { "description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.", @@ -4559,7 +4675,7 @@ "type": "string" }, "type": { - "description": "The type of the content restriction. Currently the only possible value is globalContentRestriction.", + "description": "Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.", "type": "string" } }, @@ -4570,7 +4686,7 @@ "id": "Drive", "properties": { "backgroundImageFile": { - "description": "An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.", + "description": "An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.", "properties": { "id": { "description": "The ID of an image file in Google Drive to use for the background image.", @@ -4595,97 +4711,97 @@ "type": "object" }, "backgroundImageLink": { - "description": "A short-lived link to this shared drive's background image.", + "description": "Output only. A short-lived link to this shared drive's background image.", "type": "string" }, "capabilities": { - "description": "Capabilities the current user has on this shared drive.", + "description": "Output only. Capabilities the current user has on this shared drive.", "properties": { "canAddChildren": { - "description": "Whether the current user can add children to folders in this shared drive.", + "description": "Output only. Whether the current user can add children to folders in this shared drive.", "type": "boolean" }, "canChangeCopyRequiresWriterPermissionRestriction": { - "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.", + "description": "Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.", "type": "boolean" }, "canChangeDomainUsersOnlyRestriction": { - "description": "Whether the current user can change the domainUsersOnly restriction of this shared drive.", + "description": "Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.", "type": "boolean" }, "canChangeDriveBackground": { - "description": "Whether the current user can change the background of this shared drive.", + "description": "Output only. Whether the current user can change the background of this shared drive.", "type": "boolean" }, "canChangeDriveMembersOnlyRestriction": { - "description": "Whether the current user can change the driveMembersOnly restriction of this shared drive.", + "description": "Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.", "type": "boolean" }, "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": { - "description": "Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this shared drive.", + "description": "Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.", "type": "boolean" }, "canComment": { - "description": "Whether the current user can comment on files in this shared drive.", + "description": "Output only. Whether the current user can comment on files in this shared drive.", "type": "boolean" }, "canCopy": { - "description": "Whether the current user can copy files in this shared drive.", + "description": "Output only. Whether the current user can copy files in this shared drive.", "type": "boolean" }, "canDeleteChildren": { - "description": "Whether the current user can delete children from folders in this shared drive.", + "description": "Output only. Whether the current user can delete children from folders in this shared drive.", "type": "boolean" }, "canDeleteDrive": { - "description": "Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.", + "description": "Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.", "type": "boolean" }, "canDownload": { - "description": "Whether the current user can download files in this shared drive.", + "description": "Output only. Whether the current user can download files in this shared drive.", "type": "boolean" }, "canEdit": { - "description": "Whether the current user can edit files in this shared drive", + "description": "Output only. Whether the current user can edit files in this shared drive", "type": "boolean" }, "canListChildren": { - "description": "Whether the current user can list the children of folders in this shared drive.", + "description": "Output only. Whether the current user can list the children of folders in this shared drive.", "type": "boolean" }, "canManageMembers": { - "description": "Whether the current user can add members to this shared drive or remove them or change their role.", + "description": "Output only. Whether the current user can add members to this shared drive or remove them or change their role.", "type": "boolean" }, "canReadRevisions": { - "description": "Whether the current user can read the revisions resource of files in this shared drive.", + "description": "Output only. Whether the current user can read the revisions resource of files in this shared drive.", "type": "boolean" }, "canRename": { - "description": "Whether the current user can rename files or folders in this shared drive.", + "description": "Output only. Whether the current user can rename files or folders in this shared drive.", "type": "boolean" }, "canRenameDrive": { - "description": "Whether the current user can rename this shared drive.", + "description": "Output only. Whether the current user can rename this shared drive.", "type": "boolean" }, "canResetDriveRestrictions": { - "description": "Whether the current user can reset the shared drive restrictions to defaults.", + "description": "Output only. Whether the current user can reset the shared drive restrictions to defaults.", "type": "boolean" }, "canShare": { - "description": "Whether the current user can share files or folders in this shared drive.", + "description": "Output only. Whether the current user can share files or folders in this shared drive.", "type": "boolean" }, "canTrashChildren": { - "description": "Whether the current user can trash children from folders in this shared drive.", + "description": "Output only. Whether the current user can trash children from folders in this shared drive.", "type": "boolean" } }, "type": "object" }, "colorRgb": { - "description": "The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId.", + "description": "The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.", "type": "string" }, "createdDate": { @@ -4698,12 +4814,12 @@ "type": "boolean" }, "id": { - "description": "The ID of this shared drive which is also the ID of the top level folder of this shared drive.", + "description": "Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.", "type": "string" }, "kind": { "default": "drive#drive", - "description": "This is always drive#drive", + "description": "Output only. This is always `drive#drive`", "type": "string" }, "name": { @@ -4716,7 +4832,7 @@ "type": "string" }, "orgUnitId": { - "description": "The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true.", + "description": "Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.", "type": "string" }, "restrictions": { @@ -4727,7 +4843,7 @@ "type": "boolean" }, "copyRequiresWriterPermission": { - "description": "Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this shared drive.", + "description": "Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this shared drive.", "type": "boolean" }, "domainUsersOnly": { @@ -4746,7 +4862,7 @@ "type": "object" }, "themeId": { - "description": "The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.insert request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.", + "description": "The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.insert` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.", "type": "string" } }, @@ -4765,7 +4881,7 @@ }, "kind": { "default": "drive#driveList", - "description": "This is always drive#driveList", + "description": "This is always `drive#driveList`", "type": "string" }, "nextPageToken": { @@ -4780,174 +4896,174 @@ "id": "File", "properties": { "alternateLink": { - "description": "A link for opening the file in a relevant Google editor or viewer.", + "description": "Output only. A link for opening the file in a relevant Google editor or viewer.", "type": "string" }, "appDataContents": { - "description": "Whether this file is in the Application Data folder.", + "description": "Output only. Whether this file is in the Application Data folder.", "type": "boolean" }, "canComment": { - "description": "Deprecated: use capabilities/canComment.", + "description": "Output only. Deprecated: Use `capabilities/canComment` instead.", "type": "boolean" }, "canReadRevisions": { - "description": "Deprecated: use capabilities/canReadRevisions.", + "description": "Output only. Deprecated: Use `capabilities/canReadRevisions` instead.", "type": "boolean" }, "capabilities": { - "description": "Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.", + "description": "Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.", "properties": { "canAcceptOwnership": { - "description": "Whether the current user is the pending owner of the file. Not populated for shared drive files.", + "description": "Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.", "type": "boolean" }, "canAddChildren": { - "description": "Whether the current user can add children to this folder. This is always false when the item is not a folder.", + "description": "Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder.", "type": "boolean" }, "canAddFolderFromAnotherDrive": { - "description": "Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.", + "description": "Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canAddMyDriveParent": { - "description": "Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.", + "description": "Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.", "type": "boolean" }, "canChangeCopyRequiresWriterPermission": { - "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this file.", + "description": "Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.", "type": "boolean" }, "canChangeRestrictedDownload": { - "description": "Deprecated", + "description": "Output only. Deprecated.", "type": "boolean" }, "canChangeSecurityUpdateEnabled": { - "description": "Whether the current user can change the securityUpdateEnabled field on link share metadata.", + "description": "Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.", "type": "boolean" }, "canComment": { - "description": "Whether the current user can comment on this file.", + "description": "Output only. Whether the current user can comment on this file.", "type": "boolean" }, "canCopy": { - "description": "Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.", + "description": "Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.", "type": "boolean" }, "canDelete": { - "description": "Whether the current user can delete this file.", + "description": "Output only. Whether the current user can delete this file.", "type": "boolean" }, "canDeleteChildren": { - "description": "Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", + "description": "Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canDownload": { - "description": "Whether the current user can download this file.", + "description": "Output only. Whether the current user can download this file.", "type": "boolean" }, "canEdit": { - "description": "Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.", + "description": "Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.", "type": "boolean" }, "canListChildren": { - "description": "Whether the current user can list the children of this folder. This is always false when the item is not a folder.", + "description": "Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.", "type": "boolean" }, "canModifyContent": { - "description": "Whether the current user can modify the content of this file.", + "description": "Output only. Whether the current user can modify the content of this file.", "type": "boolean" }, "canModifyContentRestriction": { - "description": "Whether the current user can modify restrictions on content of this file.", + "description": "Output only. Whether the current user can modify restrictions on content of this file.", "type": "boolean" }, "canModifyLabels": { - "description": "Whether the current user can modify the labels on this file.", + "description": "Output only. Whether the current user can modify the labels on the file.", "type": "boolean" }, "canMoveChildrenOutOfDrive": { - "description": "Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.", + "description": "Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canMoveChildrenOutOfTeamDrive": { - "description": "Deprecated - use canMoveChildrenOutOfDrive instead.", + "description": "Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead.", "type": "boolean" }, "canMoveChildrenWithinDrive": { - "description": "Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.", + "description": "Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.", "type": "boolean" }, "canMoveChildrenWithinTeamDrive": { - "description": "Deprecated - use canMoveChildrenWithinDrive instead.", + "description": "Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.", "type": "boolean" }, "canMoveItemIntoTeamDrive": { - "description": "Deprecated - use canMoveItemOutOfDrive instead.", + "description": "Output only. Deprecated: Use `canMoveItemOutOfDrive` instead.", "type": "boolean" }, "canMoveItemOutOfDrive": { - "description": "Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.", + "description": "Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.", "type": "boolean" }, "canMoveItemOutOfTeamDrive": { - "description": "Deprecated - use canMoveItemOutOfDrive instead.", + "description": "Output only. Deprecated: Use `canMoveItemOutOfDrive` instead.", "type": "boolean" }, "canMoveItemWithinDrive": { - "description": "Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.", + "description": "Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.", "type": "boolean" }, "canMoveItemWithinTeamDrive": { - "description": "Deprecated - use canMoveItemWithinDrive instead.", + "description": "Output only. Deprecated: Use `canMoveItemWithinDrive` instead.", "type": "boolean" }, "canMoveTeamDriveItem": { - "description": "Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.", + "description": "Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.", "type": "boolean" }, "canReadDrive": { - "description": "Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.", + "description": "Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.", "type": "boolean" }, "canReadLabels": { - "description": "Whether the current user can read the labels on this file.", + "description": "Output only. Whether the current user can read the labels on the file.", "type": "boolean" }, "canReadRevisions": { - "description": "Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it isn't a folder, can be read.", + "description": "Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.", "type": "boolean" }, "canReadTeamDrive": { - "description": "Deprecated - use canReadDrive instead.", + "description": "Output only. Deprecated: Use `canReadDrive` instead.", "type": "boolean" }, "canRemoveChildren": { - "description": "Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.", + "description": "Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.", "type": "boolean" }, "canRemoveMyDriveParent": { - "description": "Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.", + "description": "Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.", "type": "boolean" }, "canRename": { - "description": "Whether the current user can rename this file.", + "description": "Output only. Whether the current user can rename this file.", "type": "boolean" }, "canShare": { - "description": "Whether the current user can modify the sharing settings for this file.", + "description": "Output only. Whether the current user can modify the sharing settings for this file.", "type": "boolean" }, "canTrash": { - "description": "Whether the current user can move this file to trash.", + "description": "Output only. Whether the current user can move this file to trash.", "type": "boolean" }, "canTrashChildren": { - "description": "Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", + "description": "Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canUntrash": { - "description": "Whether the current user can restore this file from trash.", + "description": "Output only. Whether the current user can restore this file from trash.", "type": "boolean" } }, @@ -4965,7 +5081,7 @@ "type": "boolean" }, "copyable": { - "description": "Deprecated: use capabilities/canCopy.", + "description": "Output only. Deprecated: Use `capabilities/canCopy` instead.", "type": "boolean" }, "createdDate": { @@ -4974,7 +5090,7 @@ "type": "string" }, "defaultOpenWithLink": { - "description": "A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.", + "description": "Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.", "type": "string" }, "description": { @@ -4982,44 +5098,43 @@ "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 isn't populated for Docs Editors or shortcut files.", + "description": "Output only. 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.", "type": "string" }, "driveId": { - "description": "ID of the shared drive the file resides in. Only populated for items in shared drives.", + "description": "Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.", "type": "string" }, "editable": { - "description": "Deprecated: use capabilities/canEdit.", + "description": "Output only. Deprecated: Use `capabilities/canEdit` instead.", "type": "boolean" }, "embedLink": { - "description": "A link for embedding the file.", + "description": "Output only. A link for embedding the file.", "type": "string" }, "etag": { - "description": "ETag of the file.", + "description": "Output only. ETag of the file.", "type": "string" }, "explicitlyTrashed": { - "description": "Whether this file has been explicitly trashed, as opposed to recursively trashed.", + "description": "Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.", "type": "boolean" }, "exportLinks": { "additionalProperties": { - "description": "A mapping from export format to URL", "type": "string" }, - "description": "Links for exporting Docs Editors files to specific formats.", + "description": "Output only. Links for exporting Docs Editors files to specific formats.", "readOnly": true, "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 isn't populated for Docs Editors or shortcut files.", + "description": "Output only. 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's content in bytes. This field is populated for files with binary content stored in Google Drive and for Docs Editors files; it is not populated for shortcuts or folders.", + "description": "Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.", "format": "int64", "type": "string" }, @@ -5028,23 +5143,23 @@ "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 isn't populated for Docs Editors or shortcut files.", + "description": "Output only. 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": { - "description": "Whether there are permissions directly on this file. This field is only populated for items in shared drives.", + "description": "Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.", "type": "boolean" }, "hasThumbnail": { - "description": "Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.", + "description": "Output only. Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.", "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 isn't populated for Docs Editors or shortcut files.", + "description": "Output only. 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": { - "description": "A link to the file's icon.", + "description": "Output only. A link to the file's icon.", "type": "string" }, "id": { @@ -5052,81 +5167,81 @@ "type": "string" }, "imageMediaMetadata": { - "description": "Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.", + "description": "Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.", "properties": { "aperture": { - "description": "The aperture used to create the photo (f-number).", + "description": "Output only. The aperture used to create the photo (f-number).", "format": "float", "type": "number" }, "cameraMake": { - "description": "The make of the camera used to create the photo.", + "description": "Output only. The make of the camera used to create the photo.", "type": "string" }, "cameraModel": { - "description": "The model of the camera used to create the photo.", + "description": "Output only. The model of the camera used to create the photo.", "type": "string" }, "colorSpace": { - "description": "The color space of the photo.", + "description": "Output only. The color space of the photo.", "type": "string" }, "date": { - "description": "The date and time the photo was taken (EXIF format timestamp).", + "description": "Output only. The date and time the photo was taken (EXIF format timestamp).", "type": "string" }, "exposureBias": { - "description": "The exposure bias of the photo (APEX value).", + "description": "Output only. The exposure bias of the photo (APEX value).", "format": "float", "type": "number" }, "exposureMode": { - "description": "The exposure mode used to create the photo.", + "description": "Output only. The exposure mode used to create the photo.", "type": "string" }, "exposureTime": { - "description": "The length of the exposure, in seconds.", + "description": "Output only. The length of the exposure, in seconds.", "format": "float", "type": "number" }, "flashUsed": { - "description": "Whether a flash was used to create the photo.", + "description": "Output only. Whether a flash was used to create the photo.", "type": "boolean" }, "focalLength": { - "description": "The focal length used to create the photo, in millimeters.", + "description": "Output only. The focal length used to create the photo, in millimeters.", "format": "float", "type": "number" }, "height": { - "description": "The height of the image in pixels.", + "description": "Output only. The height of the image in pixels.", "format": "int32", "type": "integer" }, "isoSpeed": { - "description": "The ISO speed used to create the photo.", + "description": "Output only. The ISO speed used to create the photo.", "format": "int32", "type": "integer" }, "lens": { - "description": "The lens used to create the photo.", + "description": "Output only. The lens used to create the photo.", "type": "string" }, "location": { - "description": "Geographic location information stored in the image.", + "description": "Output only. Geographic location information stored in the image.", "properties": { "altitude": { - "description": "The altitude stored in the image.", + "description": "Output only. The altitude stored in the image.", "format": "double", "type": "number" }, "latitude": { - "description": "The latitude stored in the image.", + "description": "Output only. The latitude stored in the image.", "format": "double", "type": "number" }, "longitude": { - "description": "The longitude stored in the image.", + "description": "Output only. The longitude stored in the image.", "format": "double", "type": "number" } @@ -5134,34 +5249,34 @@ "type": "object" }, "maxApertureValue": { - "description": "The smallest f-number of the lens at the focal length used to create the photo (APEX value).", + "description": "Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).", "format": "float", "type": "number" }, "meteringMode": { - "description": "The metering mode used to create the photo.", + "description": "Output only. The metering mode used to create the photo.", "type": "string" }, "rotation": { - "description": "The number of clockwise 90 degree rotations applied from the image's original orientation.", + "description": "Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.", "format": "int32", "type": "integer" }, "sensor": { - "description": "The type of sensor used to create the photo.", + "description": "Output only. The type of sensor used to create the photo.", "type": "string" }, "subjectDistance": { - "description": "The distance to the subject of the photo, in meters.", + "description": "Output only. The distance to the subject of the photo, in meters.", "format": "int32", "type": "integer" }, "whiteBalance": { - "description": "The white balance mode used to create the photo.", + "description": "Output only. The white balance mode used to create the photo.", "type": "string" }, "width": { - "description": "The width of the image in pixels.", + "description": "Output only. The width of the image in pixels.", "format": "int32", "type": "integer" } @@ -5169,7 +5284,7 @@ "type": "object" }, "indexableText": { - "description": "Indexable text attributes for the file (can only be written). For more information, see Manage file metadata.", + "description": "Indexable text attributes for the file (can only be written)", "properties": { "text": { "description": "The text to be indexed for this file.", @@ -5179,19 +5294,19 @@ "type": "object" }, "isAppAuthorized": { - "description": "Whether the file was created or opened by the requesting app.", + "description": "Output only. Whether the file was created or opened by the requesting app.", "type": "boolean" }, "kind": { "default": "drive#file", - "description": "The type of file. This is always drive#file.", + "description": "Output only. The type of file. This is always `drive#file`.", "type": "string" }, "labelInfo": { - "description": "An overview of the labels on the file.", + "description": "Output only. An overview of the labels on the file.", "properties": { "labels": { - "description": "The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned.", + "description": "Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.", "items": { "$ref": "Label" }, @@ -5204,15 +5319,15 @@ "description": "A group of labels for the file.", "properties": { "hidden": { - "description": "Deprecated.", + "description": "Output only. Deprecated.", "type": "boolean" }, "modified": { - "description": "Whether the file has been modified by this user.", + "description": "Output only. Whether the file has been modified by this user.", "type": "boolean" }, "restricted": { - "description": "Deprecated - use copyRequiresWriterPermission instead.", + "description": "Output only. Deprecated: Use `copyRequiresWriterPermission` instead.", "type": "boolean" }, "starred": { @@ -5220,7 +5335,7 @@ "type": "boolean" }, "trashed": { - "description": "Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.", + "description": "Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.", "type": "boolean" }, "viewed": { @@ -5232,10 +5347,10 @@ }, "lastModifyingUser": { "$ref": "User", - "description": "The last user to modify this file." + "description": "Output only. The last user to modify this file." }, "lastModifyingUserName": { - "description": "Name of the last user to modify this file.", + "description": "Output only. Name of the last user to modify this file.", "type": "string" }, "lastViewedByMeDate": { @@ -5247,11 +5362,11 @@ "description": "Contains details about the link URLs that clients are using to refer to this item.", "properties": { "securityUpdateEligible": { - "description": "Whether the file is eligible for security update.", + "description": "Output only. Whether the file is eligible for security update.", "type": "boolean" }, "securityUpdateEnabled": { - "description": "Whether the security update is enabled for this file.", + "description": "Output only. Whether the security update is enabled for this file.", "type": "boolean" } }, @@ -5263,7 +5378,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 isn't populated for Docs Editors or shortcut files.", + "description": "Output only. 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": { @@ -5284,47 +5399,47 @@ "additionalProperties": { "type": "string" }, - "description": "A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.", + "description": "Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.", "type": "object" }, "originalFilename": { - "description": "The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive.", + "description": "The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive.", "type": "string" }, "ownedByMe": { - "description": "Whether the file is owned by the current user. Not populated for items in shared drives.", + "description": "Output only. Whether the file is owned by the current user. Not populated for items in shared drives.", "type": "boolean" }, "ownerNames": { - "description": "Name(s) of the owner(s) of this file. Not populated for items in shared drives.", + "description": "Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.", "items": { "type": "string" }, "type": "array" }, "owners": { - "description": "The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.", + "description": "Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.", "items": { "$ref": "User" }, "type": "array" }, "parents": { - "description": "Collection of parent folders which contain this file.\nIf not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.", + "description": "Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list.", "items": { "$ref": "ParentReference" }, "type": "array" }, "permissionIds": { - "description": "List of permission IDs for users with access to this file.", + "description": "Output only. List of permission IDs for users with access to this file.", "items": { "type": "string" }, "type": "array" }, "permissions": { - "description": "The list of permissions for users with access to this file. Not populated for items in shared drives.", + "description": "Output only. The list of permissions for users with access to this file. Not populated for items in shared drives.", "items": { "$ref": "Permission" }, @@ -5338,32 +5453,32 @@ "type": "array" }, "quotaBytesUsed": { - "description": "The number of quota bytes used by this file.", + "description": "Output only. The number of quota bytes used by this file.", "format": "int64", "type": "string" }, "resourceKey": { - "description": "A key needed to access the item via a shared link.", + "description": "Output only. A key needed to access the item via a shared link.", "type": "string" }, "selfLink": { - "description": "A link back to this file.", + "description": "Output only. A link back to this file.", "type": "string" }, "sha1Checksum": { - "description": "The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.", + "description": "Output only. The SHA1 checksum associated with this file, if available. 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" }, "sha256Checksum": { - "description": "The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.", + "description": "Output only. The SHA256 checksum associated with this file, if available. 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" }, "shareable": { - "description": "Deprecated: use capabilities/canShare.", + "description": "Output only. Deprecated: Use `capabilities/canShare` instead.", "type": "boolean" }, "shared": { - "description": "Whether the file has been shared. Not populated for items in shared drives.", + "description": "Output only. Whether the file has been shared. Not populated for items in shared drives.", "type": "boolean" }, "sharedWithMeDate": { @@ -5373,35 +5488,35 @@ }, "sharingUser": { "$ref": "User", - "description": "User that shared the item with the current user, if available." + "description": "Output only. User that shared the item with the current user, if available." }, "shortcutDetails": { - "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.", + "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`.", "properties": { "targetId": { "description": "The ID of the file that this shortcut points to.", "type": "string" }, "targetMimeType": { - "description": "The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.", + "description": "Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.", "type": "string" }, "targetResourceKey": { - "description": "The ResourceKey for the target file.", + "description": "Output only. The ResourceKey for the target file.", "type": "string" } }, "type": "object" }, "spaces": { - "description": "The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.", + "description": "Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.", "items": { "type": "string" }, "type": "array" }, "teamDriveId": { - "description": "Deprecated - use driveId instead.", + "description": "Output only. Deprecated: Use `driveId` instead.", "type": "string" }, "thumbnail": { @@ -5420,11 +5535,11 @@ "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. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.", + "description": "Output only. 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.", "type": "string" }, "thumbnailVersion": { - "description": "The thumbnail version for use in thumbnail cache invalidation.", + "description": "Output only. The thumbnail version for use in thumbnail cache invalidation.", "format": "int64", "type": "string" }, @@ -5439,32 +5554,32 @@ }, "trashingUser": { "$ref": "User", - "description": "If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives." + "description": "Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives." }, "userPermission": { "$ref": "Permission", - "description": "The permissions for the authenticated user on this file." + "description": "Output only. The permissions for the authenticated user on this file." }, "version": { - "description": "A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.", + "description": "Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.", "format": "int64", "type": "string" }, "videoMediaMetadata": { - "description": "Metadata about video media. This will only be present for video types.", + "description": "Output only. Metadata about video media. This will only be present for video types.", "properties": { "durationMillis": { - "description": "The duration of the video in milliseconds.", + "description": "Output only. The duration of the video in milliseconds.", "format": "int64", "type": "string" }, "height": { - "description": "The height of the video in pixels.", + "description": "Output only. The height of the video in pixels.", "format": "int32", "type": "integer" }, "width": { - "description": "The width of the video in pixels.", + "description": "Output only. The width of the video in pixels.", "format": "int32", "type": "integer" } @@ -5472,11 +5587,11 @@ "type": "object" }, "webContentLink": { - "description": "A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.", + "description": "Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.", "type": "string" }, "webViewLink": { - "description": "A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.", + "description": "Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.", "type": "string" }, "writersCanShare": { @@ -5507,7 +5622,7 @@ }, "kind": { "default": "drive#fileList", - "description": "This is always drive#fileList.", + "description": "This is always `drive#fileList`.", "type": "string" }, "nextLink": { @@ -5538,7 +5653,7 @@ }, "kind": { "default": "drive#generatedIds", - "description": "This is always drive#generatedIds", + "description": "This is always `drive#generatedIds`", "type": "string" }, "space": { @@ -5549,14 +5664,14 @@ "type": "object" }, "Label": { - "description": "Representation of a label and its fields.", + "description": "Representation of a label and label fields.", "id": "Label", "properties": { "fields": { "additionalProperties": { "$ref": "LabelField" }, - "description": "A map of the label's fields keyed by the field ID.", + "description": "A map of the fields on the label, keyed by the field's ID.", "type": "object" }, "id": { @@ -5565,7 +5680,7 @@ }, "kind": { "default": "drive#label", - "description": "This is always drive#label", + "description": "This is always `drive#label`", "type": "string" }, "revisionId": { @@ -5576,7 +5691,7 @@ "type": "object" }, "LabelField": { - "description": "Representation of a label field.", + "description": "Representation of field, which is a typed key-value pair.", "id": "LabelField", "properties": { "dateString": { @@ -5588,11 +5703,11 @@ "type": "array" }, "id": { - "description": "The identifier of this field.", + "description": "The identifier of this label field.", "type": "string" }, "integer": { - "description": "Only present if valueType is integer.", + "description": "Only present if `valueType` is `integer`.", "items": { "format": "int64", "type": "string" @@ -5601,32 +5716,32 @@ }, "kind": { "default": "drive#labelField", - "description": "This is always drive#labelField.", + "description": "This is always `drive#labelField`.", "type": "string" }, "selection": { - "description": "Only present if valueType is selection.", + "description": "Only present if `valueType` is `selection`", "items": { "type": "string" }, "type": "array" }, "text": { - "description": "Only present if valueType is text.", + "description": "Only present if `valueType` is `text`.", "items": { "type": "string" }, "type": "array" }, "user": { - "description": "Only present if valueType is user.", + "description": "Only present if `valueType` is `user`.", "items": { "$ref": "User" }, "type": "array" }, "valueType": { - "description": "The field type. While new values may be supported in the future, the following are currently allowed: \n- dateString \n- integer \n- selection \n- text \n- user", + "description": "The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`", "type": "string" } }, @@ -5642,11 +5757,11 @@ }, "kind": { "default": "drive#labelFieldModification", - "description": "This is always drive#labelFieldModification.", + "description": "This is always `drive#labelFieldModification`.", "type": "string" }, "setDateValues": { - "description": "Replaces a dateString field with these new values. The values must be strings in the RFC 3339 full-date format: YYYY-MM-DD.", + "description": "Replaces the value of a dateString Field with these new values. The string must be in the RFC 3339 full-date format: YYYY-MM-DD.", "items": { "format": "date", "type": "string" @@ -5654,7 +5769,7 @@ "type": "array" }, "setIntegerValues": { - "description": "Replaces an integer field with these new values.", + "description": "Replaces the value of an `integer` field with these new values.", "items": { "format": "int64", "type": "string" @@ -5662,21 +5777,21 @@ "type": "array" }, "setSelectionValues": { - "description": "Replaces a selection field with these new values.", + "description": "Replaces a `selection` field with these new values.", "items": { "type": "string" }, "type": "array" }, "setTextValues": { - "description": "Replaces a text field with these new values.", + "description": "Sets the value of a `text` field.", "items": { "type": "string" }, "type": "array" }, "setUserValues": { - "description": "Replaces a user field with these new values. The values must be valid email addresses.", + "description": "Replaces a `user` field with these new values. The values must be valid email addresses.", "items": { "type": "string" }, @@ -5690,7 +5805,7 @@ "type": "object" }, "LabelList": { - "description": "A list of labels.", + "description": "A list of labels applied to a file.", "id": "LabelList", "properties": { "items": { @@ -5702,7 +5817,7 @@ }, "kind": { "default": "drive#labelList", - "description": "This is always drive#labelList", + "description": "This is always `drive#labelList`", "type": "string" }, "nextPageToken": { @@ -5725,7 +5840,7 @@ }, "kind": { "default": "drive#labelModification", - "description": "This is always drive#labelModification.", + "description": "This is always `drive#labelModification`.", "type": "string" }, "labelId": { @@ -5745,12 +5860,12 @@ "type": "object" }, "ModifyLabelsRequest": { - "description": "A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail transactionally.", + "description": "A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail atomically.", "id": "ModifyLabelsRequest", "properties": { "kind": { "default": "drive#modifyLabelsRequest", - "description": "This is always drive#modifyLabelsRequest", + "description": "This is always `drive#modifyLabelsRequest`.", "type": "string" }, "labelModifications": { @@ -5769,7 +5884,7 @@ "properties": { "kind": { "default": "drive#modifyLabelsResponse", - "description": "This is always drive#modifyLabelsResponse", + "description": "This is always `drive#modifyLabelsResponse`", "type": "string" }, "modifiedLabels": { @@ -5799,7 +5914,7 @@ }, "kind": { "default": "drive#parentList", - "description": "This is always drive#parentList.", + "description": "This is always `drive#parentList`.", "type": "string" }, "selfLink": { @@ -5823,20 +5938,20 @@ "type": "string" }, "isRoot": { - "description": "Whether or not the parent is the root folder.", + "description": "Output only. Whether or not the parent is the root folder.", "type": "boolean" }, "kind": { "default": "drive#parentReference", - "description": "This is always drive#parentReference.", + "description": "Output only. This is always `drive#parentReference`.", "type": "string" }, "parentLink": { - "description": "A link to the parent.", + "description": "Output only. A link to the parent.", "type": "string" }, "selfLink": { - "description": "A link back to this reference.", + "description": "Output only. A link back to this reference.", "type": "string" } }, @@ -5847,79 +5962,79 @@ "id": "Permission", "properties": { "additionalRoles": { - "description": "Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.", + "description": "Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.", "items": { "type": "string" }, "type": "array" }, "authKey": { - "description": "Deprecated.", + "description": "Output only. Deprecated.", "type": "string" }, "deleted": { - "description": "Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.", + "description": "Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.", "type": "boolean" }, "domain": { - "description": "The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.", + "description": "Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.", "type": "string" }, "emailAddress": { - "description": "The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.", + "description": "Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.", "type": "string" }, "etag": { - "description": "The ETag of the permission.", + "description": "Output only. The ETag of the permission.", "type": "string" }, "expirationDate": { - "description": "The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: \n- They cannot be set on shared drive items \n- They can only be set on user and group permissions \n- The date must be in the future \n- The date cannot be more than a year in the future", + "description": "The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They cannot be set on shared drive items - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests", "format": "date-time", "type": "string" }, "id": { - "description": "The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.", + "description": "The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.", "type": "string" }, "kind": { "default": "drive#permission", - "description": "This is always drive#permission.", + "description": "Output only. This is always `drive#permission`.", "type": "string" }, "name": { - "description": "The name for this permission.", + "description": "Output only. The name for this permission.", "type": "string" }, "pendingOwner": { - "description": "Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.", + "description": "Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.", "type": "boolean" }, "permissionDetails": { - "description": "Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.", + "description": "Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.", "items": { "properties": { "additionalRoles": { - "description": "Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.", + "description": "Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.", "items": { "type": "string" }, "type": "array" }, "inherited": { - "description": "Whether this permission is inherited. This field is always populated. This is an output-only field.", + "description": "Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.", "type": "boolean" }, "inheritedFrom": { - "description": "The ID of the item from which this permission is inherited. This is an output-only field.", + "description": "Output only. The ID of the item from which this permission is inherited. This is an output-only field.", "type": "string" }, "permissionType": { - "description": "The permission type for this user. While new values may be added in future, the following are currently possible: \n- file \n- member", + "description": "Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`", "type": "string" }, "role": { - "description": "The primary role for this user. While new values may be added in the future, the following are currently possible: \n- organizer \n- fileOrganizer \n- writer \n- reader", + "description": "Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader`", "type": "string" } }, @@ -5929,7 +6044,7 @@ "type": "array" }, "photoLink": { - "description": "A link to the profile photo, if available.", + "description": "Output only. A link to the profile photo, if available.", "type": "string" }, "role": { @@ -5938,38 +6053,38 @@ "drive.permissions.insert" ] }, - "description": "The primary role for this user. While new values may be supported in the future, the following are currently allowed: \n- owner \n- organizer \n- fileOrganizer \n- writer \n- reader", + "description": "The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`", "type": "string" }, "selfLink": { - "description": "A link back to this permission.", + "description": "Output only. A link back to this permission.", "type": "string" }, "teamDrivePermissionDetails": { - "description": "Deprecated - use permissionDetails instead.", + "description": "Output only. Deprecated: Use `permissionDetails` instead.", "items": { "properties": { "additionalRoles": { - "description": "Deprecated - use permissionDetails/additionalRoles instead.", + "description": "Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.", "items": { "type": "string" }, "type": "array" }, "inherited": { - "description": "Deprecated - use permissionDetails/inherited instead.", + "description": "Output only. Deprecated: Use `permissionDetails/inherited` instead.", "type": "boolean" }, "inheritedFrom": { - "description": "Deprecated - use permissionDetails/inheritedFrom instead.", + "description": "Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.", "type": "string" }, "role": { - "description": "Deprecated - use permissionDetails/role instead.", + "description": "Output only. Deprecated: Use `permissionDetails/role` instead.", "type": "string" }, "teamDrivePermissionType": { - "description": "Deprecated - use permissionDetails/permissionType instead.", + "description": "Output only. Deprecated: Use `permissionDetails/permissionType` instead.", "type": "string" } }, @@ -5984,15 +6099,15 @@ "drive.permissions.insert" ] }, - "description": "The account type. Allowed values are: \n- user \n- group \n- domain \n- anyone", + "description": "The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`", "type": "string" }, "value": { - "description": "The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.", + "description": "The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.", "type": "string" }, "view": { - "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.", + "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.", "type": "string" }, "withLink": { @@ -6012,7 +6127,7 @@ }, "kind": { "default": "drive#permissionId", - "description": "This is always drive#permissionId.", + "description": "This is always `drive#permissionId`.", "type": "string" } }, @@ -6035,7 +6150,7 @@ }, "kind": { "default": "drive#permissionList", - "description": "This is always drive#permissionList.", + "description": "This is always `drive#permissionList`.", "type": "string" }, "nextPageToken": { @@ -6050,11 +6165,11 @@ "type": "object" }, "Property": { - "description": "A key-value pair attached to a file that is either public or private to an application.\nThe following limits apply to file properties: \n- Maximum of 100 properties total per file\n- Maximum of 30 private properties per app\n- Maximum of 30 public properties\n- Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.", + "description": "A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property", "id": "Property", "properties": { "etag": { - "description": "ETag of the property.", + "description": "Output only. ETag of the property.", "type": "string" }, "key": { @@ -6068,11 +6183,11 @@ }, "kind": { "default": "drive#property", - "description": "This is always drive#property.", + "description": "Output only. This is always `drive#property`.", "type": "string" }, "selfLink": { - "description": "The link back to this property.", + "description": "Output only. The link back to this property.", "type": "string" }, "value": { @@ -6080,7 +6195,7 @@ "type": "string" }, "visibility": { - "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.", + "description": "The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. 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" } }, @@ -6103,7 +6218,7 @@ }, "kind": { "default": "drive#propertyList", - "description": "This is always drive#propertyList.", + "description": "This is always `drive#propertyList`.", "type": "string" }, "selfLink": { @@ -6118,48 +6233,48 @@ "id": "Revision", "properties": { "downloadUrl": { + "description": "Output only. Short term download URL for the file. This will only be populated on files with content stored in Drive.", "type": "string" }, "etag": { - "description": "The ETag of the revision.", + "description": "Output only. The ETag of the revision.", "type": "string" }, "exportLinks": { "additionalProperties": { - "description": "A mapping from export format to URL", "type": "string" }, - "description": "Links for exporting Docs Editors files to specific formats.", + "description": "Output only. Links for exporting Docs Editors files to specific formats.", "type": "object" }, "fileSize": { - "description": "The size of the revision in bytes. This will only be populated on files with content stored in Drive.", + "description": "Output only. The size of the revision in bytes. This will only be populated on files with content stored in Drive.", "format": "int64", "type": "string" }, "id": { - "description": "The ID of the revision.", + "description": "Output only. The ID of the revision.", "type": "string" }, "kind": { "default": "drive#revision", - "description": "This is always drive#revision.", + "description": "Output only. This is always `drive#revision`.", "type": "string" }, "lastModifyingUser": { "$ref": "User", - "description": "The last user to modify this revision." + "description": "Output only. The last user to modify this revision." }, "lastModifyingUserName": { - "description": "Name of the last user to modify this revision.", + "description": "Output only. Name of the last user to modify this revision.", "type": "string" }, "md5Checksum": { - "description": "An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.", + "description": "Output only. An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.", "type": "string" }, "mimeType": { - "description": "The MIME type of the revision.", + "description": "Output only. The MIME type of the revision.", "type": "string" }, "modifiedDate": { @@ -6168,7 +6283,7 @@ "type": "string" }, "originalFilename": { - "description": "The original filename when this revision was created. This will only be populated on files with content stored in Drive.", + "description": "Output only. The original filename when this revision was created. This will only be populated on files with content stored in Drive.", "type": "string" }, "pinned": { @@ -6184,7 +6299,7 @@ "type": "boolean" }, "publishedLink": { - "description": "A link to the published revision. This is only populated for Google Sites files.", + "description": "Output only. A link to the published revision. This is only populated for Google Sites files.", "type": "string" }, "publishedOutsideDomain": { @@ -6192,7 +6307,7 @@ "type": "boolean" }, "selfLink": { - "description": "A link back to this revision.", + "description": "Output only. A link back to this revision.", "type": "string" } }, @@ -6215,7 +6330,7 @@ }, "kind": { "default": "drive#revisionList", - "description": "This is always drive#revisionList.", + "description": "This is always `drive#revisionList`.", "type": "string" }, "nextPageToken": { @@ -6234,7 +6349,7 @@ "properties": { "kind": { "default": "drive#startPageToken", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#startPageToken\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#startPageToken\"`.", "type": "string" }, "startPageToken": { @@ -6245,11 +6360,11 @@ "type": "object" }, "TeamDrive": { - "description": "Deprecated: use the drive collection instead.", + "description": "Deprecated: Use the `drive` collection instead.", "id": "TeamDrive", "properties": { "backgroundImageFile": { - "description": "An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.", + "description": "An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on `drive.teamdrives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.", "properties": { "id": { "description": "The ID of an image file in Drive to use for the background image.", @@ -6285,15 +6400,15 @@ "type": "boolean" }, "canChangeCopyRequiresWriterPermissionRestriction": { - "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive.", + "description": "Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.", "type": "boolean" }, "canChangeDomainUsersOnlyRestriction": { - "description": "Whether the current user can change the domainUsersOnly restriction of this Team Drive.", + "description": "Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.", "type": "boolean" }, "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": { - "description": "Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this Team Drive.", + "description": "Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.", "type": "boolean" }, "canChangeTeamDriveBackground": { @@ -6301,7 +6416,7 @@ "type": "boolean" }, "canChangeTeamMembersOnlyRestriction": { - "description": "Whether the current user can change the teamMembersOnly restriction of this Team Drive.", + "description": "Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.", "type": "boolean" }, "canComment": { @@ -6341,7 +6456,7 @@ "type": "boolean" }, "canRemoveChildren": { - "description": "Deprecated - use canDeleteChildren or canTrashChildren instead.", + "description": "Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.", "type": "boolean" }, "canRename": { @@ -6368,7 +6483,7 @@ "type": "object" }, "colorRgb": { - "description": "The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId.", + "description": "The color of this Team Drive as an RGB hex string. It can only be set on a `drive.teamdrives.update` request that does not set `themeId`.", "type": "string" }, "createdDate": { @@ -6382,7 +6497,7 @@ }, "kind": { "default": "drive#teamDrive", - "description": "This is always drive#teamDrive", + "description": "This is always `drive#teamDrive`", "type": "string" }, "name": { @@ -6395,7 +6510,7 @@ "type": "string" }, "orgUnitId": { - "description": "The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true.", + "description": "The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.", "type": "string" }, "restrictions": { @@ -6406,7 +6521,7 @@ "type": "boolean" }, "copyRequiresWriterPermission": { - "description": "Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this Team Drive.", + "description": "Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this Team Drive.", "type": "boolean" }, "domainUsersOnly": { @@ -6425,7 +6540,7 @@ "type": "object" }, "themeId": { - "description": "The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.insert request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.", + "description": "The ID of the theme from which the background image and color will be set. The set of possible `teamDriveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.teamdrives.insert` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.", "type": "string" } }, @@ -6444,7 +6559,7 @@ }, "kind": { "default": "drive#teamDriveList", - "description": "This is always drive#teamDriveList", + "description": "This is always `drive#teamDriveList`", "type": "string" }, "nextPageToken": { @@ -6459,31 +6574,31 @@ "id": "User", "properties": { "displayName": { - "description": "A plain text displayable name for this user.", + "description": "Output only. A plain text displayable name for this user.", "type": "string" }, "emailAddress": { - "description": "The email address of the user.", + "description": "Output only. The email address of the user.", "type": "string" }, "isAuthenticatedUser": { - "description": "Whether this user is the same as the authenticated user for whom the request was made.", + "description": "Output only. Whether this user is the same as the authenticated user for whom the request was made.", "type": "boolean" }, "kind": { "default": "drive#user", - "description": "This is always drive#user.", + "description": "Output only. This is always `drive#user`.", "type": "string" }, "permissionId": { - "description": "The user's ID as visible in the permissions collection.", + "description": "Output only. The user's ID as visible in the permissions collection.", "type": "string" }, "picture": { - "description": "The user's profile picture.", + "description": "Output only. The user's profile picture.", "properties": { "url": { - "description": "A URL that points to a profile picture of this user.", + "description": "Output Only. A URL that points to a profile picture of this user.", "type": "string" } }, @@ -6494,6 +6609,6 @@ } }, "servicePath": "drive/v2/", - "title": "Drive API", + "title": "Google Drive API", "version": "v2" } \ No newline at end of file diff --git a/drive/v2/drive-gen.go b/drive/v2/drive-gen.go index fcf19dc99fb..9d5da1a8c91 100644 --- a/drive/v2/drive-gen.go +++ b/drive/v2/drive-gen.go @@ -4,7 +4,7 @@ // Code generated file. DO NOT EDIT. -// Package drive provides access to the Drive API. +// Package drive provides access to the Google Drive API. // // For product documentation, see: https://developers.google.com/drive/ // @@ -81,6 +81,7 @@ const apiId = "drive:v2" const apiName = "drive" const apiVersion = "v2" const basePath = "https://www.googleapis.com/drive/v2/" +const mtlsBasePath = "https://www.mtls.googleapis.com/drive/v2/" // OAuth2 scopes used by this API. const ( @@ -130,6 +131,7 @@ func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, err // NOTE: prepend, so we don't override user-specified scopes. opts = append([]option.ClientOption{scopesOption}, opts...) opts = append(opts, internaloption.WithDefaultEndpoint(basePath)) + opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath)) client, endpoint, err := htransport.NewClient(ctx, opts...) if err != nil { return nil, err @@ -347,15 +349,12 @@ type About struct { // CanCreateDrives: Whether the user can create shared drives. CanCreateDrives bool `json:"canCreateDrives,omitempty"` - // CanCreateTeamDrives: Deprecated - use canCreateDrives instead. + // CanCreateTeamDrives: Deprecated: Use `canCreateDrives` instead. CanCreateTeamDrives bool `json:"canCreateTeamDrives,omitempty"` // DomainSharingPolicy: The domain sharing policy for the current user. - // Possible values are: - // - allowed - // - allowedWithWarning - // - incomingOnly - // - disallowed + // Possible values are: * `allowed` * `allowedWithWarning` * + // `incomingOnly` * `disallowed` DomainSharingPolicy string `json:"domainSharingPolicy,omitempty"` // DriveThemes: A list of themes that are supported for shared drives. @@ -381,7 +380,7 @@ type About struct { // app is installed by the authenticated user. IsCurrentAppInstalled bool `json:"isCurrentAppInstalled,omitempty"` - // Kind: This is always drive#about. + // Kind: This is always `drive#about`. Kind string `json:"kind,omitempty"` // LanguageCode: The user's language or locale code, as defined by BCP @@ -423,9 +422,7 @@ type About struct { QuotaBytesUsedInTrash int64 `json:"quotaBytesUsedInTrash,omitempty,string"` // QuotaType: The type of the user's storage quota. Possible values are: - // - // - LIMITED - // - UNLIMITED + // * `LIMITED` * `UNLIMITED` QuotaType string `json:"quotaType,omitempty"` // RemainingChangeIds: The number of remaining change ids, limited to no @@ -438,7 +435,7 @@ type About struct { // SelfLink: A link back to this item. SelfLink string `json:"selfLink,omitempty"` - // TeamDriveThemes: Deprecated - use driveThemes instead. + // TeamDriveThemes: Deprecated: Use `driveThemes` instead. TeamDriveThemes []*AboutTeamDriveThemes `json:"teamDriveThemes,omitempty"` // User: The authenticated user. @@ -734,14 +731,14 @@ func (s *AboutQuotaBytesByService) MarshalJSON() ([]byte, error) { } type AboutTeamDriveThemes struct { - // BackgroundImageLink: Deprecated - use driveThemes/backgroundImageLink - // instead. + // BackgroundImageLink: Deprecated: Use + // `driveThemes/backgroundImageLink` instead. BackgroundImageLink string `json:"backgroundImageLink,omitempty"` - // ColorRgb: Deprecated - use driveThemes/colorRgb instead. + // ColorRgb: Deprecated: Use `driveThemes/colorRgb` instead. ColorRgb string `json:"colorRgb,omitempty"` - // Id: Deprecated - use driveThemes/id instead. + // Id: Deprecated: Use `driveThemes/id` instead. Id string `json:"id,omitempty"` // ForceSendFields is a list of field names (e.g. "BackgroundImageLink") @@ -797,7 +794,7 @@ type App struct { // Installed: Whether the app is installed. Installed bool `json:"installed,omitempty"` - // Kind: This is always drive#app. + // Kind: This is always `drive#app`. Kind string `json:"kind,omitempty"` // LongDescription: A long description of the app. @@ -811,8 +808,8 @@ type App struct { ObjectType string `json:"objectType,omitempty"` // OpenUrlTemplate: The template url for opening files with this app. - // The template will contain {ids} and/or {exportIds} to be replaced by - // the actual file ids. See Open Files for the full documentation. + // The template will contain `{ids}` and/or `{exportIds}` to be replaced + // by the actual file ids. See Open Files for the full documentation. OpenUrlTemplate string `json:"openUrlTemplate,omitempty"` // PrimaryFileExtensions: The list of primary file extensions. @@ -883,10 +880,10 @@ func (s *App) MarshalJSON() ([]byte, error) { } type AppIcons struct { - // Category: Category of the icon. Allowed values are: - // - application - icon for the application - // - document - icon for a file associated with the app - // - documentShared - icon for a shared file associated with the app + // Category: Category of the icon. Allowed values are: * `application` - + // icon for the application * `document` - icon for a file associated + // with the app * `documentShared` - icon for a shared file associated + // with the app Category string `json:"category,omitempty"` // IconUrl: URL for the icon. @@ -932,7 +929,7 @@ type AppList struct { // Items: The list of apps. Items []*App `json:"items,omitempty"` - // Kind: This is always drive#appList. + // Kind: This is always `drive#appList`. Kind string `json:"kind,omitempty"` // SelfLink: A link back to this list. @@ -967,8 +964,8 @@ func (s *AppList) MarshalJSON() ([]byte, error) { // Change: Representation of a change to a file or shared drive. type Change struct { - // ChangeType: The type of the change. Possible values are file and - // drive. + // ChangeType: The type of the change. Possible values are `file` and + // `drive`. ChangeType string `json:"changeType,omitempty"` // Deleted: Whether the file or shared drive has been removed from this @@ -993,7 +990,7 @@ type Change struct { // Id: The ID of the change. Id int64 `json:"id,omitempty,string"` - // Kind: This is always drive#change. + // Kind: This is always `drive#change`. Kind string `json:"kind,omitempty"` // ModificationDate: The time of this modification. @@ -1002,13 +999,13 @@ type Change struct { // SelfLink: A link back to this change. SelfLink string `json:"selfLink,omitempty"` - // TeamDrive: Deprecated - use drive instead. + // TeamDrive: Deprecated: Use `drive` instead. TeamDrive *TeamDrive `json:"teamDrive,omitempty"` - // TeamDriveId: Deprecated - use driveId instead. + // TeamDriveId: Deprecated: Use `driveId` instead. TeamDriveId string `json:"teamDriveId,omitempty"` - // Type: Deprecated - use changeType instead. + // Type: Deprecated: Use `changeType` instead. Type string `json:"type,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1048,7 +1045,7 @@ type ChangeList struct { // fetched. Items []*Change `json:"items,omitempty"` - // Kind: This is always drive#changeList. + // Kind: This is always `drive#changeList`. Kind string `json:"kind,omitempty"` // LargestChangeId: The current largest change ID. @@ -1098,7 +1095,7 @@ func (s *ChangeList) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Channel: An notification channel used to watch for resource changes. +// Channel: A notification channel used to watch for resource changes. type Channel struct { // Address: The address where notifications are delivered for this // channel. @@ -1112,7 +1109,7 @@ type Channel struct { Id string `json:"id,omitempty"` // Kind: Identifies this as a notification channel used to watch for - // changes to a resource, which is "api#channel". + // changes to a resource, which is `api#channel`. Kind string `json:"kind,omitempty"` // Params: Additional parameters controlling delivery channel behavior. @@ -1134,9 +1131,7 @@ type Channel struct { // notification delivered over this channel. Optional. Token string `json:"token,omitempty"` - // Type: The type of delivery mechanism used for this channel. Valid - // values are "web_hook" (or "webhook"). Both values refer to a channel - // where Http requests are used to deliver messages. + // Type: The type of delivery mechanism used for this channel. Type string `json:"type,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1176,7 +1171,7 @@ type ChildList struct { // fetched. Items []*ChildReference `json:"items,omitempty"` - // Kind: This is always drive#childList. + // Kind: This is always `drive#childList`. Kind string `json:"kind,omitempty"` // NextLink: A link to the next page of children. @@ -1220,16 +1215,16 @@ func (s *ChildList) MarshalJSON() ([]byte, error) { // ChildReference: A reference to a folder's child. type ChildReference struct { - // ChildLink: A link to the child. + // ChildLink: Output only. A link to the child. ChildLink string `json:"childLink,omitempty"` // Id: The ID of the child. Id string `json:"id,omitempty"` - // Kind: This is always drive#childReference. + // Kind: Output only. This is always `drive#childReference`. Kind string `json:"kind,omitempty"` - // SelfLink: A link back to this reference. + // SelfLink: Output only. A link back to this reference. SelfLink string `json:"selfLink,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1262,15 +1257,15 @@ func (s *ChildReference) MarshalJSON() ([]byte, error) { // Comment: A comment on a file in Google Drive. type Comment struct { // Anchor: A region of the document represented as a JSON string. For - // details on defining anchor properties, refer to Add comments and - // replies. + // details on defining anchor properties, refer to Add comments and + // replies (https://developers.google.com/drive/api/v2/manage-comments). Anchor string `json:"anchor,omitempty"` - // Author: The author of the comment. The author's email address and - // permission ID will not be populated. + // Author: Output only. The author of the comment. The author's email + // address and permission ID will not be populated. Author *User `json:"author,omitempty"` - // CommentId: The ID of the comment. + // CommentId: Output only. The ID of the comment. CommentId string `json:"commentId,omitempty"` // Content: The plain text content used to create this comment. This is @@ -1284,37 +1279,38 @@ type Comment struct { // CreatedDate: The date when this comment was first created. CreatedDate string `json:"createdDate,omitempty"` - // Deleted: Whether this comment has been deleted. If a comment has been - // deleted the content will be cleared and this will only represent a - // comment that once existed. + // Deleted: Output only. Whether this comment has been deleted. If a + // comment has been deleted the content will be cleared and this will + // only represent a comment that once existed. Deleted bool `json:"deleted,omitempty"` - // FileId: The file which this comment is addressing. + // FileId: Output only. The file which this comment is addressing. FileId string `json:"fileId,omitempty"` - // FileTitle: The title of the file which this comment is addressing. + // FileTitle: Output only. The title of the file which this comment is + // addressing. FileTitle string `json:"fileTitle,omitempty"` - // HtmlContent: HTML formatted content for this comment. + // HtmlContent: Output only. HTML formatted content for this comment. HtmlContent string `json:"htmlContent,omitempty"` - // Kind: This is always drive#comment. + // Kind: Output only. This is always `drive#comment`. Kind string `json:"kind,omitempty"` // ModifiedDate: The date when this comment or any of its replies were // last modified. ModifiedDate string `json:"modifiedDate,omitempty"` - // Replies: Replies to this post. + // Replies: Output only. Replies to this post. Replies []*CommentReply `json:"replies,omitempty"` - // SelfLink: A link back to this comment. + // SelfLink: Output only. A link back to this comment. SelfLink string `json:"selfLink,omitempty"` - // Status: The status of this comment. Status can be changed by posting - // a reply to a comment with the desired status. - // - "open" - The comment is still open. - // - "resolved" - The comment has been resolved by one of its replies. + // Status: Output only. The status of this comment. Status can be + // changed by posting a reply to a comment with the desired status. * + // `open` - The comment is still open. * `resolved` - The comment has + // been resolved by one of its replies. Status string `json:"status,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1384,7 +1380,7 @@ type CommentList struct { // fetched. Items []*Comment `json:"items,omitempty"` - // Kind: This is always drive#commentList. + // Kind: This is always `drive#commentList`. Kind string `json:"kind,omitempty"` // NextLink: A link to the next page of comments. @@ -1428,8 +1424,8 @@ func (s *CommentList) MarshalJSON() ([]byte, error) { // CommentReply: A comment on a file in Google Drive. type CommentReply struct { - // Author: The author of the reply. The author's email address and - // permission ID will not be populated. + // Author: Output only. The author of the reply. The author's email + // address and permission ID will not be populated. Author *User `json:"author,omitempty"` // Content: The plain text content used to create this reply. This is @@ -1441,28 +1437,27 @@ type CommentReply struct { // CreatedDate: The date when this reply was first created. CreatedDate string `json:"createdDate,omitempty"` - // Deleted: Whether this reply has been deleted. If a reply has been - // deleted the content will be cleared and this will only represent a - // reply that once existed. + // Deleted: Output only. Whether this reply has been deleted. If a reply + // has been deleted the content will be cleared and this will only + // represent a reply that once existed. Deleted bool `json:"deleted,omitempty"` - // HtmlContent: HTML formatted content for this reply. + // HtmlContent: Output only. HTML formatted content for this reply. HtmlContent string `json:"htmlContent,omitempty"` - // Kind: This is always drive#commentReply. + // Kind: Output only. This is always `drive#commentReply`. Kind string `json:"kind,omitempty"` // ModifiedDate: The date when this reply was last modified. ModifiedDate string `json:"modifiedDate,omitempty"` - // ReplyId: The ID of the reply. + // ReplyId: Output only. The ID of the reply. ReplyId string `json:"replyId,omitempty"` // Verb: The action this reply performed to the parent comment. When // creating a new reply this is the action to be perform to the parent - // comment. Possible values are: - // - "resolve" - To resolve a comment. - // - "reopen" - To reopen (un-resolve) a comment. + // comment. Possible values are: * `resolve` - To resolve a comment. * + // `reopen` - To reopen (un-resolve) a comment. Verb string `json:"verb,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1500,7 +1495,7 @@ type CommentReplyList struct { // fetched. Items []*CommentReply `json:"items,omitempty"` - // Kind: This is always drive#commentReplyList. + // Kind: This is always `drive#commentReplyList`. Kind string `json:"kind,omitempty"` // NextLink: A link to the next page of replies. @@ -1552,19 +1547,19 @@ type ContentRestriction struct { ReadOnly bool `json:"readOnly,omitempty"` // Reason: Reason for why the content of the file is restricted. This is - // only mutable on requests that also set readOnly=true. + // only mutable on requests that also set `readOnly=true`. Reason string `json:"reason,omitempty"` - // RestrictingUser: The user who set the content restriction. Only - // populated if readOnly is true. + // RestrictingUser: Output only. The user who set the content + // restriction. Only populated if `readOnly` is true. RestrictingUser *User `json:"restrictingUser,omitempty"` // RestrictionDate: The time at which the content restriction was set // (formatted RFC 3339 timestamp). Only populated if readOnly is true. RestrictionDate string `json:"restrictionDate,omitempty"` - // Type: The type of the content restriction. Currently the only - // possible value is globalContentRestriction. + // Type: Output only. The type of the content restriction. Currently the + // only possible value is `globalContentRestriction`. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "ReadOnly") to @@ -1594,21 +1589,22 @@ func (s *ContentRestriction) MarshalJSON() ([]byte, error) { type Drive struct { // BackgroundImageFile: An image file and cropping parameters from which // a background image for this shared drive is set. This is a write only - // field; it can only be set on drive.drives.update requests that don't - // set themeId. When specified, all fields of the backgroundImageFile - // must be set. + // field; it can only be set on `drive.drives.update` requests that + // don't set `themeId`. When specified, all fields of the + // `backgroundImageFile` must be set. BackgroundImageFile *DriveBackgroundImageFile `json:"backgroundImageFile,omitempty"` - // BackgroundImageLink: A short-lived link to this shared drive's - // background image. + // BackgroundImageLink: Output only. A short-lived link to this shared + // drive's background image. BackgroundImageLink string `json:"backgroundImageLink,omitempty"` - // Capabilities: Capabilities the current user has on this shared drive. + // Capabilities: Output only. Capabilities the current user has on this + // shared drive. Capabilities *DriveCapabilities `json:"capabilities,omitempty"` // ColorRgb: The color of this shared drive as an RGB hex string. It can - // only be set on a drive.drives.update request that does not set - // themeId. + // only be set on a `drive.drives.update` request that does not set + // `themeId`. ColorRgb string `json:"colorRgb,omitempty"` // CreatedDate: The time at which the shared drive was created (RFC 3339 @@ -1618,19 +1614,19 @@ type Drive struct { // Hidden: Whether the shared drive is hidden from default view. Hidden bool `json:"hidden,omitempty"` - // Id: The ID of this shared drive which is also the ID of the top level - // folder of this shared drive. + // Id: Output only. The ID of this shared drive which is also the ID of + // the top level folder of this shared drive. Id string `json:"id,omitempty"` - // Kind: This is always drive#drive + // Kind: Output only. This is always `drive#drive` Kind string `json:"kind,omitempty"` // Name: The name of this shared drive. Name string `json:"name,omitempty"` - // OrgUnitId: The organizational unit of this shared drive. This field - // is only populated on drives.list responses when the - // useDomainAdminAccess parameter is set to true. + // OrgUnitId: Output only. The organizational unit of this shared drive. + // This field is only populated on `drives.list` responses when the + // `useDomainAdminAccess` parameter is set to `true`. OrgUnitId string `json:"orgUnitId,omitempty"` // Restrictions: A set of restrictions that apply to this shared drive @@ -1638,12 +1634,12 @@ type Drive struct { Restrictions *DriveRestrictions `json:"restrictions,omitempty"` // ThemeId: The ID of the theme from which the background image and - // color will be set. The set of possible driveThemes can be retrieved - // from a drive.about.get response. When not specified on a - // drive.drives.insert request, a random theme is chosen from which the - // background image and color are set. This is a write-only field; it - // can only be set on requests that don't set colorRgb or - // backgroundImageFile. + // color will be set. The set of possible `driveThemes` can be retrieved + // from a `drive.about.get` response. When not specified on a + // `drive.drives.insert` request, a random theme is chosen from which + // the background image and color are set. This is a write-only field; + // it can only be set on requests that don't set `colorRgb` or + // `backgroundImageFile`. ThemeId string `json:"themeId,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1676,9 +1672,9 @@ func (s *Drive) MarshalJSON() ([]byte, error) { // DriveBackgroundImageFile: An image file and cropping parameters from // which a background image for this shared drive is set. This is a -// write only field; it can only be set on drive.drives.update requests -// that don't set themeId. When specified, all fields of the -// backgroundImageFile must be set. +// write only field; it can only be set on `drive.drives.update` +// requests that don't set `themeId`. When specified, all fields of the +// `backgroundImageFile` must be set. type DriveBackgroundImageFile struct { // Id: The ID of an image file in Google Drive to use for the background // image. @@ -1746,90 +1742,93 @@ func (s *DriveBackgroundImageFile) UnmarshalJSON(data []byte) error { return nil } -// DriveCapabilities: Capabilities the current user has on this shared -// drive. +// DriveCapabilities: Output only. Capabilities the current user has on +// this shared drive. type DriveCapabilities struct { - // CanAddChildren: Whether the current user can add children to folders - // in this shared drive. + // CanAddChildren: Output only. Whether the current user can add + // children to folders in this shared drive. CanAddChildren bool `json:"canAddChildren,omitempty"` - // CanChangeCopyRequiresWriterPermissionRestriction: Whether the current - // user can change the copyRequiresWriterPermission restriction of this - // shared drive. + // CanChangeCopyRequiresWriterPermissionRestriction: Output only. + // Whether the current user can change the + // `copyRequiresWriterPermission` restriction of this shared drive. CanChangeCopyRequiresWriterPermissionRestriction bool `json:"canChangeCopyRequiresWriterPermissionRestriction,omitempty"` - // CanChangeDomainUsersOnlyRestriction: Whether the current user can - // change the domainUsersOnly restriction of this shared drive. + // CanChangeDomainUsersOnlyRestriction: Output only. Whether the current + // user can change the `domainUsersOnly` restriction of this shared + // drive. CanChangeDomainUsersOnlyRestriction bool `json:"canChangeDomainUsersOnlyRestriction,omitempty"` - // CanChangeDriveBackground: Whether the current user can change the - // background of this shared drive. + // CanChangeDriveBackground: Output only. Whether the current user can + // change the background of this shared drive. CanChangeDriveBackground bool `json:"canChangeDriveBackground,omitempty"` - // CanChangeDriveMembersOnlyRestriction: Whether the current user can - // change the driveMembersOnly restriction of this shared drive. + // CanChangeDriveMembersOnlyRestriction: Output only. Whether the + // current user can change the `driveMembersOnly` restriction of this + // shared drive. CanChangeDriveMembersOnlyRestriction bool `json:"canChangeDriveMembersOnlyRestriction,omitempty"` - // CanChangeSharingFoldersRequiresOrganizerPermissionRestriction: - // Whether the current user can change the - // sharingFoldersRequiresOrganizerPermission restriction of this shared - // drive. + // CanChangeSharingFoldersRequiresOrganizerPermissionRestriction: Output + // only. Whether the current user can change the + // `sharingFoldersRequiresOrganizerPermission` restriction of this + // shared drive. CanChangeSharingFoldersRequiresOrganizerPermissionRestriction bool `json:"canChangeSharingFoldersRequiresOrganizerPermissionRestriction,omitempty"` - // CanComment: Whether the current user can comment on files in this - // shared drive. + // CanComment: Output only. Whether the current user can comment on + // files in this shared drive. CanComment bool `json:"canComment,omitempty"` - // CanCopy: Whether the current user can copy files in this shared - // drive. + // CanCopy: Output only. Whether the current user can copy files in this + // shared drive. CanCopy bool `json:"canCopy,omitempty"` - // CanDeleteChildren: Whether the current user can delete children from - // folders in this shared drive. + // CanDeleteChildren: Output only. Whether the current user can delete + // children from folders in this shared drive. CanDeleteChildren bool `json:"canDeleteChildren,omitempty"` - // CanDeleteDrive: Whether the current user can delete this shared - // drive. Attempting to delete the shared drive may still fail if there - // are untrashed items inside the shared drive. + // CanDeleteDrive: Output only. Whether the current user can delete this + // shared drive. Attempting to delete the shared drive may still fail if + // there are untrashed items inside the shared drive. CanDeleteDrive bool `json:"canDeleteDrive,omitempty"` - // CanDownload: Whether the current user can download files in this - // shared drive. + // CanDownload: Output only. Whether the current user can download files + // in this shared drive. CanDownload bool `json:"canDownload,omitempty"` - // CanEdit: Whether the current user can edit files in this shared drive + // CanEdit: Output only. Whether the current user can edit files in this + // shared drive CanEdit bool `json:"canEdit,omitempty"` - // CanListChildren: Whether the current user can list the children of - // folders in this shared drive. + // CanListChildren: Output only. Whether the current user can list the + // children of folders in this shared drive. CanListChildren bool `json:"canListChildren,omitempty"` - // CanManageMembers: Whether the current user can add members to this - // shared drive or remove them or change their role. + // CanManageMembers: Output only. Whether the current user can add + // members to this shared drive or remove them or change their role. CanManageMembers bool `json:"canManageMembers,omitempty"` - // CanReadRevisions: Whether the current user can read the revisions - // resource of files in this shared drive. + // CanReadRevisions: Output only. Whether the current user can read the + // revisions resource of files in this shared drive. CanReadRevisions bool `json:"canReadRevisions,omitempty"` - // CanRename: Whether the current user can rename files or folders in - // this shared drive. + // CanRename: Output only. Whether the current user can rename files or + // folders in this shared drive. CanRename bool `json:"canRename,omitempty"` - // CanRenameDrive: Whether the current user can rename this shared - // drive. + // CanRenameDrive: Output only. Whether the current user can rename this + // shared drive. CanRenameDrive bool `json:"canRenameDrive,omitempty"` - // CanResetDriveRestrictions: Whether the current user can reset the - // shared drive restrictions to defaults. + // CanResetDriveRestrictions: Output only. Whether the current user can + // reset the shared drive restrictions to defaults. CanResetDriveRestrictions bool `json:"canResetDriveRestrictions,omitempty"` - // CanShare: Whether the current user can share files or folders in this - // shared drive. + // CanShare: Output only. Whether the current user can share files or + // folders in this shared drive. CanShare bool `json:"canShare,omitempty"` - // CanTrashChildren: Whether the current user can trash children from - // folders in this shared drive. + // CanTrashChildren: Output only. Whether the current user can trash + // children from folders in this shared drive. CanTrashChildren bool `json:"canTrashChildren,omitempty"` // ForceSendFields is a list of field names (e.g. "CanAddChildren") to @@ -1865,9 +1864,9 @@ type DriveRestrictions struct { // CopyRequiresWriterPermission: Whether the options to copy, print, or // download files inside this shared drive, should be disabled for - // readers and commenters. When this restriction is set to true, it will - // override the similarly named field to true for any file inside this - // shared drive. + // readers and commenters. When this restriction is set to `true`, it + // will override the similarly named field to `true` for any file inside + // this shared drive. CopyRequiresWriterPermission bool `json:"copyRequiresWriterPermission,omitempty"` // DomainUsersOnly: Whether access to this shared drive and items inside @@ -1917,7 +1916,7 @@ type DriveList struct { // be fetched. Items []*Drive `json:"items,omitempty"` - // Kind: This is always drive#driveList + // Kind: This is always `drive#driveList` Kind string `json:"kind,omitempty"` // NextPageToken: The page token for the next page of shared drives. @@ -1955,21 +1954,25 @@ func (s *DriveList) MarshalJSON() ([]byte, error) { // File: The metadata for a file. type File struct { - // AlternateLink: A link for opening the file in a relevant Google - // editor or viewer. + // AlternateLink: Output only. A link for opening the file in a relevant + // Google editor or viewer. AlternateLink string `json:"alternateLink,omitempty"` - // AppDataContents: Whether this file is in the Application Data folder. + // AppDataContents: Output only. Whether this file is in the Application + // Data folder. AppDataContents bool `json:"appDataContents,omitempty"` - // CanComment: Deprecated: use capabilities/canComment. + // CanComment: Output only. Deprecated: Use `capabilities/canComment` + // instead. CanComment bool `json:"canComment,omitempty"` - // CanReadRevisions: Deprecated: use capabilities/canReadRevisions. + // CanReadRevisions: Output only. Deprecated: Use + // `capabilities/canReadRevisions` instead. CanReadRevisions bool `json:"canReadRevisions,omitempty"` - // Capabilities: Capabilities the current user has on this file. Each - // capability corresponds to a fine-grained action that a user may take. + // Capabilities: Output only. Capabilities the current user has on this + // file. Each capability corresponds to a fine-grained action that a + // user may take. Capabilities *FileCapabilities `json:"capabilities,omitempty"` // ContentRestrictions: Restrictions for accessing the content of the @@ -1980,56 +1983,59 @@ type File struct { // download this file, should be disabled for readers and commenters. CopyRequiresWriterPermission bool `json:"copyRequiresWriterPermission,omitempty"` - // Copyable: Deprecated: use capabilities/canCopy. + // Copyable: Output only. Deprecated: Use `capabilities/canCopy` + // instead. Copyable bool `json:"copyable,omitempty"` // CreatedDate: Create time for this file (formatted RFC 3339 // timestamp). CreatedDate string `json:"createdDate,omitempty"` - // DefaultOpenWithLink: A link to open this file with the user's default - // app for this file. Only populated when the drive.apps.readonly scope - // is used. + // DefaultOpenWithLink: Output only. A link to open this file with the + // user's default app for this file. Only populated when the + // drive.apps.readonly scope is used. DefaultOpenWithLink string `json:"defaultOpenWithLink,omitempty"` // Description: A short description of the file. Description string `json:"description,omitempty"` - // DownloadUrl: Short lived download URL for the file. This field is - // only populated for files with content stored in Google Drive; it - // isn't populated for Docs Editors or shortcut files. + // DownloadUrl: Output only. 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. DownloadUrl string `json:"downloadUrl,omitempty"` - // DriveId: ID of the shared drive the file resides in. Only populated - // for items in shared drives. + // DriveId: Output only. ID of the shared drive the file resides in. + // Only populated for items in shared drives. DriveId string `json:"driveId,omitempty"` - // Editable: Deprecated: use capabilities/canEdit. + // Editable: Output only. Deprecated: Use `capabilities/canEdit` + // instead. Editable bool `json:"editable,omitempty"` - // EmbedLink: A link for embedding the file. + // EmbedLink: Output only. A link for embedding the file. EmbedLink string `json:"embedLink,omitempty"` - // Etag: ETag of the file. + // Etag: Output only. ETag of the file. Etag string `json:"etag,omitempty"` - // ExplicitlyTrashed: Whether this file has been explicitly trashed, as - // opposed to recursively trashed. + // ExplicitlyTrashed: Output only. Whether this file has been explicitly + // trashed, as opposed to recursively trashed. ExplicitlyTrashed bool `json:"explicitlyTrashed,omitempty"` - // ExportLinks: Links for exporting Docs Editors files to specific - // formats. + // ExportLinks: Output only. Links for exporting Docs Editors files to + // specific formats. ExportLinks map[string]string `json:"exportLinks,omitempty"` - // FileExtension: 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 isn't populated for Docs Editors or shortcut files. + // FileExtension: Output only. 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. FileExtension string `json:"fileExtension,omitempty"` - // FileSize: The size of the file's content in bytes. This field is - // populated for files with binary content stored in Google Drive and - // for Docs Editors files; it is not populated for shortcuts or folders. + // FileSize: Output only. Size in bytes of blobs and first party editor + // files. Won't be populated for files that have no size, like shortcuts + // and folders. FileSize int64 `json:"fileSize,omitempty,string"` // FolderColorRgb: Folder color as an RGB hex string if the file is a @@ -2039,60 +2045,63 @@ type File struct { // color in the palette. FolderColorRgb string `json:"folderColorRgb,omitempty"` - // FullFileExtension: 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 isn't populated for Docs Editors or shortcut files. + // FullFileExtension: Output only. 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. FullFileExtension string `json:"fullFileExtension,omitempty"` - // HasAugmentedPermissions: Whether there are permissions directly on - // this file. This field is only populated for items in shared drives. + // HasAugmentedPermissions: Output only. Whether there are permissions + // directly on this file. This field is only populated for items in + // shared drives. HasAugmentedPermissions bool `json:"hasAugmentedPermissions,omitempty"` - // HasThumbnail: Whether this file has a thumbnail. This does not - // indicate whether the requesting app has access to the thumbnail. To - // check access, look for the presence of the thumbnailLink field. + // HasThumbnail: Output only. Whether this file has a thumbnail. This + // does not indicate whether the requesting app has access to the + // thumbnail. To check access, look for the presence of the + // thumbnailLink field. HasThumbnail bool `json:"hasThumbnail,omitempty"` - // HeadRevisionId: The ID of the file's head revision. This field is - // only populated for files with content stored in Google Drive; it - // isn't populated for Docs Editors or shortcut files. + // HeadRevisionId: Output only. 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. HeadRevisionId string `json:"headRevisionId,omitempty"` - // IconLink: A link to the file's icon. + // IconLink: Output only. A link to the file's icon. IconLink string `json:"iconLink,omitempty"` // Id: The ID of the file. Id string `json:"id,omitempty"` - // ImageMediaMetadata: Metadata about image media. This will only be - // present for image types, and its contents will depend on what can be - // parsed from the image content. + // ImageMediaMetadata: Output only. Metadata about image media. This + // will only be present for image types, and its contents will depend on + // what can be parsed from the image content. ImageMediaMetadata *FileImageMediaMetadata `json:"imageMediaMetadata,omitempty"` // IndexableText: Indexable text attributes for the file (can only be - // written). For more information, see Manage file metadata. + // written) IndexableText *FileIndexableText `json:"indexableText,omitempty"` - // IsAppAuthorized: Whether the file was created or opened by the - // requesting app. + // IsAppAuthorized: Output only. Whether the file was created or opened + // by the requesting app. IsAppAuthorized bool `json:"isAppAuthorized,omitempty"` - // Kind: The type of file. This is always drive#file. + // Kind: Output only. The type of file. This is always `drive#file`. Kind string `json:"kind,omitempty"` - // LabelInfo: An overview of the labels on the file. + // LabelInfo: Output only. An overview of the labels on the file. LabelInfo *FileLabelInfo `json:"labelInfo,omitempty"` // Labels: A group of labels for the file. Labels *FileLabels `json:"labels,omitempty"` - // LastModifyingUser: The last user to modify this file. + // LastModifyingUser: Output only. The last user to modify this file. LastModifyingUser *User `json:"lastModifyingUser,omitempty"` - // LastModifyingUserName: Name of the last user to modify this file. + // LastModifyingUserName: Output only. Name of the last user to modify + // this file. LastModifyingUserName string `json:"lastModifyingUserName,omitempty"` // LastViewedByMeDate: Last time this file was viewed by the user @@ -2106,9 +2115,9 @@ type File struct { // MarkedViewedByMeDate: Deprecated. MarkedViewedByMeDate string `json:"markedViewedByMeDate,omitempty"` - // Md5Checksum: An MD5 checksum for the content of this file. This field - // is only populated for files with content stored in Google Drive; it - // isn't populated for Docs Editors or shortcut files. + // Md5Checksum: Output only. 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. Md5Checksum string `json:"md5Checksum,omitempty"` // MimeType: The MIME type of the file. This is only mutable on update @@ -2126,109 +2135,110 @@ type File struct { // setModifiedDate parameter is set. ModifiedDate string `json:"modifiedDate,omitempty"` - // OpenWithLinks: A map of the id of each of the user's apps to a link - // to open this file with that app. Only populated when the - // drive.apps.readonly scope is used. + // OpenWithLinks: Output only. A map of the id of each of the user's + // apps to a link to open this file with that app. Only populated when + // the drive.apps.readonly scope is used. OpenWithLinks map[string]string `json:"openWithLinks,omitempty"` // OriginalFilename: The original filename of the uploaded content if - // available, or else the original value of the title field. This is + // available, or else the original value of the `title` field. This is // only available for files with binary content in Google Drive. OriginalFilename string `json:"originalFilename,omitempty"` - // OwnedByMe: Whether the file is owned by the current user. Not - // populated for items in shared drives. + // OwnedByMe: Output only. Whether the file is owned by the current + // user. Not populated for items in shared drives. OwnedByMe bool `json:"ownedByMe,omitempty"` - // OwnerNames: Name(s) of the owner(s) of this file. Not populated for - // items in shared drives. + // OwnerNames: Output only. Name(s) of the owner(s) of this file. Not + // populated for items in shared drives. OwnerNames []string `json:"ownerNames,omitempty"` - // Owners: The owner of this file. Only certain legacy files may have - // more than one owner. This field isn't populated for items in shared - // drives. + // Owners: Output only. The owner of this file. Only certain legacy + // files may have more than one owner. This field isn't populated for + // items in shared drives. Owners []*User `json:"owners,omitempty"` - // Parents: Collection of parent folders which contain this file. - // If not specified as part of an insert request, the file will be - // placed directly in the user's My Drive folder. If not specified as - // part of a copy request, the file will inherit any discoverable - // parents of the source file. Update requests can also use the - // addParents and removeParents parameters to modify the parents list. + // Parents: Collection of parent folders which contain this file. If not + // specified as part of an insert request, the file will be placed + // directly in the user's My Drive folder. If not specified as part of a + // copy request, the file will inherit any discoverable parents of the + // source file. Update requests can also use the `addParents` and + // `removeParents` parameters to modify the parents list. Parents []*ParentReference `json:"parents,omitempty"` - // PermissionIds: List of permission IDs for users with access to this - // file. + // PermissionIds: Output only. List of permission IDs for users with + // access to this file. PermissionIds []string `json:"permissionIds,omitempty"` - // Permissions: The list of permissions for users with access to this - // file. Not populated for items in shared drives. + // Permissions: Output only. The list of permissions for users with + // access to this file. Not populated for items in shared drives. Permissions []*Permission `json:"permissions,omitempty"` // Properties: The list of properties. Properties []*Property `json:"properties,omitempty"` - // QuotaBytesUsed: The number of quota bytes used by this file. + // QuotaBytesUsed: Output only. The number of quota bytes used by this + // file. QuotaBytesUsed int64 `json:"quotaBytesUsed,omitempty,string"` - // ResourceKey: A key needed to access the item via a shared link. + // ResourceKey: Output only. A key needed to access the item via a + // shared link. ResourceKey string `json:"resourceKey,omitempty"` - // SelfLink: A link back to this file. + // SelfLink: Output only. A link back to this file. SelfLink string `json:"selfLink,omitempty"` - // Sha1Checksum: The SHA1 checksum associated with this file, if - // available. This field is only populated for files with content stored - // in Google Drive; it isn't populated for Docs Editors or shortcut - // files. + // Sha1Checksum: Output only. The SHA1 checksum associated with this + // file, if available. This field is only populated for files with + // content stored in Google Drive; it is not populated for Docs Editors + // or shortcut files. Sha1Checksum string `json:"sha1Checksum,omitempty"` - // Sha256Checksum: The SHA256 checksum associated with this file, if - // available. This field is only populated for files with content stored - // in Google Drive; it isn't populated for Docs Editors or shortcut - // files. + // Sha256Checksum: Output only. The SHA256 checksum associated with this + // file, if available. This field is only populated for files with + // content stored in Google Drive; it is not populated for Docs Editors + // or shortcut files. Sha256Checksum string `json:"sha256Checksum,omitempty"` - // Shareable: Deprecated: use capabilities/canShare. + // Shareable: Output only. Deprecated: Use `capabilities/canShare` + // instead. Shareable bool `json:"shareable,omitempty"` - // Shared: Whether the file has been shared. Not populated for items in - // shared drives. + // Shared: Output only. Whether the file has been shared. Not populated + // for items in shared drives. Shared bool `json:"shared,omitempty"` // SharedWithMeDate: Time at which this file was shared with the user // (formatted RFC 3339 timestamp). SharedWithMeDate string `json:"sharedWithMeDate,omitempty"` - // SharingUser: User that shared the item with the current user, if - // available. + // SharingUser: Output only. User that shared the item with the current + // user, if available. SharingUser *User `json:"sharingUser,omitempty"` // ShortcutDetails: Shortcut file details. Only populated for shortcut // files, which have the mimeType field set to - // application/vnd.google-apps.shortcut. + // `application/vnd.google-apps.shortcut`. ShortcutDetails *FileShortcutDetails `json:"shortcutDetails,omitempty"` - // Spaces: The list of spaces which contain the file. Supported values - // are 'drive', 'appDataFolder' and 'photos'. + // Spaces: Output only. The list of spaces which contain the file. + // Supported values are `drive`, `appDataFolder` and `photos`. Spaces []string `json:"spaces,omitempty"` - // TeamDriveId: Deprecated - use driveId instead. + // TeamDriveId: Output only. Deprecated: Use `driveId` instead. TeamDriveId string `json:"teamDriveId,omitempty"` // Thumbnail: A thumbnail for the file. This will only be used if a // standard thumbnail cannot be generated. Thumbnail *FileThumbnail `json:"thumbnail,omitempty"` - // ThumbnailLink: 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. + // ThumbnailLink: Output only. 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. ThumbnailLink string `json:"thumbnailLink,omitempty"` - // ThumbnailVersion: The thumbnail version for use in thumbnail cache - // invalidation. + // ThumbnailVersion: Output only. The thumbnail version for use in + // thumbnail cache invalidation. ThumbnailVersion int64 `json:"thumbnailVersion,omitempty,string"` // Title: The title of this file. Note that for immutable items such as @@ -2240,32 +2250,32 @@ type File struct { // timestamp). Only populated for items in shared drives. TrashedDate string `json:"trashedDate,omitempty"` - // TrashingUser: If the file has been explicitly trashed, the user who - // trashed it. Only populated for items in shared drives. + // TrashingUser: Output only. If the file has been explicitly trashed, + // the user who trashed it. Only populated for items in shared drives. TrashingUser *User `json:"trashingUser,omitempty"` - // UserPermission: The permissions for the authenticated user on this - // file. + // UserPermission: Output only. The permissions for the authenticated + // user on this file. UserPermission *Permission `json:"userPermission,omitempty"` - // Version: A monotonically increasing version number for the file. This - // reflects every change made to the file on the server, even those not - // visible to the requesting user. + // Version: Output only. A monotonically increasing version number for + // the file. This reflects every change made to the file on the server, + // even those not visible to the requesting user. Version int64 `json:"version,omitempty,string"` - // VideoMediaMetadata: Metadata about video media. This will only be - // present for video types. + // VideoMediaMetadata: Output only. Metadata about video media. This + // will only be present for video types. VideoMediaMetadata *FileVideoMediaMetadata `json:"videoMediaMetadata,omitempty"` - // WebContentLink: A link for downloading the content of the file in a - // browser using cookie based authentication. In cases where the content - // is shared publicly, the content can be downloaded without any - // credentials. + // WebContentLink: Output only. A link for downloading the content of + // the file in a browser using cookie based authentication. In cases + // where the content is shared publicly, the content can be downloaded + // without any credentials. WebContentLink string `json:"webContentLink,omitempty"` - // WebViewLink: A link only available on public folders for viewing - // their static web assets (HTML, CSS, JS, etc) via Google Drive's - // Website Hosting. + // WebViewLink: Output only. A link only available on public folders for + // viewing their static web assets (HTML, CSS, JS, etc) via Google + // Drive's Website Hosting. WebViewLink string `json:"webViewLink,omitempty"` // WritersCanShare: Whether writers can share the document with other @@ -2299,173 +2309,186 @@ func (s *File) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// FileCapabilities: Capabilities the current user has on this file. -// Each capability corresponds to a fine-grained action that a user may -// take. +// FileCapabilities: Output only. Capabilities the current user has on +// this file. Each capability corresponds to a fine-grained action that +// a user may take. type FileCapabilities struct { - // CanAcceptOwnership: Whether the current user is the pending owner of - // the file. Not populated for shared drive files. + // CanAcceptOwnership: Output only. Whether the current user is the + // pending owner of the file. Not populated for shared drive files. CanAcceptOwnership bool `json:"canAcceptOwnership,omitempty"` - // CanAddChildren: Whether the current user can add children to this - // folder. This is always false when the item is not a folder. + // CanAddChildren: Output only. Whether the current user can add + // children to this folder. This is always false when the item is not a + // folder. CanAddChildren bool `json:"canAddChildren,omitempty"` - // CanAddFolderFromAnotherDrive: Whether the current user can add a - // folder from another drive (different shared drive or My Drive) to - // this folder. This is false when the item is not a folder. Only - // populated for items in shared drives. + // CanAddFolderFromAnotherDrive: Output only. Whether the current user + // can add a folder from another drive (different shared drive or My + // Drive) to this folder. This is false when the item is not a folder. + // Only populated for items in shared drives. CanAddFolderFromAnotherDrive bool `json:"canAddFolderFromAnotherDrive,omitempty"` - // CanAddMyDriveParent: Whether the current user can add a parent for - // the item without removing an existing parent in the same request. Not - // populated for shared drive files. + // CanAddMyDriveParent: Output only. Whether the current user can add a + // parent for the item without removing an existing parent in the same + // request. Not populated for shared drive files. CanAddMyDriveParent bool `json:"canAddMyDriveParent,omitempty"` - // CanChangeCopyRequiresWriterPermission: Whether the current user can - // change the copyRequiresWriterPermission restriction of this file. + // CanChangeCopyRequiresWriterPermission: Output only. Whether the + // current user can change the `copyRequiresWriterPermission` + // restriction of this file. CanChangeCopyRequiresWriterPermission bool `json:"canChangeCopyRequiresWriterPermission,omitempty"` - // CanChangeRestrictedDownload: Deprecated + // CanChangeRestrictedDownload: Output only. Deprecated. CanChangeRestrictedDownload bool `json:"canChangeRestrictedDownload,omitempty"` - // CanChangeSecurityUpdateEnabled: Whether the current user can change - // the securityUpdateEnabled field on link share metadata. + // CanChangeSecurityUpdateEnabled: Output only. Whether the current user + // can change the securityUpdateEnabled field on link share metadata. CanChangeSecurityUpdateEnabled bool `json:"canChangeSecurityUpdateEnabled,omitempty"` - // CanComment: Whether the current user can comment on this file. + // CanComment: Output only. Whether the current user can comment on this + // file. CanComment bool `json:"canComment,omitempty"` - // CanCopy: Whether the current user can copy this file. For an item in - // a shared drive, whether the current user can copy non-folder - // descendants of this item, or this item itself if it is not a folder. + // CanCopy: Output only. Whether the current user can copy this file. + // For an item in a shared drive, whether the current user can copy + // non-folder descendants of this item, or this item itself if it is not + // a folder. CanCopy bool `json:"canCopy,omitempty"` - // CanDelete: Whether the current user can delete this file. + // CanDelete: Output only. Whether the current user can delete this + // file. CanDelete bool `json:"canDelete,omitempty"` - // CanDeleteChildren: Whether the current user can delete children of - // this folder. This is false when the item is not a folder. Only - // populated for items in shared drives. + // CanDeleteChildren: Output only. Whether the current user can delete + // children of this folder. This is false when the item is not a folder. + // Only populated for items in shared drives. CanDeleteChildren bool `json:"canDeleteChildren,omitempty"` - // CanDownload: Whether the current user can download this file. + // CanDownload: Output only. Whether the current user can download this + // file. CanDownload bool `json:"canDownload,omitempty"` - // CanEdit: Whether the current user can edit this file. Other factors - // may limit the type of changes a user can make to a file. For example, - // see canChangeCopyRequiresWriterPermission or canModifyContent. + // CanEdit: Output only. Whether the current user can edit this file. + // Other factors may limit the type of changes a user can make to a + // file. For example, see `canChangeCopyRequiresWriterPermission` or + // `canModifyContent`. CanEdit bool `json:"canEdit,omitempty"` - // CanListChildren: Whether the current user can list the children of - // this folder. This is always false when the item is not a folder. + // CanListChildren: Output only. Whether the current user can list the + // children of this folder. This is always false when the item is not a + // folder. CanListChildren bool `json:"canListChildren,omitempty"` - // CanModifyContent: Whether the current user can modify the content of - // this file. + // CanModifyContent: Output only. Whether the current user can modify + // the content of this file. CanModifyContent bool `json:"canModifyContent,omitempty"` - // CanModifyContentRestriction: Whether the current user can modify - // restrictions on content of this file. + // CanModifyContentRestriction: Output only. Whether the current user + // can modify restrictions on content of this file. CanModifyContentRestriction bool `json:"canModifyContentRestriction,omitempty"` - // CanModifyLabels: Whether the current user can modify the labels on - // this file. + // CanModifyLabels: Output only. Whether the current user can modify the + // labels on the file. CanModifyLabels bool `json:"canModifyLabels,omitempty"` - // CanMoveChildrenOutOfDrive: Whether the current user can move children - // of this folder outside of the shared drive. This is false when the - // item is not a folder. Only populated for items in shared drives. + // CanMoveChildrenOutOfDrive: Output only. Whether the current user can + // move children of this folder outside of the shared drive. This is + // false when the item is not a folder. Only populated for items in + // shared drives. CanMoveChildrenOutOfDrive bool `json:"canMoveChildrenOutOfDrive,omitempty"` - // CanMoveChildrenOutOfTeamDrive: Deprecated - use - // canMoveChildrenOutOfDrive instead. + // CanMoveChildrenOutOfTeamDrive: Output only. Deprecated: Use + // `canMoveChildrenOutOfDrive` instead. CanMoveChildrenOutOfTeamDrive bool `json:"canMoveChildrenOutOfTeamDrive,omitempty"` - // CanMoveChildrenWithinDrive: Whether the current user can move - // children of this folder within this drive. This is false when the - // item is not a folder. Note that a request to move the child may still - // fail depending on the current user's access to the child and to the - // destination folder. + // CanMoveChildrenWithinDrive: Output only. Whether the current user can + // move children of this folder within this drive. This is false when + // the item is not a folder. Note that a request to move the child may + // still fail depending on the current user's access to the child and to + // the destination folder. CanMoveChildrenWithinDrive bool `json:"canMoveChildrenWithinDrive,omitempty"` - // CanMoveChildrenWithinTeamDrive: Deprecated - use - // canMoveChildrenWithinDrive instead. + // CanMoveChildrenWithinTeamDrive: Output only. Deprecated: Use + // `canMoveChildrenWithinDrive` instead. CanMoveChildrenWithinTeamDrive bool `json:"canMoveChildrenWithinTeamDrive,omitempty"` - // CanMoveItemIntoTeamDrive: Deprecated - use canMoveItemOutOfDrive - // instead. + // CanMoveItemIntoTeamDrive: Output only. Deprecated: Use + // `canMoveItemOutOfDrive` instead. CanMoveItemIntoTeamDrive bool `json:"canMoveItemIntoTeamDrive,omitempty"` - // CanMoveItemOutOfDrive: Whether the current user can move this item - // outside of this drive by changing its parent. Note that a request to - // change the parent of the item may still fail depending on the new - // parent that is being added. + // CanMoveItemOutOfDrive: Output only. Whether the current user can move + // this item outside of this drive by changing its parent. Note that a + // request to change the parent of the item may still fail depending on + // the new parent that is being added. CanMoveItemOutOfDrive bool `json:"canMoveItemOutOfDrive,omitempty"` - // CanMoveItemOutOfTeamDrive: Deprecated - use canMoveItemOutOfDrive - // instead. + // CanMoveItemOutOfTeamDrive: Output only. Deprecated: Use + // `canMoveItemOutOfDrive` instead. CanMoveItemOutOfTeamDrive bool `json:"canMoveItemOutOfTeamDrive,omitempty"` - // CanMoveItemWithinDrive: Whether the current user can move this item - // within this drive. Note that a request to change the parent of the - // item may still fail depending on the new parent that is being added - // and the parent that is being removed. + // CanMoveItemWithinDrive: Output only. Whether the current user can + // move this item within this drive. Note that a request to change the + // parent of the item may still fail depending on the new parent that is + // being added and the parent that is being removed. CanMoveItemWithinDrive bool `json:"canMoveItemWithinDrive,omitempty"` - // CanMoveItemWithinTeamDrive: Deprecated - use canMoveItemWithinDrive - // instead. + // CanMoveItemWithinTeamDrive: Output only. Deprecated: Use + // `canMoveItemWithinDrive` instead. CanMoveItemWithinTeamDrive bool `json:"canMoveItemWithinTeamDrive,omitempty"` - // CanMoveTeamDriveItem: Deprecated - use canMoveItemWithinDrive or - // canMoveItemOutOfDrive instead. + // CanMoveTeamDriveItem: Output only. Deprecated: Use + // `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. CanMoveTeamDriveItem bool `json:"canMoveTeamDriveItem,omitempty"` - // CanReadDrive: Whether the current user can read the shared drive to - // which this file belongs. Only populated for items in shared drives. + // CanReadDrive: Output only. Whether the current user can read the + // shared drive to which this file belongs. Only populated for items in + // shared drives. CanReadDrive bool `json:"canReadDrive,omitempty"` - // CanReadLabels: Whether the current user can read the labels on this - // file. + // CanReadLabels: Output only. Whether the current user can read the + // labels on the file. CanReadLabels bool `json:"canReadLabels,omitempty"` - // CanReadRevisions: Whether the current user can read the revisions - // resource of this file. For a shared drive item, whether revisions of - // non-folder descendants of this item, or this item itself if it isn't - // a folder, can be read. + // CanReadRevisions: Output only. Whether the current user can read the + // revisions resource of this file. For a shared drive item, whether + // revisions of non-folder descendants of this item, or this item itself + // if it is not a folder, can be read. CanReadRevisions bool `json:"canReadRevisions,omitempty"` - // CanReadTeamDrive: Deprecated - use canReadDrive instead. + // CanReadTeamDrive: Output only. Deprecated: Use `canReadDrive` + // instead. CanReadTeamDrive bool `json:"canReadTeamDrive,omitempty"` - // CanRemoveChildren: Whether the current user can remove children from - // this folder. This is always false when the item is not a folder. For - // a folder in a shared drive, use canDeleteChildren or canTrashChildren - // instead. + // CanRemoveChildren: Output only. Whether the current user can remove + // children from this folder. This is always false when the item is not + // a folder. For a folder in a shared drive, use `canDeleteChildren` or + // `canTrashChildren` instead. CanRemoveChildren bool `json:"canRemoveChildren,omitempty"` - // CanRemoveMyDriveParent: Whether the current user can remove a parent - // from the item without adding another parent in the same request. Not - // populated for shared drive files. + // CanRemoveMyDriveParent: Output only. Whether the current user can + // remove a parent from the item without adding another parent in the + // same request. Not populated for shared drive files. CanRemoveMyDriveParent bool `json:"canRemoveMyDriveParent,omitempty"` - // CanRename: Whether the current user can rename this file. + // CanRename: Output only. Whether the current user can rename this + // file. CanRename bool `json:"canRename,omitempty"` - // CanShare: Whether the current user can modify the sharing settings - // for this file. + // CanShare: Output only. Whether the current user can modify the + // sharing settings for this file. CanShare bool `json:"canShare,omitempty"` - // CanTrash: Whether the current user can move this file to trash. + // CanTrash: Output only. Whether the current user can move this file to + // trash. CanTrash bool `json:"canTrash,omitempty"` - // CanTrashChildren: Whether the current user can trash children of this - // folder. This is false when the item is not a folder. Only populated - // for items in shared drives. + // CanTrashChildren: Output only. Whether the current user can trash + // children of this folder. This is false when the item is not a folder. + // Only populated for items in shared drives. CanTrashChildren bool `json:"canTrashChildren,omitempty"` - // CanUntrash: Whether the current user can restore this file from - // trash. + // CanUntrash: Output only. Whether the current user can restore this + // file from trash. CanUntrash bool `json:"canUntrash,omitempty"` // ForceSendFields is a list of field names (e.g. "CanAcceptOwnership") @@ -2492,74 +2515,84 @@ func (s *FileCapabilities) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// FileImageMediaMetadata: Metadata about image media. This will only be -// present for image types, and its contents will depend on what can be -// parsed from the image content. +// FileImageMediaMetadata: Output only. Metadata about image media. This +// will only be present for image types, and its contents will depend on +// what can be parsed from the image content. type FileImageMediaMetadata struct { - // Aperture: The aperture used to create the photo (f-number). + // Aperture: Output only. The aperture used to create the photo + // (f-number). Aperture float64 `json:"aperture,omitempty"` - // CameraMake: The make of the camera used to create the photo. + // CameraMake: Output only. The make of the camera used to create the + // photo. CameraMake string `json:"cameraMake,omitempty"` - // CameraModel: The model of the camera used to create the photo. + // CameraModel: Output only. The model of the camera used to create the + // photo. CameraModel string `json:"cameraModel,omitempty"` - // ColorSpace: The color space of the photo. + // ColorSpace: Output only. The color space of the photo. ColorSpace string `json:"colorSpace,omitempty"` - // Date: The date and time the photo was taken (EXIF format timestamp). + // Date: Output only. The date and time the photo was taken (EXIF format + // timestamp). Date string `json:"date,omitempty"` - // ExposureBias: The exposure bias of the photo (APEX value). + // ExposureBias: Output only. The exposure bias of the photo (APEX + // value). ExposureBias float64 `json:"exposureBias,omitempty"` - // ExposureMode: The exposure mode used to create the photo. + // ExposureMode: Output only. The exposure mode used to create the + // photo. ExposureMode string `json:"exposureMode,omitempty"` - // ExposureTime: The length of the exposure, in seconds. + // ExposureTime: Output only. The length of the exposure, in seconds. ExposureTime float64 `json:"exposureTime,omitempty"` - // FlashUsed: Whether a flash was used to create the photo. + // FlashUsed: Output only. Whether a flash was used to create the photo. FlashUsed bool `json:"flashUsed,omitempty"` - // FocalLength: The focal length used to create the photo, in - // millimeters. + // FocalLength: Output only. The focal length used to create the photo, + // in millimeters. FocalLength float64 `json:"focalLength,omitempty"` - // Height: The height of the image in pixels. + // Height: Output only. The height of the image in pixels. Height int64 `json:"height,omitempty"` - // IsoSpeed: The ISO speed used to create the photo. + // IsoSpeed: Output only. The ISO speed used to create the photo. IsoSpeed int64 `json:"isoSpeed,omitempty"` - // Lens: The lens used to create the photo. + // Lens: Output only. The lens used to create the photo. Lens string `json:"lens,omitempty"` - // Location: Geographic location information stored in the image. + // Location: Output only. Geographic location information stored in the + // image. Location *FileImageMediaMetadataLocation `json:"location,omitempty"` - // MaxApertureValue: The smallest f-number of the lens at the focal - // length used to create the photo (APEX value). + // MaxApertureValue: Output only. The smallest f-number of the lens at + // the focal length used to create the photo (APEX value). MaxApertureValue float64 `json:"maxApertureValue,omitempty"` - // MeteringMode: The metering mode used to create the photo. + // MeteringMode: Output only. The metering mode used to create the + // photo. MeteringMode string `json:"meteringMode,omitempty"` - // Rotation: The number of clockwise 90 degree rotations applied from - // the image's original orientation. + // Rotation: Output only. The number of clockwise 90 degree rotations + // applied from the image's original orientation. Rotation int64 `json:"rotation,omitempty"` - // Sensor: The type of sensor used to create the photo. + // Sensor: Output only. The type of sensor used to create the photo. Sensor string `json:"sensor,omitempty"` - // SubjectDistance: The distance to the subject of the photo, in meters. + // SubjectDistance: Output only. The distance to the subject of the + // photo, in meters. SubjectDistance int64 `json:"subjectDistance,omitempty"` - // WhiteBalance: The white balance mode used to create the photo. + // WhiteBalance: Output only. The white balance mode used to create the + // photo. WhiteBalance string `json:"whiteBalance,omitempty"` - // Width: The width of the image in pixels. + // Width: Output only. The width of the image in pixels. Width int64 `json:"width,omitempty"` // ForceSendFields is a list of field names (e.g. "Aperture") to @@ -2607,16 +2640,16 @@ func (s *FileImageMediaMetadata) UnmarshalJSON(data []byte) error { return nil } -// FileImageMediaMetadataLocation: Geographic location information -// stored in the image. +// FileImageMediaMetadataLocation: Output only. Geographic location +// information stored in the image. type FileImageMediaMetadataLocation struct { - // Altitude: The altitude stored in the image. + // Altitude: Output only. The altitude stored in the image. Altitude float64 `json:"altitude,omitempty"` - // Latitude: The latitude stored in the image. + // Latitude: Output only. The latitude stored in the image. Latitude float64 `json:"latitude,omitempty"` - // Longitude: The longitude stored in the image. + // Longitude: Output only. The longitude stored in the image. Longitude float64 `json:"longitude,omitempty"` // ForceSendFields is a list of field names (e.g. "Altitude") to @@ -2661,7 +2694,7 @@ func (s *FileImageMediaMetadataLocation) UnmarshalJSON(data []byte) error { } // FileIndexableText: Indexable text attributes for the file (can only -// be written). For more information, see Manage file metadata. +// be written) type FileIndexableText struct { // Text: The text to be indexed for this file. Text string `json:"text,omitempty"` @@ -2689,10 +2722,11 @@ func (s *FileIndexableText) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// FileLabelInfo: An overview of the labels on the file. +// FileLabelInfo: Output only. An overview of the labels on the file. type FileLabelInfo struct { - // Labels: The set of labels on the file as requested by the label IDs - // in the includeLabels parameter. By default, no labels are returned. + // Labels: Output only. The set of labels on the file as requested by + // the label IDs in the `includeLabels` parameter. By default, no labels + // are returned. Labels []*Label `json:"labels,omitempty"` // ForceSendFields is a list of field names (e.g. "Labels") to @@ -2720,24 +2754,23 @@ func (s *FileLabelInfo) MarshalJSON() ([]byte, error) { // FileLabels: A group of labels for the file. type FileLabels struct { - // Hidden: Deprecated. + // Hidden: Output only. Deprecated. Hidden bool `json:"hidden,omitempty"` - // Modified: Whether the file has been modified by this user. + // Modified: Output only. Whether the file has been modified by this + // user. Modified bool `json:"modified,omitempty"` - // Restricted: Deprecated - use copyRequiresWriterPermission instead. + // Restricted: Output only. Deprecated: Use + // `copyRequiresWriterPermission` instead. Restricted bool `json:"restricted,omitempty"` // Starred: Whether this file is starred by the user. Starred bool `json:"starred,omitempty"` - // Trashed: Whether the file has been trashed, either explicitly or from - // a trashed parent folder. Only the owner may trash a file. The trashed - // item is excluded from all files.list responses returned for any user - // who does not own the file. However, all users with access to the file - // can see the trashed item metadata in an API response. All users with - // access can copy, download, export, and share the file. + // Trashed: Whether this file has been trashed. This label applies to + // all users accessing the file; however, only owners are allowed to see + // and untrash files. Trashed bool `json:"trashed,omitempty"` // Viewed: Whether this file has been viewed by this user. @@ -2769,12 +2802,12 @@ func (s *FileLabels) MarshalJSON() ([]byte, error) { // FileLinkShareMetadata: Contains details about the link URLs that // clients are using to refer to this item. type FileLinkShareMetadata struct { - // SecurityUpdateEligible: Whether the file is eligible for security - // update. + // SecurityUpdateEligible: Output only. Whether the file is eligible for + // security update. SecurityUpdateEligible bool `json:"securityUpdateEligible,omitempty"` - // SecurityUpdateEnabled: Whether the security update is enabled for - // this file. + // SecurityUpdateEnabled: Output only. Whether the security update is + // enabled for this file. SecurityUpdateEnabled bool `json:"securityUpdateEnabled,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -2804,17 +2837,17 @@ func (s *FileLinkShareMetadata) MarshalJSON() ([]byte, error) { // FileShortcutDetails: Shortcut file details. Only populated for // shortcut files, which have the mimeType field set to -// application/vnd.google-apps.shortcut. +// `application/vnd.google-apps.shortcut`. type FileShortcutDetails struct { // TargetId: The ID of the file that this shortcut points to. TargetId string `json:"targetId,omitempty"` - // TargetMimeType: The MIME type of the file that this shortcut points - // to. The value of this field is a snapshot of the target's MIME type, - // captured when the shortcut is created. + // TargetMimeType: Output only. The MIME type of the file that this + // shortcut points to. The value of this field is a snapshot of the + // target's MIME type, captured when the shortcut is created. TargetMimeType string `json:"targetMimeType,omitempty"` - // TargetResourceKey: The ResourceKey for the target file. + // TargetResourceKey: Output only. The ResourceKey for the target file. TargetResourceKey string `json:"targetResourceKey,omitempty"` // ForceSendFields is a list of field names (e.g. "TargetId") to @@ -2873,16 +2906,17 @@ func (s *FileThumbnail) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// FileVideoMediaMetadata: Metadata about video media. This will only be -// present for video types. +// FileVideoMediaMetadata: Output only. Metadata about video media. This +// will only be present for video types. type FileVideoMediaMetadata struct { - // DurationMillis: The duration of the video in milliseconds. + // DurationMillis: Output only. The duration of the video in + // milliseconds. DurationMillis int64 `json:"durationMillis,omitempty,string"` - // Height: The height of the video in pixels. + // Height: Output only. The height of the video in pixels. Height int64 `json:"height,omitempty"` - // Width: The width of the video in pixels. + // Width: Output only. The width of the video in pixels. Width int64 `json:"width,omitempty"` // ForceSendFields is a list of field names (e.g. "DurationMillis") to @@ -2927,7 +2961,7 @@ type FileList struct { // fetched. Items []*File `json:"items,omitempty"` - // Kind: This is always drive#fileList. + // Kind: This is always `drive#fileList`. Kind string `json:"kind,omitempty"` // NextLink: A link to the next page of files. @@ -2976,7 +3010,7 @@ type GeneratedIds struct { // space. Ids []string `json:"ids,omitempty"` - // Kind: This is always drive#generatedIds + // Kind: This is always `drive#generatedIds` Kind string `json:"kind,omitempty"` // Space: The type of file that can be created with these IDs. @@ -3009,15 +3043,15 @@ func (s *GeneratedIds) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Label: Representation of a label and its fields. +// Label: Representation of a label and label fields. type Label struct { - // Fields: A map of the label's fields keyed by the field ID. + // Fields: A map of the fields on the label, keyed by the field's ID. Fields map[string]LabelField `json:"fields,omitempty"` // Id: The ID of the label. Id string `json:"id,omitempty"` - // Kind: This is always drive#label + // Kind: This is always `drive#label` Kind string `json:"kind,omitempty"` // RevisionId: The revision ID of the label. @@ -3046,37 +3080,33 @@ func (s *Label) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// LabelField: Representation of a label field. +// LabelField: Representation of field, which is a typed key-value pair. type LabelField struct { // DateString: Only present if valueType is dateString. RFC 3339 // formatted date: YYYY-MM-DD. DateString []string `json:"dateString,omitempty"` - // Id: The identifier of this field. + // Id: The identifier of this label field. Id string `json:"id,omitempty"` - // Integer: Only present if valueType is integer. + // Integer: Only present if `valueType` is `integer`. Integer googleapi.Int64s `json:"integer,omitempty"` - // Kind: This is always drive#labelField. + // Kind: This is always `drive#labelField`. Kind string `json:"kind,omitempty"` - // Selection: Only present if valueType is selection. + // Selection: Only present if `valueType` is `selection` Selection []string `json:"selection,omitempty"` - // Text: Only present if valueType is text. + // Text: Only present if `valueType` is `text`. Text []string `json:"text,omitempty"` - // User: Only present if valueType is user. + // User: Only present if `valueType` is `user`. User []*User `json:"user,omitempty"` // ValueType: The field type. While new values may be supported in the - // future, the following are currently allowed: - // - dateString - // - integer - // - selection - // - text - // - user + // future, the following are currently allowed: * `dateString` * + // `integer` * `selection` * `text` * `user` ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "DateString") to @@ -3107,23 +3137,26 @@ type LabelFieldModification struct { // FieldId: The ID of the field to be modified. FieldId string `json:"fieldId,omitempty"` - // Kind: This is always drive#labelFieldModification. + // Kind: This is always `drive#labelFieldModification`. Kind string `json:"kind,omitempty"` - // SetDateValues: Replaces a dateString field with these new values. The - // values must be strings in the RFC 3339 full-date format: YYYY-MM-DD. + // SetDateValues: Replaces the value of a dateString Field with these + // new values. The string must be in the RFC 3339 full-date format: + // YYYY-MM-DD. SetDateValues []string `json:"setDateValues,omitempty"` - // SetIntegerValues: Replaces an integer field with these new values. + // SetIntegerValues: Replaces the value of an `integer` field with these + // new values. SetIntegerValues googleapi.Int64s `json:"setIntegerValues,omitempty"` - // SetSelectionValues: Replaces a selection field with these new values. + // SetSelectionValues: Replaces a `selection` field with these new + // values. SetSelectionValues []string `json:"setSelectionValues,omitempty"` - // SetTextValues: Replaces a text field with these new values. + // SetTextValues: Sets the value of a `text` field. SetTextValues []string `json:"setTextValues,omitempty"` - // SetUserValues: Replaces a user field with these new values. The + // SetUserValues: Replaces a `user` field with these new values. The // values must be valid email addresses. SetUserValues []string `json:"setUserValues,omitempty"` @@ -3153,12 +3186,12 @@ func (s *LabelFieldModification) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// LabelList: A list of labels. +// LabelList: A list of labels applied to a file. type LabelList struct { // Items: The list of labels. Items []*Label `json:"items,omitempty"` - // Kind: This is always drive#labelList + // Kind: This is always `drive#labelList` Kind string `json:"kind,omitempty"` // NextPageToken: The page token for the next page of labels. This field @@ -3201,7 +3234,7 @@ type LabelModification struct { // FieldModifications: The list of modifications to this label's fields. FieldModifications []*LabelFieldModification `json:"fieldModifications,omitempty"` - // Kind: This is always drive#labelModification. + // Kind: This is always `drive#labelModification`. Kind string `json:"kind,omitempty"` // LabelId: The ID of the label to modify. @@ -3236,9 +3269,9 @@ func (s *LabelModification) MarshalJSON() ([]byte, error) { // ModifyLabelsRequest: A request to modify the set of labels on a file. // This request may contain many modifications that will either all -// succeed or all fail transactionally. +// succeed or all fail atomically. type ModifyLabelsRequest struct { - // Kind: This is always drive#modifyLabelsRequest + // Kind: This is always `drive#modifyLabelsRequest`. Kind string `json:"kind,omitempty"` // LabelModifications: The list of modifications to apply to the labels @@ -3272,7 +3305,7 @@ func (s *ModifyLabelsRequest) MarshalJSON() ([]byte, error) { // contains only those labels which were added or updated by the // request. type ModifyLabelsResponse struct { - // Kind: This is always drive#modifyLabelsResponse + // Kind: This is always `drive#modifyLabelsResponse` Kind string `json:"kind,omitempty"` // ModifiedLabels: The list of labels which were added or updated by the @@ -3314,7 +3347,7 @@ type ParentList struct { // Items: The list of parents. Items []*ParentReference `json:"items,omitempty"` - // Kind: This is always drive#parentList. + // Kind: This is always `drive#parentList`. Kind string `json:"kind,omitempty"` // SelfLink: A link back to this list. @@ -3352,16 +3385,16 @@ type ParentReference struct { // Id: The ID of the parent. Id string `json:"id,omitempty"` - // IsRoot: Whether or not the parent is the root folder. + // IsRoot: Output only. Whether or not the parent is the root folder. IsRoot bool `json:"isRoot,omitempty"` - // Kind: This is always drive#parentReference. + // Kind: Output only. This is always `drive#parentReference`. Kind string `json:"kind,omitempty"` - // ParentLink: A link to the parent. + // ParentLink: Output only. A link to the parent. ParentLink string `json:"parentLink,omitempty"` - // SelfLink: A link back to this reference. + // SelfLink: Output only. A link back to this reference. SelfLink string `json:"selfLink,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -3393,97 +3426,90 @@ func (s *ParentReference) MarshalJSON() ([]byte, error) { // Permission: A permission for a file. type Permission struct { - // AdditionalRoles: Additional roles for this user. Only commenter is + // AdditionalRoles: Additional roles for this user. Only `commenter` is // currently allowed, though more may be supported in the future. AdditionalRoles []string `json:"additionalRoles,omitempty"` - // AuthKey: Deprecated. + // AuthKey: Output only. Deprecated. AuthKey string `json:"authKey,omitempty"` - // Deleted: Whether the account associated with this permission has been - // deleted. This field only pertains to user and group permissions. + // Deleted: Output only. Whether the account associated with this + // permission has been deleted. This field only pertains to user and + // group permissions. Deleted bool `json:"deleted,omitempty"` - // Domain: The domain name of the entity this permission refers to. This - // is an output-only field which is present when the permission type is - // user, group or domain. + // Domain: Output only. The domain name of the entity this permission + // refers to. This is an output-only field which is present when the + // permission type is `user`, `group` or `domain`. Domain string `json:"domain,omitempty"` - // EmailAddress: The email address of the user or group this permission - // refers to. This is an output-only field which is present when the - // permission type is user or group. + // EmailAddress: Output only. The email address of the user or group + // this permission refers to. This is an output-only field which is + // present when the permission type is `user` or `group`. EmailAddress string `json:"emailAddress,omitempty"` - // Etag: The ETag of the permission. + // Etag: Output only. The ETag of the permission. Etag string `json:"etag,omitempty"` // ExpirationDate: The time at which this permission will expire (RFC - // 3339 date-time). Expiration dates have the following restrictions: - // - // - They cannot be set on shared drive items - // - They can only be set on user and group permissions - // - The date must be in the future - // - The date cannot be more than a year in the future + // 3339 date-time). Expiration dates have the following restrictions: - + // They cannot be set on shared drive items - They can only be set on + // user and group permissions - The date must be in the future - The + // date cannot be more than a year in the future - The date can only be + // set on drive.permissions.update or drive.permissions.patch requests ExpirationDate string `json:"expirationDate,omitempty"` // Id: The ID of the user this permission refers to, and identical to - // the permissionId in the About and Files resources. When making a - // drive.permissions.insert request, exactly one of the id or value - // fields must be specified unless the permission type is anyone, in - // which case both id and value are ignored. + // the `permissionId` in the About and Files resources. When making a + // `drive.permissions.insert` request, exactly one of the `id` or + // `value` fields must be specified unless the permission type is + // `anyone`, in which case both `id` and `value` are ignored. Id string `json:"id,omitempty"` - // Kind: This is always drive#permission. + // Kind: Output only. This is always `drive#permission`. Kind string `json:"kind,omitempty"` - // Name: The name for this permission. + // Name: Output only. The name for this permission. Name string `json:"name,omitempty"` // PendingOwner: Whether the account associated with this permission is - // a pending owner. Only populated for user type permissions for files + // a pending owner. Only populated for `user` type permissions for files // that are not in a shared drive. PendingOwner bool `json:"pendingOwner,omitempty"` - // PermissionDetails: Details of whether the permissions on this shared - // drive item are inherited or directly on this item. This is an - // output-only field which is present only for shared drive items. + // PermissionDetails: Output only. Details of whether the permissions on + // this shared drive item are inherited or directly on this item. This + // is an output-only field which is present only for shared drive items. PermissionDetails []*PermissionPermissionDetails `json:"permissionDetails,omitempty"` - // PhotoLink: A link to the profile photo, if available. + // PhotoLink: Output only. A link to the profile photo, if available. PhotoLink string `json:"photoLink,omitempty"` // Role: The primary role for this user. While new values may be - // supported in the future, the following are currently allowed: - // - owner - // - organizer - // - fileOrganizer - // - writer - // - reader + // supported in the future, the following are currently allowed: * + // `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` Role string `json:"role,omitempty"` - // SelfLink: A link back to this permission. + // SelfLink: Output only. A link back to this permission. SelfLink string `json:"selfLink,omitempty"` - // TeamDrivePermissionDetails: Deprecated - use permissionDetails - // instead. + // TeamDrivePermissionDetails: Output only. Deprecated: Use + // `permissionDetails` instead. TeamDrivePermissionDetails []*PermissionTeamDrivePermissionDetails `json:"teamDrivePermissionDetails,omitempty"` - // Type: The account type. Allowed values are: - // - user - // - group - // - domain - // - anyone + // Type: The account type. Allowed values are: * `user` * `group` * + // `domain` * `anyone` Type string `json:"type,omitempty"` // Value: The email address or domain name for the entity. This is used // during inserts and is not populated in responses. When making a - // drive.permissions.insert request, exactly one of the id or value - // fields must be specified unless the permission type is anyone, in - // which case both id and value are ignored. + // `drive.permissions.insert` request, exactly one of the `id` or + // `value` fields must be specified unless the permission type is + // `anyone`, in which case both `id` and `value` are ignored. Value string `json:"value,omitempty"` // View: Indicates the view for this permission. Only populated for - // permissions that belong to a view. published is the only supported + // permissions that belong to a view. `published` is the only supported // value. View string `json:"view,omitempty"` @@ -3519,30 +3545,27 @@ func (s *Permission) MarshalJSON() ([]byte, error) { } type PermissionPermissionDetails struct { - // AdditionalRoles: Additional roles for this user. Only commenter is - // currently possible, though more may be supported in the future. + // AdditionalRoles: Output only. Additional roles for this user. Only + // `commenter` is currently possible, though more may be supported in + // the future. AdditionalRoles []string `json:"additionalRoles,omitempty"` - // Inherited: Whether this permission is inherited. This field is always - // populated. This is an output-only field. + // Inherited: Output only. Whether this permission is inherited. This + // field is always populated. This is an output-only field. Inherited bool `json:"inherited,omitempty"` - // InheritedFrom: The ID of the item from which this permission is - // inherited. This is an output-only field. + // InheritedFrom: Output only. The ID of the item from which this + // permission is inherited. This is an output-only field. InheritedFrom string `json:"inheritedFrom,omitempty"` - // PermissionType: The permission type for this user. While new values - // may be added in future, the following are currently possible: - // - file - // - member + // PermissionType: Output only. The permission type for this user. While + // new values may be added in future, the following are currently + // possible: * `file` * `member` PermissionType string `json:"permissionType,omitempty"` - // Role: The primary role for this user. While new values may be added - // in the future, the following are currently possible: - // - organizer - // - fileOrganizer - // - writer - // - reader + // Role: Output only. The primary role for this user. While new values + // may be added in the future, the following are currently possible: * + // `organizer` * `fileOrganizer` * `writer` * `reader` Role string `json:"role,omitempty"` // ForceSendFields is a list of field names (e.g. "AdditionalRoles") to @@ -3570,22 +3593,23 @@ func (s *PermissionPermissionDetails) MarshalJSON() ([]byte, error) { } type PermissionTeamDrivePermissionDetails struct { - // AdditionalRoles: Deprecated - use permissionDetails/additionalRoles - // instead. + // AdditionalRoles: Output only. Deprecated: Use + // `permissionDetails/additionalRoles` instead. AdditionalRoles []string `json:"additionalRoles,omitempty"` - // Inherited: Deprecated - use permissionDetails/inherited instead. + // Inherited: Output only. Deprecated: Use `permissionDetails/inherited` + // instead. Inherited bool `json:"inherited,omitempty"` - // InheritedFrom: Deprecated - use permissionDetails/inheritedFrom - // instead. + // InheritedFrom: Output only. Deprecated: Use + // `permissionDetails/inheritedFrom` instead. InheritedFrom string `json:"inheritedFrom,omitempty"` - // Role: Deprecated - use permissionDetails/role instead. + // Role: Output only. Deprecated: Use `permissionDetails/role` instead. Role string `json:"role,omitempty"` - // TeamDrivePermissionType: Deprecated - use - // permissionDetails/permissionType instead. + // TeamDrivePermissionType: Output only. Deprecated: Use + // `permissionDetails/permissionType` instead. TeamDrivePermissionType string `json:"teamDrivePermissionType,omitempty"` // ForceSendFields is a list of field names (e.g. "AdditionalRoles") to @@ -3617,7 +3641,7 @@ type PermissionId struct { // Id: The permission ID. Id string `json:"id,omitempty"` - // Kind: This is always drive#permissionId. + // Kind: This is always `drive#permissionId`. Kind string `json:"kind,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -3655,7 +3679,7 @@ type PermissionList struct { // Items: The list of permissions. Items []*Permission `json:"items,omitempty"` - // Kind: This is always drive#permissionList. + // Kind: This is always `drive#permissionList`. Kind string `json:"kind,omitempty"` // NextPageToken: The page token for the next page of permissions. This @@ -3696,32 +3720,30 @@ func (s *PermissionList) MarshalJSON() ([]byte, error) { } // Property: A key-value pair attached to a file that is either public -// or private to an application. -// The following limits apply to file properties: -// - Maximum of 100 properties total per file -// - Maximum of 30 private properties per app -// - Maximum of 30 public properties -// - Maximum of 124 bytes size limit on (key + value) string in UTF-8 -// encoding for a single property. +// or private to an application. The following limits apply to file +// properties: * Maximum of 100 properties total per file * Maximum of +// 30 private properties per app * Maximum of 30 public properties * +// Maximum of 124 bytes size limit on (key + value) string in UTF-8 +// encoding for a single property type Property struct { - // Etag: ETag of the property. + // Etag: Output only. ETag of the property. Etag string `json:"etag,omitempty"` // Key: The key of this property. Key string `json:"key,omitempty"` - // Kind: This is always drive#property. + // Kind: Output only. This is always `drive#property`. Kind string `json:"kind,omitempty"` - // SelfLink: The link back to this property. + // SelfLink: Output only. The link back to this property. SelfLink string `json:"selfLink,omitempty"` // Value: The value of this property. Value string `json:"value,omitempty"` // Visibility: 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 + // PRIVATE (default) and PUBLIC. 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. Visibility string `json:"visibility,omitempty"` @@ -3762,7 +3784,7 @@ type PropertyList struct { // Items: The list of properties. Items []*Property `json:"items,omitempty"` - // Kind: This is always drive#propertyList. + // Kind: This is always `drive#propertyList`. Kind string `json:"kind,omitempty"` // SelfLink: The link back to this list. @@ -3797,45 +3819,50 @@ func (s *PropertyList) MarshalJSON() ([]byte, error) { // Revision: A revision of a file. type Revision struct { + // DownloadUrl: Output only. Short term download URL for the file. This + // will only be populated on files with content stored in Drive. DownloadUrl string `json:"downloadUrl,omitempty"` - // Etag: The ETag of the revision. + // Etag: Output only. The ETag of the revision. Etag string `json:"etag,omitempty"` - // ExportLinks: Links for exporting Docs Editors files to specific - // formats. + // ExportLinks: Output only. Links for exporting Docs Editors files to + // specific formats. ExportLinks map[string]string `json:"exportLinks,omitempty"` - // FileSize: The size of the revision in bytes. This will only be - // populated on files with content stored in Drive. + // FileSize: Output only. The size of the revision in bytes. This will + // only be populated on files with content stored in Drive. FileSize int64 `json:"fileSize,omitempty,string"` - // Id: The ID of the revision. + // Id: Output only. The ID of the revision. Id string `json:"id,omitempty"` - // Kind: This is always drive#revision. + // Kind: Output only. This is always `drive#revision`. Kind string `json:"kind,omitempty"` - // LastModifyingUser: The last user to modify this revision. + // LastModifyingUser: Output only. The last user to modify this + // revision. LastModifyingUser *User `json:"lastModifyingUser,omitempty"` - // LastModifyingUserName: Name of the last user to modify this revision. + // LastModifyingUserName: Output only. Name of the last user to modify + // this revision. LastModifyingUserName string `json:"lastModifyingUserName,omitempty"` - // Md5Checksum: An MD5 checksum for the content of this revision. This - // will only be populated on files with content stored in Drive. + // Md5Checksum: Output only. An MD5 checksum for the content of this + // revision. This will only be populated on files with content stored in + // Drive. Md5Checksum string `json:"md5Checksum,omitempty"` - // MimeType: The MIME type of the revision. + // MimeType: Output only. The MIME type of the revision. MimeType string `json:"mimeType,omitempty"` // ModifiedDate: Last time this revision was modified (formatted RFC // 3339 timestamp). ModifiedDate string `json:"modifiedDate,omitempty"` - // OriginalFilename: The original filename when this revision was - // created. This will only be populated on files with content stored in - // Drive. + // OriginalFilename: Output only. The original filename when this + // revision was created. This will only be populated on files with + // content stored in Drive. OriginalFilename string `json:"originalFilename,omitempty"` // Pinned: Whether this revision is pinned to prevent automatic purging. @@ -3857,8 +3884,8 @@ type Revision struct { // and can only be modified for Docs Editors files. Published bool `json:"published,omitempty"` - // PublishedLink: A link to the published revision. This is only - // populated for Google Sites files. + // PublishedLink: Output only. A link to the published revision. This is + // only populated for Google Sites files. PublishedLink string `json:"publishedLink,omitempty"` // PublishedOutsideDomain: Whether this revision is published outside @@ -3866,7 +3893,7 @@ type Revision struct { // Editors files. PublishedOutsideDomain bool `json:"publishedOutsideDomain,omitempty"` - // SelfLink: A link back to this revision. + // SelfLink: Output only. A link back to this revision. SelfLink string `json:"selfLink,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -3906,7 +3933,7 @@ type RevisionList struct { // be fetched. Items []*Revision `json:"items,omitempty"` - // Kind: This is always drive#revisionList. + // Kind: This is always `drive#revisionList`. Kind string `json:"kind,omitempty"` // NextPageToken: The page token for the next page of revisions. This @@ -3981,13 +4008,13 @@ func (s *StartPageToken) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// TeamDrive: Deprecated: use the drive collection instead. +// TeamDrive: Deprecated: Use the `drive` collection instead. type TeamDrive struct { // BackgroundImageFile: An image file and cropping parameters from which // a background image for this Team Drive is set. This is a write only - // field; it can only be set on drive.teamdrives.update requests that - // don't set themeId. When specified, all fields of the - // backgroundImageFile must be set. + // field; it can only be set on `drive.teamdrives.update` requests that + // don't set `themeId`. When specified, all fields of the + // `backgroundImageFile` must be set. BackgroundImageFile *TeamDriveBackgroundImageFile `json:"backgroundImageFile,omitempty"` // BackgroundImageLink: A short-lived link to this Team Drive's @@ -3998,8 +4025,8 @@ type TeamDrive struct { Capabilities *TeamDriveCapabilities `json:"capabilities,omitempty"` // ColorRgb: The color of this Team Drive as an RGB hex string. It can - // only be set on a drive.teamdrives.update request that does not set - // themeId. + // only be set on a `drive.teamdrives.update` request that does not set + // `themeId`. ColorRgb string `json:"colorRgb,omitempty"` // CreatedDate: The time at which the Team Drive was created (RFC 3339 @@ -4010,15 +4037,15 @@ type TeamDrive struct { // folder of this Team Drive. Id string `json:"id,omitempty"` - // Kind: This is always drive#teamDrive + // Kind: This is always `drive#teamDrive` Kind string `json:"kind,omitempty"` // Name: The name of this Team Drive. Name string `json:"name,omitempty"` // OrgUnitId: The organizational unit of this shared drive. This field - // is only populated on drives.list responses when the - // useDomainAdminAccess parameter is set to true. + // is only populated on `drives.list` responses when the + // `useDomainAdminAccess` parameter is set to `true`. OrgUnitId string `json:"orgUnitId,omitempty"` // Restrictions: A set of restrictions that apply to this Team Drive or @@ -4026,12 +4053,12 @@ type TeamDrive struct { Restrictions *TeamDriveRestrictions `json:"restrictions,omitempty"` // ThemeId: The ID of the theme from which the background image and - // color will be set. The set of possible teamDriveThemes can be - // retrieved from a drive.about.get response. When not specified on a - // drive.teamdrives.insert request, a random theme is chosen from which - // the background image and color are set. This is a write-only field; - // it can only be set on requests that don't set colorRgb or - // backgroundImageFile. + // color will be set. The set of possible `teamDriveThemes` can be + // retrieved from a `drive.about.get` response. When not specified on a + // `drive.teamdrives.insert` request, a random theme is chosen from + // which the background image and color are set. This is a write-only + // field; it can only be set on requests that don't set `colorRgb` or + // `backgroundImageFile`. ThemeId string `json:"themeId,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -4064,9 +4091,9 @@ func (s *TeamDrive) MarshalJSON() ([]byte, error) { // TeamDriveBackgroundImageFile: An image file and cropping parameters // from which a background image for this Team Drive is set. This is a -// write only field; it can only be set on drive.teamdrives.update -// requests that don't set themeId. When specified, all fields of the -// backgroundImageFile must be set. +// write only field; it can only be set on `drive.teamdrives.update` +// requests that don't set `themeId`. When specified, all fields of the +// `backgroundImageFile` must be set. type TeamDriveBackgroundImageFile struct { // Id: The ID of an image file in Drive to use for the background image. Id string `json:"id,omitempty"` @@ -4141,17 +4168,17 @@ type TeamDriveCapabilities struct { CanAddChildren bool `json:"canAddChildren,omitempty"` // CanChangeCopyRequiresWriterPermissionRestriction: Whether the current - // user can change the copyRequiresWriterPermission restriction of this - // Team Drive. + // user can change the `copyRequiresWriterPermission` restriction of + // this Team Drive. CanChangeCopyRequiresWriterPermissionRestriction bool `json:"canChangeCopyRequiresWriterPermissionRestriction,omitempty"` // CanChangeDomainUsersOnlyRestriction: Whether the current user can - // change the domainUsersOnly restriction of this Team Drive. + // change the `domainUsersOnly` restriction of this Team Drive. CanChangeDomainUsersOnlyRestriction bool `json:"canChangeDomainUsersOnlyRestriction,omitempty"` // CanChangeSharingFoldersRequiresOrganizerPermissionRestriction: // Whether the current user can change the - // sharingFoldersRequiresOrganizerPermission restriction of this Team + // `sharingFoldersRequiresOrganizerPermission` restriction of this Team // Drive. CanChangeSharingFoldersRequiresOrganizerPermissionRestriction bool `json:"canChangeSharingFoldersRequiresOrganizerPermissionRestriction,omitempty"` @@ -4160,7 +4187,7 @@ type TeamDriveCapabilities struct { CanChangeTeamDriveBackground bool `json:"canChangeTeamDriveBackground,omitempty"` // CanChangeTeamMembersOnlyRestriction: Whether the current user can - // change the teamMembersOnly restriction of this Team Drive. + // change the `teamMembersOnly` restriction of this Team Drive. CanChangeTeamMembersOnlyRestriction bool `json:"canChangeTeamMembersOnlyRestriction,omitempty"` // CanComment: Whether the current user can comment on files in this @@ -4198,8 +4225,8 @@ type TeamDriveCapabilities struct { // resource of files in this Team Drive. CanReadRevisions bool `json:"canReadRevisions,omitempty"` - // CanRemoveChildren: Deprecated - use canDeleteChildren or - // canTrashChildren instead. + // CanRemoveChildren: Deprecated: Use `canDeleteChildren` or + // `canTrashChildren` instead. CanRemoveChildren bool `json:"canRemoveChildren,omitempty"` // CanRename: Whether the current user can rename files or folders in @@ -4255,8 +4282,8 @@ type TeamDriveRestrictions struct { // CopyRequiresWriterPermission: Whether the options to copy, print, or // download files inside this Team Drive, should be disabled for readers - // and commenters. When this restriction is set to true, it will - // override the similarly named field to true for any file inside this + // and commenters. When this restriction is set to `true`, it will + // override the similarly named field to `true` for any file inside this // Team Drive. CopyRequiresWriterPermission bool `json:"copyRequiresWriterPermission,omitempty"` @@ -4305,7 +4332,7 @@ type TeamDriveList struct { // Items: The list of Team Drives. Items []*TeamDrive `json:"items,omitempty"` - // Kind: This is always drive#teamDriveList + // Kind: This is always `drive#teamDriveList` Kind string `json:"kind,omitempty"` // NextPageToken: The page token for the next page of Team Drives. @@ -4340,23 +4367,25 @@ func (s *TeamDriveList) MarshalJSON() ([]byte, error) { // User: Information about a Drive user. type User struct { - // DisplayName: A plain text displayable name for this user. + // DisplayName: Output only. A plain text displayable name for this + // user. DisplayName string `json:"displayName,omitempty"` - // EmailAddress: The email address of the user. + // EmailAddress: Output only. The email address of the user. EmailAddress string `json:"emailAddress,omitempty"` - // IsAuthenticatedUser: Whether this user is the same as the - // authenticated user for whom the request was made. + // IsAuthenticatedUser: Output only. Whether this user is the same as + // the authenticated user for whom the request was made. IsAuthenticatedUser bool `json:"isAuthenticatedUser,omitempty"` - // Kind: This is always drive#user. + // Kind: Output only. This is always `drive#user`. Kind string `json:"kind,omitempty"` - // PermissionId: The user's ID as visible in the permissions collection. + // PermissionId: Output only. The user's ID as visible in the + // permissions collection. PermissionId string `json:"permissionId,omitempty"` - // Picture: The user's profile picture. + // Picture: Output only. The user's profile picture. Picture *UserPicture `json:"picture,omitempty"` // ForceSendFields is a list of field names (e.g. "DisplayName") to @@ -4382,9 +4411,10 @@ func (s *User) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// UserPicture: The user's profile picture. +// UserPicture: Output only. The user's profile picture. type UserPicture struct { - // Url: A URL that points to a profile picture of this user. + // Url: Output Only. A URL that points to a profile picture of this + // user. Url string `json:"url,omitempty"` // ForceSendFields is a list of field names (e.g. "Url") to @@ -4431,7 +4461,7 @@ func (r *AboutService) Get() *AboutGetCall { // Whether to count changes outside the My Drive hierarchy. When set to // false, changes to files such as those in the Application Data folder // or shared files which have not been added to My Drive will be omitted -// from the maxChangeIdCount. +// from the `maxChangeIdCount`. func (c *AboutGetCall) IncludeSubscribed(includeSubscribed bool) *AboutGetCall { c.urlParams_.Set("includeSubscribed", fmt.Sprint(includeSubscribed)) return c @@ -4549,12 +4579,14 @@ func (c *AboutGetCall) Do(opts ...googleapi.CallOption) (*About, error) { return ret, nil // { // "description": "Gets the information about the current user along with Drive API settings", + // "flatPath": "about", // "httpMethod": "GET", // "id": "drive.about.get", + // "parameterOrder": [], // "parameters": { // "includeSubscribed": { // "default": "true", - // "description": "Whether to count changes outside the My Drive hierarchy. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the maxChangeIdCount.", + // "description": "Whether to count changes outside the My Drive hierarchy. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the `maxChangeIdCount`.", // "location": "query", // "type": "boolean" // }, @@ -4709,6 +4741,7 @@ func (c *AppsGetCall) Do(opts ...googleapi.CallOption) (*App, error) { return ret, nil // { // "description": "Gets a specific app.", + // "flatPath": "apps/{appId}", // "httpMethod": "GET", // "id": "drive.apps.get", // "parameterOrder": [ @@ -4759,8 +4792,8 @@ func (r *AppsService) List() *AppsListCall { // "appFilterExtensions": A comma-separated list of file extensions for // open with filtering. All apps within the given app query scope which // can open any of the given file extensions will be included in the -// response. If appFilterMimeTypes are provided as well, the result is a -// union of the two resulting app lists. +// response. If `appFilterMimeTypes` are provided as well, the result is +// a union of the two resulting app lists. func (c *AppsListCall) AppFilterExtensions(appFilterExtensions string) *AppsListCall { c.urlParams_.Set("appFilterExtensions", appFilterExtensions) return c @@ -4769,7 +4802,7 @@ func (c *AppsListCall) AppFilterExtensions(appFilterExtensions string) *AppsList // AppFilterMimeTypes sets the optional parameter "appFilterMimeTypes": // A comma-separated list of MIME types for open with filtering. All // apps within the given app query scope which can open any of the given -// MIME types will be included in the response. If appFilterExtensions +// MIME types will be included in the response. If `appFilterExtensions` // are provided as well, the result is a union of the two resulting app // lists. func (c *AppsListCall) AppFilterMimeTypes(appFilterMimeTypes string) *AppsListCall { @@ -4882,18 +4915,20 @@ func (c *AppsListCall) Do(opts ...googleapi.CallOption) (*AppList, error) { return ret, nil // { // "description": "Lists a user's installed apps.", + // "flatPath": "apps", // "httpMethod": "GET", // "id": "drive.apps.list", + // "parameterOrder": [], // "parameters": { // "appFilterExtensions": { // "default": "", - // "description": "A comma-separated list of file extensions for open with filtering. All apps within the given app query scope which can open any of the given file extensions will be included in the response. If appFilterMimeTypes are provided as well, the result is a union of the two resulting app lists.", + // "description": "A comma-separated list of file extensions for open with filtering. All apps within the given app query scope which can open any of the given file extensions will be included in the response. If `appFilterMimeTypes` are provided as well, the result is a union of the two resulting app lists.", // "location": "query", // "type": "string" // }, // "appFilterMimeTypes": { // "default": "", - // "description": "A comma-separated list of MIME types for open with filtering. All apps within the given app query scope which can open any of the given MIME types will be included in the response. If appFilterExtensions are provided as well, the result is a union of the two resulting app lists.", + // "description": "A comma-separated list of MIME types for open with filtering. All apps within the given app query scope which can open any of the given MIME types will be included in the response. If `appFilterExtensions` are provided as well, the result is a union of the two resulting app lists.", // "location": "query", // "type": "string" // }, @@ -4925,8 +4960,8 @@ type ChangesGetCall struct { header_ http.Header } -// Get: Deprecated - Use changes.getStartPageToken and changes.list to -// retrieve recent changes. +// Get: Deprecated: Use `changes.getStartPageToken` and `changes.list` +// to retrieve recent changes. // // - changeId: The ID of the change. func (r *ChangesService) Get(changeId string) *ChangesGetCall { @@ -4936,7 +4971,7 @@ func (r *ChangesService) Get(changeId string) *ChangesGetCall { } // DriveId sets the optional parameter "driveId": The shared drive from -// which the change is returned. +// which the change will be returned. func (c *ChangesGetCall) DriveId(driveId string) *ChangesGetCall { c.urlParams_.Set("driveId", driveId) return c @@ -4951,14 +4986,14 @@ func (c *ChangesGetCall) SupportsAllDrives(supportsAllDrives bool) *ChangesGetCa } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *ChangesGetCall) SupportsTeamDrives(supportsTeamDrives bool) *ChangesGetCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c } -// TeamDriveId sets the optional parameter "teamDriveId": Deprecated use -// driveId instead. +// TeamDriveId sets the optional parameter "teamDriveId": Deprecated: +// Use `driveId` instead. func (c *ChangesGetCall) TeamDriveId(teamDriveId string) *ChangesGetCall { c.urlParams_.Set("teamDriveId", teamDriveId) return c @@ -5063,7 +5098,8 @@ func (c *ChangesGetCall) Do(opts ...googleapi.CallOption) (*Change, error) { } return ret, nil // { - // "description": "Deprecated - Use changes.getStartPageToken and changes.list to retrieve recent changes.", + // "description": "Deprecated: Use `changes.getStartPageToken` and `changes.list` to retrieve recent changes.", + // "flatPath": "changes/{changeId}", // "httpMethod": "GET", // "id": "drive.changes.get", // "parameterOrder": [ @@ -5077,7 +5113,7 @@ func (c *ChangesGetCall) Do(opts ...googleapi.CallOption) (*Change, error) { // "type": "string" // }, // "driveId": { - // "description": "The shared drive from which the change is returned.", + // "description": "The shared drive from which the change will be returned.", // "location": "query", // "type": "string" // }, @@ -5089,12 +5125,12 @@ func (c *ChangesGetCall) Do(opts ...googleapi.CallOption) (*Change, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "teamDriveId": { - // "description": "Deprecated use driveId instead.", + // "description": "Deprecated: Use `driveId` instead.", // "location": "query", // "type": "string" // } @@ -5136,7 +5172,7 @@ func (r *ChangesService) GetStartPageToken() *ChangesGetStartPageTokenCall { // DriveId sets the optional parameter "driveId": The ID of the shared // drive for which the starting pageToken for listing future changes -// from that shared drive is returned. +// from that shared drive will be returned. func (c *ChangesGetStartPageTokenCall) DriveId(driveId string) *ChangesGetStartPageTokenCall { c.urlParams_.Set("driveId", driveId) return c @@ -5151,14 +5187,14 @@ func (c *ChangesGetStartPageTokenCall) SupportsAllDrives(supportsAllDrives bool) } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *ChangesGetStartPageTokenCall) SupportsTeamDrives(supportsTeamDrives bool) *ChangesGetStartPageTokenCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c } -// TeamDriveId sets the optional parameter "teamDriveId": Deprecated use -// driveId instead. +// TeamDriveId sets the optional parameter "teamDriveId": Deprecated: +// Use `driveId` instead. func (c *ChangesGetStartPageTokenCall) TeamDriveId(teamDriveId string) *ChangesGetStartPageTokenCall { c.urlParams_.Set("teamDriveId", teamDriveId) return c @@ -5261,11 +5297,13 @@ func (c *ChangesGetStartPageTokenCall) Do(opts ...googleapi.CallOption) (*StartP return ret, nil // { // "description": "Gets the starting pageToken for listing future changes.", + // "flatPath": "changes/startPageToken", // "httpMethod": "GET", // "id": "drive.changes.getStartPageToken", + // "parameterOrder": [], // "parameters": { // "driveId": { - // "description": "The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned.", + // "description": "The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.", // "location": "query", // "type": "string" // }, @@ -5277,12 +5315,12 @@ func (c *ChangesGetStartPageTokenCall) Do(opts ...googleapi.CallOption) (*StartP // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "teamDriveId": { - // "description": "Deprecated use driveId instead.", + // "description": "Deprecated: Use `driveId` instead.", // "location": "query", // "type": "string" // } @@ -5322,7 +5360,7 @@ func (r *ChangesService) List() *ChangesListCall { } // DriveId sets the optional parameter "driveId": The shared drive from -// which changes are returned. If specified the change IDs will be +// which changes will be returned. If specified the change IDs will be // reflective of the shared drive; use the combined drive ID and change // ID as an identifier. func (c *ChangesListCall) DriveId(driveId string) *ChangesListCall { @@ -5357,7 +5395,7 @@ func (c *ChangesListCall) IncludeItemsFromAllDrives(includeItemsFromAllDrives bo } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *ChangesListCall) IncludeLabels(includeLabels string) *ChangesListCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -5366,7 +5404,7 @@ func (c *ChangesListCall) IncludeLabels(includeLabels string) *ChangesListCall { // IncludePermissionsForView sets the optional parameter // "includePermissionsForView": Specifies which additional view's -// permissions to include in the response. Only 'published' is +// permissions to include in the response. Only `published` is // supported. func (c *ChangesListCall) IncludePermissionsForView(includePermissionsForView string) *ChangesListCall { c.urlParams_.Set("includePermissionsForView", includePermissionsForView) @@ -5377,14 +5415,14 @@ func (c *ChangesListCall) IncludePermissionsForView(includePermissionsForView st // Whether to include changes outside the My Drive hierarchy in the // result. When set to false, changes to files such as those in the // Application Data folder or shared files which have not been added to -// My Drive are omitted from the result. +// My Drive will be omitted from the result. func (c *ChangesListCall) IncludeSubscribed(includeSubscribed bool) *ChangesListCall { c.urlParams_.Set("includeSubscribed", fmt.Sprint(includeSubscribed)) return c } // IncludeTeamDriveItems sets the optional parameter -// "includeTeamDriveItems": Deprecated use includeItemsFromAllDrives +// "includeTeamDriveItems": Deprecated: Use `includeItemsFromAllDrives` // instead. func (c *ChangesListCall) IncludeTeamDriveItems(includeTeamDriveItems bool) *ChangesListCall { c.urlParams_.Set("includeTeamDriveItems", fmt.Sprint(includeTeamDriveItems)) @@ -5400,7 +5438,7 @@ func (c *ChangesListCall) MaxResults(maxResults int64) *ChangesListCall { // PageToken sets the optional parameter "pageToken": The token for // continuing a previous list request on the next page. This should be -// set to the value of 'nextPageToken' from the previous response or to +// set to the value of `nextPageToken` from the previous response or to // the response from the getStartPageToken method. func (c *ChangesListCall) PageToken(pageToken string) *ChangesListCall { c.urlParams_.Set("pageToken", pageToken) @@ -5408,15 +5446,15 @@ func (c *ChangesListCall) PageToken(pageToken string) *ChangesListCall { } // Spaces sets the optional parameter "spaces": A comma-separated list -// of spaces to query. Supported values are 'drive', 'appDataFolder' and -// 'photos'. +// of spaces to query. Supported values are `drive`, `appDataFolder` and +// `photos`. func (c *ChangesListCall) Spaces(spaces string) *ChangesListCall { c.urlParams_.Set("spaces", spaces) return c } -// StartChangeId sets the optional parameter "startChangeId": Deprecated -// - use pageToken instead. +// StartChangeId sets the optional parameter "startChangeId": +// Deprecated: Use `pageToken` instead. func (c *ChangesListCall) StartChangeId(startChangeId int64) *ChangesListCall { c.urlParams_.Set("startChangeId", fmt.Sprint(startChangeId)) return c @@ -5431,14 +5469,14 @@ func (c *ChangesListCall) SupportsAllDrives(supportsAllDrives bool) *ChangesList } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *ChangesListCall) SupportsTeamDrives(supportsTeamDrives bool) *ChangesListCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c } -// TeamDriveId sets the optional parameter "teamDriveId": Deprecated use -// driveId instead. +// TeamDriveId sets the optional parameter "teamDriveId": Deprecated: +// Use `driveId` instead. func (c *ChangesListCall) TeamDriveId(teamDriveId string) *ChangesListCall { c.urlParams_.Set("teamDriveId", teamDriveId) return c @@ -5541,11 +5579,13 @@ func (c *ChangesListCall) Do(opts ...googleapi.CallOption) (*ChangeList, error) return ret, nil // { // "description": "Lists the changes for a user or shared drive.", + // "flatPath": "changes", // "httpMethod": "GET", // "id": "drive.changes.list", + // "parameterOrder": [], // "parameters": { // "driveId": { - // "description": "The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", + // "description": "The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", // "location": "query", // "type": "string" // }, @@ -5568,24 +5608,24 @@ func (c *ChangesListCall) Do(opts ...googleapi.CallOption) (*ChangeList, error) // "type": "boolean" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, // "includePermissionsForView": { - // "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + // "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", // "location": "query", // "type": "string" // }, // "includeSubscribed": { // "default": "true", - // "description": "Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result.", + // "description": "Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.", // "location": "query", // "type": "boolean" // }, // "includeTeamDriveItems": { // "default": "false", - // "description": "Deprecated use includeItemsFromAllDrives instead.", + // "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -5598,17 +5638,17 @@ func (c *ChangesListCall) Do(opts ...googleapi.CallOption) (*ChangeList, error) // "type": "integer" // }, // "pageToken": { - // "description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.", + // "description": "The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response or to the response from the getStartPageToken method.", // "location": "query", // "type": "string" // }, // "spaces": { - // "description": "A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.", + // "description": "A comma-separated list of spaces to query. Supported values are `drive`, `appDataFolder` and `photos`.", // "location": "query", // "type": "string" // }, // "startChangeId": { - // "description": "Deprecated - use pageToken instead.", + // "description": "Deprecated: Use `pageToken` instead.", // "format": "int64", // "location": "query", // "type": "string" @@ -5621,12 +5661,12 @@ func (c *ChangesListCall) Do(opts ...googleapi.CallOption) (*ChangeList, error) // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "teamDriveId": { - // "description": "Deprecated use driveId instead.", + // "description": "Deprecated: Use `driveId` instead.", // "location": "query", // "type": "string" // } @@ -5689,7 +5729,7 @@ func (r *ChangesService) Watch(channel *Channel) *ChangesWatchCall { } // DriveId sets the optional parameter "driveId": The shared drive from -// which changes are returned. If specified the change IDs will be +// which changes will be returned. If specified the change IDs will be // reflective of the shared drive; use the combined drive ID and change // ID as an identifier. func (c *ChangesWatchCall) DriveId(driveId string) *ChangesWatchCall { @@ -5724,7 +5764,7 @@ func (c *ChangesWatchCall) IncludeItemsFromAllDrives(includeItemsFromAllDrives b } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *ChangesWatchCall) IncludeLabels(includeLabels string) *ChangesWatchCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -5733,7 +5773,7 @@ func (c *ChangesWatchCall) IncludeLabels(includeLabels string) *ChangesWatchCall // IncludePermissionsForView sets the optional parameter // "includePermissionsForView": Specifies which additional view's -// permissions to include in the response. Only 'published' is +// permissions to include in the response. Only `published` is // supported. func (c *ChangesWatchCall) IncludePermissionsForView(includePermissionsForView string) *ChangesWatchCall { c.urlParams_.Set("includePermissionsForView", includePermissionsForView) @@ -5744,14 +5784,14 @@ func (c *ChangesWatchCall) IncludePermissionsForView(includePermissionsForView s // Whether to include changes outside the My Drive hierarchy in the // result. When set to false, changes to files such as those in the // Application Data folder or shared files which have not been added to -// My Drive are omitted from the result. +// My Drive will be omitted from the result. func (c *ChangesWatchCall) IncludeSubscribed(includeSubscribed bool) *ChangesWatchCall { c.urlParams_.Set("includeSubscribed", fmt.Sprint(includeSubscribed)) return c } // IncludeTeamDriveItems sets the optional parameter -// "includeTeamDriveItems": Deprecated use includeItemsFromAllDrives +// "includeTeamDriveItems": Deprecated: Use `includeItemsFromAllDrives` // instead. func (c *ChangesWatchCall) IncludeTeamDriveItems(includeTeamDriveItems bool) *ChangesWatchCall { c.urlParams_.Set("includeTeamDriveItems", fmt.Sprint(includeTeamDriveItems)) @@ -5767,7 +5807,7 @@ func (c *ChangesWatchCall) MaxResults(maxResults int64) *ChangesWatchCall { // PageToken sets the optional parameter "pageToken": The token for // continuing a previous list request on the next page. This should be -// set to the value of 'nextPageToken' from the previous response or to +// set to the value of `nextPageToken` from the previous response or to // the response from the getStartPageToken method. func (c *ChangesWatchCall) PageToken(pageToken string) *ChangesWatchCall { c.urlParams_.Set("pageToken", pageToken) @@ -5775,15 +5815,15 @@ func (c *ChangesWatchCall) PageToken(pageToken string) *ChangesWatchCall { } // Spaces sets the optional parameter "spaces": A comma-separated list -// of spaces to query. Supported values are 'drive', 'appDataFolder' and -// 'photos'. +// of spaces to query. Supported values are `drive`, `appDataFolder` and +// `photos`. func (c *ChangesWatchCall) Spaces(spaces string) *ChangesWatchCall { c.urlParams_.Set("spaces", spaces) return c } -// StartChangeId sets the optional parameter "startChangeId": Deprecated -// - use pageToken instead. +// StartChangeId sets the optional parameter "startChangeId": +// Deprecated: Use `pageToken` instead. func (c *ChangesWatchCall) StartChangeId(startChangeId int64) *ChangesWatchCall { c.urlParams_.Set("startChangeId", fmt.Sprint(startChangeId)) return c @@ -5798,14 +5838,14 @@ func (c *ChangesWatchCall) SupportsAllDrives(supportsAllDrives bool) *ChangesWat } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *ChangesWatchCall) SupportsTeamDrives(supportsTeamDrives bool) *ChangesWatchCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c } -// TeamDriveId sets the optional parameter "teamDriveId": Deprecated use -// driveId instead. +// TeamDriveId sets the optional parameter "teamDriveId": Deprecated: +// Use `driveId` instead. func (c *ChangesWatchCall) TeamDriveId(teamDriveId string) *ChangesWatchCall { c.urlParams_.Set("teamDriveId", teamDriveId) return c @@ -5900,11 +5940,13 @@ func (c *ChangesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { return ret, nil // { // "description": "Subscribe to changes for a user.", + // "flatPath": "changes/watch", // "httpMethod": "POST", // "id": "drive.changes.watch", + // "parameterOrder": [], // "parameters": { // "driveId": { - // "description": "The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", + // "description": "The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", // "location": "query", // "type": "string" // }, @@ -5927,24 +5969,24 @@ func (c *ChangesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // "type": "boolean" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, // "includePermissionsForView": { - // "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + // "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", // "location": "query", // "type": "string" // }, // "includeSubscribed": { // "default": "true", - // "description": "Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result.", + // "description": "Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.", // "location": "query", // "type": "boolean" // }, // "includeTeamDriveItems": { // "default": "false", - // "description": "Deprecated use includeItemsFromAllDrives instead.", + // "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -5957,17 +5999,17 @@ func (c *ChangesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // "type": "integer" // }, // "pageToken": { - // "description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.", + // "description": "The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response or to the response from the getStartPageToken method.", // "location": "query", // "type": "string" // }, // "spaces": { - // "description": "A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.", + // "description": "A comma-separated list of spaces to query. Supported values are `drive`, `appDataFolder` and `photos`.", // "location": "query", // "type": "string" // }, // "startChangeId": { - // "description": "Deprecated - use pageToken instead.", + // "description": "Deprecated: Use `pageToken` instead.", // "format": "int64", // "location": "query", // "type": "string" @@ -5980,12 +6022,12 @@ func (c *ChangesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "teamDriveId": { - // "description": "Deprecated use driveId instead.", + // "description": "Deprecated: Use `driveId` instead.", // "location": "query", // "type": "string" // } @@ -6023,7 +6065,7 @@ type ChannelsStopCall struct { header_ http.Header } -// Stop: Stop watching resources through this channel +// Stop: Stops watching resources through this channel. func (r *ChannelsService) Stop(channel *Channel) *ChannelsStopCall { c := &ChannelsStopCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.channel = channel @@ -6093,9 +6135,12 @@ func (c *ChannelsStopCall) Do(opts ...googleapi.CallOption) error { } return nil // { - // "description": "Stop watching resources through this channel", + // "description": "Stops watching resources through this channel.", + // "flatPath": "channels/stop", // "httpMethod": "POST", // "id": "drive.channels.stop", + // "parameterOrder": [], + // "parameters": {}, // "path": "channels/stop", // "request": { // "$ref": "Channel", @@ -6138,9 +6183,9 @@ func (r *ChildrenService) Delete(folderId string, childId string) *ChildrenDelet } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": 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. +// "enforceSingleParent": Deprecated: If an item is not in a shared +// drive and its last parent is removed, the item is placed under its +// owner's root. func (c *ChildrenDeleteCall) EnforceSingleParent(enforceSingleParent bool) *ChildrenDeleteCall { c.urlParams_.Set("enforceSingleParent", fmt.Sprint(enforceSingleParent)) return c @@ -6209,6 +6254,7 @@ func (c *ChildrenDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Removes a child from a folder.", + // "flatPath": "files/{folderId}/children/{childId}", // "httpMethod": "DELETE", // "id": "drive.children.delete", // "parameterOrder": [ @@ -6224,7 +6270,7 @@ func (c *ChildrenDeleteCall) Do(opts ...googleapi.CallOption) error { // }, // "enforceSingleParent": { // "default": "false", - // "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.", + // "description": "Deprecated: If an item is not in a shared drive and its last parent is removed, the item is placed under its owner's root.", // "location": "query", // "type": "boolean" // }, @@ -6368,6 +6414,7 @@ func (c *ChildrenGetCall) Do(opts ...googleapi.CallOption) (*ChildReference, err return ret, nil // { // "description": "Gets a specific child reference.", + // "flatPath": "files/{folderId}/children/{childId}", // "httpMethod": "GET", // "id": "drive.children.get", // "parameterOrder": [ @@ -6427,8 +6474,8 @@ func (r *ChildrenService) Insert(folderId string, childreference *ChildReference } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. Adding files to multiple folders -// is no longer supported. Use shortcuts instead. +// "enforceSingleParent": Deprecated: Adding files to multiple folders +// is no longer supported. Use `shortcuts` instead. func (c *ChildrenInsertCall) EnforceSingleParent(enforceSingleParent bool) *ChildrenInsertCall { c.urlParams_.Set("enforceSingleParent", fmt.Sprint(enforceSingleParent)) return c @@ -6443,7 +6490,7 @@ func (c *ChildrenInsertCall) SupportsAllDrives(supportsAllDrives bool) *Children } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *ChildrenInsertCall) SupportsTeamDrives(supportsTeamDrives bool) *ChildrenInsertCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -6541,6 +6588,7 @@ func (c *ChildrenInsertCall) Do(opts ...googleapi.CallOption) (*ChildReference, return ret, nil // { // "description": "Inserts a file into a folder.", + // "flatPath": "files/{folderId}/children", // "httpMethod": "POST", // "id": "drive.children.insert", // "parameterOrder": [ @@ -6549,7 +6597,7 @@ func (c *ChildrenInsertCall) Do(opts ...googleapi.CallOption) (*ChildReference, // "parameters": { // "enforceSingleParent": { // "default": "false", - // "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", + // "description": "Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead.", // "location": "query", // "type": "boolean" // }, @@ -6567,7 +6615,7 @@ func (c *ChildrenInsertCall) Do(opts ...googleapi.CallOption) (*ChildReference, // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // } @@ -6616,11 +6664,11 @@ func (c *ChildrenListCall) MaxResults(maxResults int64) *ChildrenListCall { } // OrderBy sets the optional parameter "orderBy": A comma-separated list -// of sort keys. Valid keys are 'createdDate', 'folder', -// 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', -// 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', and -// 'title'. Each key sorts ascending by default, but may be reversed -// with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate +// of sort keys. Valid keys are `createdDate`, `folder`, +// `lastViewedByMeDate`, `modifiedByMeDate`, `modifiedDate`, +// `quotaBytesUsed`, `recency`, `sharedWithMeDate`, `starred`, and +// `title`. Each key sorts ascending by default, but may be reversed +// with the `desc` modifier. Example usage: ?orderBy=folder,modifiedDate // desc,title. Please note that there is a current limitation for users // with approximately one million files in which the requested sort // order is ignored. @@ -6743,6 +6791,7 @@ func (c *ChildrenListCall) Do(opts ...googleapi.CallOption) (*ChildList, error) return ret, nil // { // "description": "Lists a folder's children.", + // "flatPath": "files/{folderId}/children", // "httpMethod": "GET", // "id": "drive.children.list", // "parameterOrder": [ @@ -6764,7 +6813,7 @@ func (c *ChildrenListCall) Do(opts ...googleapi.CallOption) (*ChildList, error) // "type": "integer" // }, // "orderBy": { - // "description": "A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', and 'title'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.", + // "description": "A comma-separated list of sort keys. Valid keys are `createdDate`, `folder`, `lastViewedByMeDate`, `modifiedByMeDate`, `modifiedDate`, `quotaBytesUsed`, `recency`, `sharedWithMeDate`, `starred`, and `title`. Each key sorts ascending by default, but may be reversed with the `desc` modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.", // "location": "query", // "type": "string" // }, @@ -6902,6 +6951,7 @@ func (c *CommentsDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Deletes a comment.", + // "flatPath": "files/{fileId}/comments/{commentId}", // "httpMethod": "DELETE", // "id": "drive.comments.delete", // "parameterOrder": [ @@ -7063,6 +7113,7 @@ func (c *CommentsGetCall) Do(opts ...googleapi.CallOption) (*Comment, error) { return ret, nil // { // "description": "Gets a comment by ID.", + // "flatPath": "files/{fileId}/comments/{commentId}", // "httpMethod": "GET", // "id": "drive.comments.get", // "parameterOrder": [ @@ -7215,6 +7266,7 @@ func (c *CommentsInsertCall) Do(opts ...googleapi.CallOption) (*Comment, error) return ret, nil // { // "description": "Creates a new comment on the given file.", + // "flatPath": "files/{fileId}/comments", // "httpMethod": "POST", // "id": "drive.comments.insert", // "parameterOrder": [ @@ -7395,6 +7447,7 @@ func (c *CommentsListCall) Do(opts ...googleapi.CallOption) (*CommentList, error return ret, nil // { // "description": "Lists a file's comments.", + // "flatPath": "files/{fileId}/comments", // "httpMethod": "GET", // "id": "drive.comments.list", // "parameterOrder": [ @@ -7584,6 +7637,7 @@ func (c *CommentsPatchCall) Do(opts ...googleapi.CallOption) (*Comment, error) { return ret, nil // { // "description": "Updates an existing comment.", + // "flatPath": "files/{fileId}/comments/{commentId}", // "httpMethod": "PATCH", // "id": "drive.comments.patch", // "parameterOrder": [ @@ -7736,6 +7790,7 @@ func (c *CommentsUpdateCall) Do(opts ...googleapi.CallOption) (*Comment, error) return ret, nil // { // "description": "Updates an existing comment.", + // "flatPath": "files/{fileId}/comments/{commentId}", // "httpMethod": "PUT", // "id": "drive.comments.update", // "parameterOrder": [ @@ -7793,8 +7848,8 @@ func (r *DrivesService) Delete(driveId string) *DrivesDeleteCall { // AllowItemDeletion sets the optional parameter "allowItemDeletion": // Whether any items inside the shared drive should also be deleted. -// This option is only supported when useDomainAdminAccess is also set -// to true. +// This option is only supported when `useDomainAdminAccess` is also set +// to `true`. func (c *DrivesDeleteCall) AllowItemDeletion(allowItemDeletion bool) *DrivesDeleteCall { c.urlParams_.Set("allowItemDeletion", fmt.Sprint(allowItemDeletion)) return c @@ -7871,6 +7926,7 @@ func (c *DrivesDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.", + // "flatPath": "drives/{driveId}", // "httpMethod": "DELETE", // "id": "drive.drives.delete", // "parameterOrder": [ @@ -7879,7 +7935,7 @@ func (c *DrivesDeleteCall) Do(opts ...googleapi.CallOption) error { // "parameters": { // "allowItemDeletion": { // "default": "false", - // "description": "Whether any items inside the shared drive should also be deleted. This option is only supported when useDomainAdminAccess is also set to true.", + // "description": "Whether any items inside the shared drive should also be deleted. This option is only supported when `useDomainAdminAccess` is also set to `true`.", // "location": "query", // "type": "boolean" // }, @@ -8033,6 +8089,7 @@ func (c *DrivesGetCall) Do(opts ...googleapi.CallOption) (*Drive, error) { return ret, nil // { // "description": "Gets a shared drive's metadata by ID.", + // "flatPath": "drives/{driveId}", // "httpMethod": "GET", // "id": "drive.drives.get", // "parameterOrder": [ @@ -8170,6 +8227,7 @@ func (c *DrivesHideCall) Do(opts ...googleapi.CallOption) (*Drive, error) { return ret, nil // { // "description": "Hides a shared drive from the default view.", + // "flatPath": "drives/{driveId}/hide", // "httpMethod": "POST", // "id": "drive.drives.hide", // "parameterOrder": [ @@ -8308,6 +8366,7 @@ func (c *DrivesInsertCall) Do(opts ...googleapi.CallOption) (*Drive, error) { return ret, nil // { // "description": "Creates a new shared drive.", + // "flatPath": "drives", // "httpMethod": "POST", // "id": "drive.drives.insert", // "parameterOrder": [ @@ -8315,7 +8374,7 @@ func (c *DrivesInsertCall) Do(opts ...googleapi.CallOption) (*Drive, error) { // ], // "parameters": { // "requestId": { - // "description": "An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.", + // "description": "Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.", // "location": "query", // "required": true, // "type": "string" @@ -8345,7 +8404,10 @@ type DrivesListCall struct { header_ http.Header } -// List: Lists the user's shared drives. +// List: Lists the user's shared drives. This method accepts the `q` +// parameter, which is a search query combining one or more search +// terms. For more information, see the Search for shared drives +// (/drive/api/guides/search-shareddrives) guide. func (r *DrivesService) List() *DrivesListCall { c := &DrivesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} return c @@ -8477,9 +8539,11 @@ func (c *DrivesListCall) Do(opts ...googleapi.CallOption) (*DriveList, error) { } return ret, nil // { - // "description": "Lists the user's shared drives.", + // "description": " Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/drive/api/guides/search-shareddrives) guide.", + // "flatPath": "drives", // "httpMethod": "GET", // "id": "drive.drives.list", + // "parameterOrder": [], // "parameters": { // "maxResults": { // "default": "10", @@ -8646,6 +8710,7 @@ func (c *DrivesUnhideCall) Do(opts ...googleapi.CallOption) (*Drive, error) { return ret, nil // { // "description": "Restores a shared drive to the default view.", + // "flatPath": "drives/{driveId}/unhide", // "httpMethod": "POST", // "id": "drive.drives.unhide", // "parameterOrder": [ @@ -8792,6 +8857,7 @@ func (c *DrivesUpdateCall) Do(opts ...googleapi.CallOption) (*Drive, error) { return ret, nil // { // "description": "Updates the metadata for a shared drive.", + // "flatPath": "drives/{driveId}", // "httpMethod": "PUT", // "id": "drive.drives.update", // "parameterOrder": [ @@ -8836,7 +8902,7 @@ type FilesCopyCall struct { header_ http.Header } -// Copy: Creates a copy of the specified file. Folders cannot be copied. +// Copy: Creates a copy of the specified file. // // - fileId: The ID of the file to copy. func (r *FilesService) Copy(fileId string, file *File) *FilesCopyCall { @@ -8854,7 +8920,7 @@ func (c *FilesCopyCall) Convert(convert bool) *FilesCopyCall { } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. Copying files into multiple +// "enforceSingleParent": Deprecated: Copying files into multiple // folders is no longer supported. Use shortcuts instead. func (c *FilesCopyCall) EnforceSingleParent(enforceSingleParent bool) *FilesCopyCall { c.urlParams_.Set("enforceSingleParent", fmt.Sprint(enforceSingleParent)) @@ -8862,7 +8928,7 @@ func (c *FilesCopyCall) EnforceSingleParent(enforceSingleParent bool) *FilesCopy } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesCopyCall) IncludeLabels(includeLabels string) *FilesCopyCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -8871,7 +8937,7 @@ func (c *FilesCopyCall) IncludeLabels(includeLabels string) *FilesCopyCall { // IncludePermissionsForView sets the optional parameter // "includePermissionsForView": Specifies which additional view's -// permissions to include in the response. Only 'published' is +// permissions to include in the response. Only `published` is // supported. func (c *FilesCopyCall) IncludePermissionsForView(includePermissionsForView string) *FilesCopyCall { c.urlParams_.Set("includePermissionsForView", includePermissionsForView) @@ -8885,7 +8951,7 @@ func (c *FilesCopyCall) Ocr(ocr bool) *FilesCopyCall { return c } -// OcrLanguage sets the optional parameter "ocrLanguage": If ocr is +// OcrLanguage sets the optional parameter "ocrLanguage": If `ocr` is // true, hints at the language to use. Valid values are BCP 47 codes. func (c *FilesCopyCall) OcrLanguage(ocrLanguage string) *FilesCopyCall { c.urlParams_.Set("ocrLanguage", ocrLanguage) @@ -8909,7 +8975,7 @@ func (c *FilesCopyCall) SupportsAllDrives(supportsAllDrives bool) *FilesCopyCall } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesCopyCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesCopyCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -9036,7 +9102,8 @@ func (c *FilesCopyCall) Do(opts ...googleapi.CallOption) (*File, error) { } return ret, nil // { - // "description": "Creates a copy of the specified file. Folders cannot be copied.", + // "description": "Creates a copy of the specified file.", + // "flatPath": "files/{fileId}/copy", // "httpMethod": "POST", // "id": "drive.files.copy", // "parameterOrder": [ @@ -9051,7 +9118,7 @@ func (c *FilesCopyCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "enforceSingleParent": { // "default": "false", - // "description": "Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.", + // "description": "Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead.", // "location": "query", // "type": "boolean" // }, @@ -9062,12 +9129,12 @@ func (c *FilesCopyCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "string" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, // "includePermissionsForView": { - // "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + // "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", // "location": "query", // "type": "string" // }, @@ -9078,7 +9145,7 @@ func (c *FilesCopyCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "boolean" // }, // "ocrLanguage": { - // "description": "If ocr is true, hints at the language to use. Valid values are BCP 47 codes.", + // "description": "If `ocr` is true, hints at the language to use. Valid values are BCP 47 codes.", // "location": "query", // "type": "string" // }, @@ -9096,7 +9163,7 @@ func (c *FilesCopyCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -9165,9 +9232,9 @@ func (r *FilesService) Delete(fileId string) *FilesDeleteCall { } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. If an item is not in a shared +// "enforceSingleParent": 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. +// item is placed under its owner's root. func (c *FilesDeleteCall) EnforceSingleParent(enforceSingleParent bool) *FilesDeleteCall { c.urlParams_.Set("enforceSingleParent", fmt.Sprint(enforceSingleParent)) return c @@ -9182,7 +9249,7 @@ func (c *FilesDeleteCall) SupportsAllDrives(supportsAllDrives bool) *FilesDelete } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesDeleteCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesDeleteCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -9250,6 +9317,7 @@ func (c *FilesDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for shared drive files.", + // "flatPath": "files/{fileId}", // "httpMethod": "DELETE", // "id": "drive.files.delete", // "parameterOrder": [ @@ -9258,7 +9326,7 @@ func (c *FilesDeleteCall) Do(opts ...googleapi.CallOption) error { // "parameters": { // "enforceSingleParent": { // "default": "false", - // "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.", + // "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 is placed under its owner's root.", // "location": "query", // "type": "boolean" // }, @@ -9276,7 +9344,7 @@ func (c *FilesDeleteCall) Do(opts ...googleapi.CallOption) error { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // } @@ -9300,8 +9368,7 @@ type FilesEmptyTrashCall struct { header_ http.Header } -// EmptyTrash: Permanently deletes all trashed files of a user or shared -// drive. +// EmptyTrash: Permanently deletes all of the user's trashed files. func (r *FilesService) EmptyTrash() *FilesEmptyTrashCall { c := &FilesEmptyTrashCall{s: r.s, urlParams_: make(gensupport.URLParams)} return c @@ -9315,9 +9382,9 @@ func (c *FilesEmptyTrashCall) DriveId(driveId string) *FilesEmptyTrashCall { } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. If an item is not in a shared +// "enforceSingleParent": 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. +// item is placed under its owner's root. func (c *FilesEmptyTrashCall) EnforceSingleParent(enforceSingleParent bool) *FilesEmptyTrashCall { c.urlParams_.Set("enforceSingleParent", fmt.Sprint(enforceSingleParent)) return c @@ -9381,9 +9448,11 @@ func (c *FilesEmptyTrashCall) Do(opts ...googleapi.CallOption) error { } return nil // { - // "description": "Permanently deletes all trashed files of a user or shared drive.", + // "description": "Permanently deletes all of the user's trashed files.", + // "flatPath": "files/trash", // "httpMethod": "DELETE", // "id": "drive.files.emptyTrash", + // "parameterOrder": [], // "parameters": { // "driveId": { // "description": "If set, empties the trash of the provided shared drive.", @@ -9392,7 +9461,7 @@ func (c *FilesEmptyTrashCall) Do(opts ...googleapi.CallOption) error { // }, // "enforceSingleParent": { // "default": "false", - // "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.", + // "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 is placed under its owner's root.", // "location": "query", // "type": "boolean" // } @@ -9520,6 +9589,7 @@ func (c *FilesExportCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.", + // "flatPath": "files/{fileId}/export", // "httpMethod": "GET", // "id": "drive.files.export", // "parameterOrder": [ @@ -9534,7 +9604,7 @@ func (c *FilesExportCall) Do(opts ...googleapi.CallOption) error { // "type": "string" // }, // "mimeType": { - // "description": "The MIME type of the format requested for this export.", + // "description": "Required. The MIME type of the format requested for this export.", // "location": "query", // "required": true, // "type": "string" @@ -9546,7 +9616,8 @@ func (c *FilesExportCall) Do(opts ...googleapi.CallOption) error { // "https://www.googleapis.com/auth/drive.file", // "https://www.googleapis.com/auth/drive.readonly" // ], - // "supportsMediaDownload": true + // "supportsMediaDownload": true, + // "useMediaDownloadService": true // } } @@ -9576,17 +9647,17 @@ func (c *FilesGenerateIdsCall) MaxResults(maxResults int64) *FilesGenerateIdsCal } // Space sets the optional parameter "space": The space in which the IDs -// can be used to create new files. Supported values are 'drive' and -// 'appDataFolder'. (Default: 'drive') +// can be used to create new files. Supported values are `drive` and +// `appDataFolder`. (Default: `drive`) func (c *FilesGenerateIdsCall) Space(space string) *FilesGenerateIdsCall { c.urlParams_.Set("space", space) return c } // Type sets the optional parameter "type": The type of items which the -// IDs can be used for. Supported values are 'files' and 'shortcuts'. -// Note that 'shortcuts' are only supported in the drive 'space'. -// (Default: 'files') +// IDs can be used for. Supported values are `files` and `shortcuts`. +// Note that `shortcuts` are only supported in the `drive` `space`. +// (Default: `files`) func (c *FilesGenerateIdsCall) Type(type_ string) *FilesGenerateIdsCall { c.urlParams_.Set("type", type_) return c @@ -9689,8 +9760,10 @@ func (c *FilesGenerateIdsCall) Do(opts ...googleapi.CallOption) (*GeneratedIds, return ret, nil // { // "description": "Generates a set of file IDs which can be provided in insert or copy requests.", + // "flatPath": "files/generateIds", // "httpMethod": "GET", // "id": "drive.files.generateIds", + // "parameterOrder": [], // "parameters": { // "maxResults": { // "default": "10", @@ -9703,13 +9776,13 @@ func (c *FilesGenerateIdsCall) Do(opts ...googleapi.CallOption) (*GeneratedIds, // }, // "space": { // "default": "drive", - // "description": "The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. (Default: 'drive')", + // "description": "The space in which the IDs can be used to create new files. Supported values are `drive` and `appDataFolder`. (Default: `drive`)", // "location": "query", // "type": "string" // }, // "type": { // "default": "files", - // "description": "The type of items which the IDs can be used for. Supported values are 'files' and 'shortcuts'. Note that 'shortcuts' are only supported in the drive 'space'. (Default: 'files')", + // "description": "The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`)", // "location": "query", // "type": "string" // } @@ -9738,7 +9811,13 @@ type FilesGetCall struct { header_ http.Header } -// Get: Gets a file's metadata or content by ID. +// Get: Gets a file's metadata or content by ID. If you provide the URL +// parameter `alt=media`, then the response includes the file contents +// in the response body. Downloading content with `alt=media` only works +// if the file is stored in Drive. To download Google Docs, Sheets, and +// Slides use `files.export` (/drive/api/reference/rest/v2/files/export) +// instead. For more information, see Download & export files +// (/drive/api/guides/manage-downloads). // // - fileId: The ID for the file in question. func (r *FilesService) Get(fileId string) *FilesGetCall { @@ -9756,7 +9835,7 @@ func (c *FilesGetCall) AcknowledgeAbuse(acknowledgeAbuse bool) *FilesGetCall { } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesGetCall) IncludeLabels(includeLabels string) *FilesGetCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -9765,20 +9844,20 @@ func (c *FilesGetCall) IncludeLabels(includeLabels string) *FilesGetCall { // IncludePermissionsForView sets the optional parameter // "includePermissionsForView": Specifies which additional view's -// permissions to include in the response. Only 'published' is +// permissions to include in the response. Only `published` is // supported. func (c *FilesGetCall) IncludePermissionsForView(includePermissionsForView string) *FilesGetCall { c.urlParams_.Set("includePermissionsForView", includePermissionsForView) return c } -// Projection sets the optional parameter "projection": This parameter -// is deprecated and has no function. +// Projection sets the optional parameter "projection": Deprecated: This +// parameter has no function. // // Possible values: // -// "BASIC" - Deprecated -// "FULL" - Deprecated +// "BASIC" - Deprecated. +// "FULL" - Deprecated. func (c *FilesGetCall) Projection(projection string) *FilesGetCall { c.urlParams_.Set("projection", projection) return c @@ -9801,15 +9880,15 @@ func (c *FilesGetCall) SupportsAllDrives(supportsAllDrives bool) *FilesGetCall { } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesGetCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesGetCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c } // UpdateViewedDate sets the optional parameter "updateViewedDate": -// Deprecated: Use files.update with modifiedDateBehavior=noChange, -// updateViewedDate=true and an empty request body. +// Deprecated: Use `files.update` with `modifiedDateBehavior=noChange, +// updateViewedDate=true` and an empty request body. func (c *FilesGetCall) UpdateViewedDate(updateViewedDate bool) *FilesGetCall { c.urlParams_.Set("updateViewedDate", fmt.Sprint(updateViewedDate)) return c @@ -9930,7 +10009,8 @@ func (c *FilesGetCall) Do(opts ...googleapi.CallOption) (*File, error) { } return ret, nil // { - // "description": "Gets a file's metadata or content by ID.", + // "description": " Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v2/files/export) instead. For more information, see [Download \u0026 export files](/drive/api/guides/manage-downloads).", + // "flatPath": "files/{fileId}", // "httpMethod": "GET", // "id": "drive.files.get", // "parameterOrder": [ @@ -9950,24 +10030,24 @@ func (c *FilesGetCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "string" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, // "includePermissionsForView": { - // "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + // "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", // "location": "query", // "type": "string" // }, // "projection": { - // "description": "This parameter is deprecated and has no function.", + // "description": "Deprecated: This parameter has no function.", // "enum": [ // "BASIC", // "FULL" // ], // "enumDescriptions": [ - // "Deprecated", - // "Deprecated" + // "Deprecated.", + // "Deprecated." // ], // "location": "query", // "type": "string" @@ -9985,13 +10065,13 @@ func (c *FilesGetCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "updateViewedDate": { // "default": "false", - // "description": "Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.", + // "description": "Deprecated: Use `files.update` with `modifiedDateBehavior=noChange, updateViewedDate=true` and an empty request body.", // "location": "query", // "type": "boolean" // } @@ -10027,7 +10107,25 @@ type FilesInsertCall struct { header_ http.Header } -// Insert: Insert a new file. +// Insert: Inserts a new file. This method supports an */upload* URI +// and accepts uploaded media with the following characteristics: - +// *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` +// Note: Specify a valid MIME type, rather than the literal `*/*` value. +// The literal `*/*` is only used to indicate that any valid MIME type +// can be uploaded. For more information on uploading files, see Upload +// file data (/drive/api/guides/manage-uploads). Apps creating shortcuts +// with `files.insert` must specify the MIME type +// `application/vnd.google-apps.shortcut`. Apps should specify a file +// extension in the `title` property when inserting files with the API. +// For example, an operation to insert a JPEG file should specify +// something like "title": "cat.jpg" in the metadata. Subsequent `GET` +// requests include the read-only `fileExtension` property populated +// with the extension originally specified in the `title` property. When +// a Google Drive user requests to download a file, or when the file is +// downloaded through the sync client, Drive builds a full filename +// (with extension) based on the title. In cases where the extension is +// missing, Drive attempts to determine the extension based on the +// file's MIME type. func (r *FilesService) Insert(file *File) *FilesInsertCall { c := &FilesInsertCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.file = file @@ -10042,7 +10140,7 @@ func (c *FilesInsertCall) Convert(convert bool) *FilesInsertCall { } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. Creating files in multiple folders +// "enforceSingleParent": Deprecated: Creating files in multiple folders // is no longer supported. func (c *FilesInsertCall) EnforceSingleParent(enforceSingleParent bool) *FilesInsertCall { c.urlParams_.Set("enforceSingleParent", fmt.Sprint(enforceSingleParent)) @@ -10050,7 +10148,7 @@ func (c *FilesInsertCall) EnforceSingleParent(enforceSingleParent bool) *FilesIn } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesInsertCall) IncludeLabels(includeLabels string) *FilesInsertCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -10059,7 +10157,7 @@ func (c *FilesInsertCall) IncludeLabels(includeLabels string) *FilesInsertCall { // IncludePermissionsForView sets the optional parameter // "includePermissionsForView": Specifies which additional view's -// permissions to include in the response. Only 'published' is +// permissions to include in the response. Only `published` is // supported. func (c *FilesInsertCall) IncludePermissionsForView(includePermissionsForView string) *FilesInsertCall { c.urlParams_.Set("includePermissionsForView", includePermissionsForView) @@ -10097,7 +10195,7 @@ func (c *FilesInsertCall) SupportsAllDrives(supportsAllDrives bool) *FilesInsert } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesInsertCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesInsertCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -10295,14 +10393,15 @@ func (c *FilesInsertCall) Do(opts ...googleapi.CallOption) (*File, error) { } return ret, nil // { - // "description": "Insert a new file.", + // "description": " Inserts a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.insert` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `title` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"title\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.", + // "flatPath": "files", // "httpMethod": "POST", // "id": "drive.files.insert", // "mediaUpload": { // "accept": [ // "*/*" // ], - // "maxSize": "5120GB", + // "maxSize": "5497558138880", // "protocols": { // "resumable": { // "multipart": true, @@ -10314,6 +10413,7 @@ func (c *FilesInsertCall) Do(opts ...googleapi.CallOption) (*File, error) { // } // } // }, + // "parameterOrder": [], // "parameters": { // "convert": { // "default": "false", @@ -10323,17 +10423,17 @@ func (c *FilesInsertCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "enforceSingleParent": { // "default": "false", - // "description": "Deprecated. Creating files in multiple folders is no longer supported.", + // "description": "Deprecated: Creating files in multiple folders is no longer supported.", // "location": "query", // "type": "boolean" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, // "includePermissionsForView": { - // "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + // "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", // "location": "query", // "type": "string" // }, @@ -10362,7 +10462,7 @@ func (c *FilesInsertCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -10410,8 +10510,7 @@ func (c *FilesInsertCall) Do(opts ...googleapi.CallOption) (*File, error) { // "https://www.googleapis.com/auth/drive.apps.readonly", // "https://www.googleapis.com/auth/drive.file" // ], - // "supportsMediaUpload": true, - // "supportsSubscription": true + // "supportsMediaUpload": true // } } @@ -10426,28 +10525,30 @@ type FilesListCall struct { header_ http.Header } -// List: Lists the user's files. +// List: Lists the user's files. This method accepts the `q` parameter, +// which is a search query combining one or more search terms. For more +// information, see the Search for files & folders +// (/drive/api/guides/search-files) guide. *Note:* This method returns +// *all* files by default, including trashed files. If you don't want +// trashed files to appear in the list, use the `trashed=false` query +// parameter to remove trashed files from the results. func (r *FilesService) List() *FilesListCall { c := &FilesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} return c } -// Corpora sets the optional parameter "corpora": Groupings of files to -// which the query applies. Supported groupings are: 'user' (files -// created by, opened by, or shared directly with the user), 'drive' -// (files in the specified shared drive as indicated by the 'driveId'), -// 'domain' (files shared to the user's domain), and 'allDrives' (A -// combination of 'user' and 'drive' for all drives where the user is a -// member). When able, use 'user' or 'drive', instead of 'allDrives', -// for efficiency. +// Corpora sets the optional parameter "corpora": Bodies of items +// (files/documents) to which the query applies. Supported bodies are +// `default`, `domain`, `drive` and `allDrives`. Prefer `default` or +// `drive` to `allDrives` for efficiency. func (c *FilesListCall) Corpora(corpora string) *FilesListCall { c.urlParams_.Set("corpora", corpora) return c } -// Corpus sets the optional parameter "corpus": The body of items -// (files/documents) to which the query applies. Deprecated: use -// 'corpora' instead. +// Corpus sets the optional parameter "corpus": Deprecated: The body of +// items (files/documents) to which the query applies. Use `corpora` +// instead. // // Possible values: // @@ -10474,7 +10575,7 @@ func (c *FilesListCall) IncludeItemsFromAllDrives(includeItemsFromAllDrives bool } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesListCall) IncludeLabels(includeLabels string) *FilesListCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -10483,7 +10584,7 @@ func (c *FilesListCall) IncludeLabels(includeLabels string) *FilesListCall { // IncludePermissionsForView sets the optional parameter // "includePermissionsForView": Specifies which additional view's -// permissions to include in the response. Only 'published' is +// permissions to include in the response. Only `published` is // supported. func (c *FilesListCall) IncludePermissionsForView(includePermissionsForView string) *FilesListCall { c.urlParams_.Set("includePermissionsForView", includePermissionsForView) @@ -10491,7 +10592,7 @@ func (c *FilesListCall) IncludePermissionsForView(includePermissionsForView stri } // IncludeTeamDriveItems sets the optional parameter -// "includeTeamDriveItems": Deprecated use includeItemsFromAllDrives +// "includeTeamDriveItems": Deprecated: Use `includeItemsFromAllDrives` // instead. func (c *FilesListCall) IncludeTeamDriveItems(includeTeamDriveItems bool) *FilesListCall { c.urlParams_.Set("includeTeamDriveItems", fmt.Sprint(includeTeamDriveItems)) @@ -10507,11 +10608,11 @@ func (c *FilesListCall) MaxResults(maxResults int64) *FilesListCall { } // OrderBy sets the optional parameter "orderBy": A comma-separated list -// of sort keys. Valid keys are 'createdDate', 'folder', -// 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', -// 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', -// and 'title_natural'. Each key sorts ascending by default, but may be -// reversed with the 'desc' modifier. Example usage: +// of sort keys. Valid keys are `createdDate`, `folder`, +// `lastViewedByMeDate`, `modifiedByMeDate`, `modifiedDate`, +// `quotaBytesUsed`, `recency`, `sharedWithMeDate`, `starred`, `title`, +// and `title_natural`. Each key sorts ascending by default, but may be +// reversed with the `desc` modifier. Example usage: // ?orderBy=folder,modifiedDate desc,title. Please note that there is a // current limitation for users with approximately one million files in // which the requested sort order is ignored. @@ -10527,13 +10628,13 @@ func (c *FilesListCall) PageToken(pageToken string) *FilesListCall { return c } -// Projection sets the optional parameter "projection": This parameter -// is deprecated and has no function. +// Projection sets the optional parameter "projection": Deprecated: This +// parameter has no function. // // Possible values: // -// "BASIC" - Deprecated -// "FULL" - Deprecated +// "BASIC" - Deprecated. +// "FULL" - Deprecated. func (c *FilesListCall) Projection(projection string) *FilesListCall { c.urlParams_.Set("projection", projection) return c @@ -10546,7 +10647,8 @@ func (c *FilesListCall) Q(q string) *FilesListCall { } // Spaces sets the optional parameter "spaces": A comma-separated list -// of spaces to query. Supported values are 'drive' and 'appDataFolder'. +// of spaces to query. Supported values are `drive`, and +// `appDataFolder`. func (c *FilesListCall) Spaces(spaces string) *FilesListCall { c.urlParams_.Set("spaces", spaces) return c @@ -10561,14 +10663,14 @@ func (c *FilesListCall) SupportsAllDrives(supportsAllDrives bool) *FilesListCall } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesListCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesListCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c } -// TeamDriveId sets the optional parameter "teamDriveId": Deprecated use -// driveId instead. +// TeamDriveId sets the optional parameter "teamDriveId": Deprecated: +// Use `driveId` instead. func (c *FilesListCall) TeamDriveId(teamDriveId string) *FilesListCall { c.urlParams_.Set("teamDriveId", teamDriveId) return c @@ -10670,17 +10772,19 @@ func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error) { } return ret, nil // { - // "description": "Lists the user's files.", + // "description": " Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files \u0026 folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", + // "flatPath": "files", // "httpMethod": "GET", // "id": "drive.files.list", + // "parameterOrder": [], // "parameters": { // "corpora": { - // "description": "Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency.", + // "description": "Bodies of items (files/documents) to which the query applies. Supported bodies are `default`, `domain`, `drive` and `allDrives`. Prefer `default` or `drive` to `allDrives` for efficiency.", // "location": "query", // "type": "string" // }, // "corpus": { - // "description": "The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead.", + // "description": "Deprecated: The body of items (files/documents) to which the query applies. Use `corpora` instead.", // "enum": [ // "DEFAULT", // "DOMAIN" @@ -10704,18 +10808,18 @@ func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error) { // "type": "boolean" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, // "includePermissionsForView": { - // "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + // "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", // "location": "query", // "type": "string" // }, // "includeTeamDriveItems": { // "default": "false", - // "description": "Deprecated use includeItemsFromAllDrives instead.", + // "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -10728,7 +10832,7 @@ func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error) { // "type": "integer" // }, // "orderBy": { - // "description": "A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', and 'title_natural'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.", + // "description": "A comma-separated list of sort keys. Valid keys are `createdDate`, `folder`, `lastViewedByMeDate`, `modifiedByMeDate`, `modifiedDate`, `quotaBytesUsed`, `recency`, `sharedWithMeDate`, `starred`, `title`, and `title_natural`. Each key sorts ascending by default, but may be reversed with the `desc` modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.", // "location": "query", // "type": "string" // }, @@ -10738,14 +10842,14 @@ func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error) { // "type": "string" // }, // "projection": { - // "description": "This parameter is deprecated and has no function.", + // "description": "Deprecated: This parameter has no function.", // "enum": [ // "BASIC", // "FULL" // ], // "enumDescriptions": [ - // "Deprecated", - // "Deprecated" + // "Deprecated.", + // "Deprecated." // ], // "location": "query", // "type": "string" @@ -10756,7 +10860,7 @@ func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error) { // "type": "string" // }, // "spaces": { - // "description": "A comma-separated list of spaces to query. Supported values are 'drive' and 'appDataFolder'.", + // "description": "A comma-separated list of spaces to query. Supported values are `drive`, and `appDataFolder`.", // "location": "query", // "type": "string" // }, @@ -10768,12 +10872,12 @@ func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "teamDriveId": { - // "description": "Deprecated use driveId instead.", + // "description": "Deprecated: Use `driveId` instead.", // "location": "query", // "type": "string" // } @@ -10830,7 +10934,7 @@ type FilesListLabelsCall struct { // ListLabels: Lists the labels on a file. // -// - fileId: The ID of the file. +// - fileId: The ID for the file or shared drive. func (r *FilesService) ListLabels(fileId string) *FilesListLabelsCall { c := &FilesListLabelsCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.fileId = fileId @@ -10838,8 +10942,7 @@ func (r *FilesService) ListLabels(fileId string) *FilesListLabelsCall { } // MaxResults sets the optional parameter "maxResults": The maximum -// number of labels to return per page. When not set, this defaults to -// 100. +// number of labels to return per page. When not set, defaults to 100. func (c *FilesListLabelsCall) MaxResults(maxResults int64) *FilesListLabelsCall { c.urlParams_.Set("maxResults", fmt.Sprint(maxResults)) return c @@ -10847,7 +10950,7 @@ func (c *FilesListLabelsCall) MaxResults(maxResults int64) *FilesListLabelsCall // PageToken sets the optional parameter "pageToken": The token for // continuing a previous list request on the next page. This should be -// set to the value of 'nextPageToken' from the previous response. +// set to the value of `nextPageToken` from the previous response. func (c *FilesListLabelsCall) PageToken(pageToken string) *FilesListLabelsCall { c.urlParams_.Set("pageToken", pageToken) return c @@ -10953,6 +11056,7 @@ func (c *FilesListLabelsCall) Do(opts ...googleapi.CallOption) (*LabelList, erro return ret, nil // { // "description": "Lists the labels on a file.", + // "flatPath": "files/{fileId}/listLabels", // "httpMethod": "GET", // "id": "drive.files.listLabels", // "parameterOrder": [ @@ -10960,14 +11064,14 @@ func (c *FilesListLabelsCall) Do(opts ...googleapi.CallOption) (*LabelList, erro // ], // "parameters": { // "fileId": { - // "description": "The ID of the file.", + // "description": "The ID for the file or shared drive.", // "location": "path", // "required": true, // "type": "string" // }, // "maxResults": { // "default": "100", - // "description": "The maximum number of labels to return per page. When not set, this defaults to 100.", + // "description": "The maximum number of labels to return per page. When not set, defaults to 100.", // "format": "int32", // "location": "query", // "maximum": "100", @@ -10975,7 +11079,7 @@ func (c *FilesListLabelsCall) Do(opts ...googleapi.CallOption) (*LabelList, erro // "type": "integer" // }, // "pageToken": { - // "description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.", + // "description": "The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.", // "location": "query", // "type": "string" // } @@ -11027,9 +11131,10 @@ type FilesModifyLabelsCall struct { header_ http.Header } -// ModifyLabels: Modifies the set of labels on a file. +// ModifyLabels: Modifies the set of labels applied to a file. Returns a +// list of the labels that were added or modified. // -// - fileId: The ID of the file for which the labels are modified. +// - fileId: The ID of the file to which the labels belong. func (r *FilesService) ModifyLabels(fileId string, modifylabelsrequest *ModifyLabelsRequest) *FilesModifyLabelsCall { c := &FilesModifyLabelsCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.fileId = fileId @@ -11128,7 +11233,8 @@ func (c *FilesModifyLabelsCall) Do(opts ...googleapi.CallOption) (*ModifyLabelsR } return ret, nil // { - // "description": "Modifies the set of labels on a file.", + // "description": "Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.", + // "flatPath": "files/{fileId}/modifyLabels", // "httpMethod": "POST", // "id": "drive.files.modifyLabels", // "parameterOrder": [ @@ -11136,7 +11242,7 @@ func (c *FilesModifyLabelsCall) Do(opts ...googleapi.CallOption) (*ModifyLabelsR // ], // "parameters": { // "fileId": { - // "description": "The ID of the file for which the labels are modified.", + // "description": "The ID of the file to which the labels belong.", // "location": "path", // "required": true, // "type": "string" @@ -11189,23 +11295,23 @@ func (c *FilesPatchCall) AddParents(addParents string) *FilesPatchCall { return c } -// Convert sets the optional parameter "convert": This parameter is -// deprecated and has no function. +// Convert sets the optional parameter "convert": Deprecated: This +// parameter has no function. func (c *FilesPatchCall) Convert(convert bool) *FilesPatchCall { c.urlParams_.Set("convert", fmt.Sprint(convert)) return c } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. Adding files to multiple folders -// is no longer supported. Use shortcuts instead. +// "enforceSingleParent": Deprecated: Adding files to multiple folders +// is no longer supported. Use `shortcuts` instead. func (c *FilesPatchCall) EnforceSingleParent(enforceSingleParent bool) *FilesPatchCall { c.urlParams_.Set("enforceSingleParent", fmt.Sprint(enforceSingleParent)) return c } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesPatchCall) IncludeLabels(includeLabels string) *FilesPatchCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -11214,7 +11320,7 @@ func (c *FilesPatchCall) IncludeLabels(includeLabels string) *FilesPatchCall { // IncludePermissionsForView sets the optional parameter // "includePermissionsForView": Specifies which additional view's -// permissions to include in the response. Only 'published' is +// permissions to include in the response. Only `published` is // supported. func (c *FilesPatchCall) IncludePermissionsForView(includePermissionsForView string) *FilesPatchCall { c.urlParams_.Set("includePermissionsForView", includePermissionsForView) @@ -11222,26 +11328,26 @@ func (c *FilesPatchCall) IncludePermissionsForView(includePermissionsForView str } // ModifiedDateBehavior sets the optional parameter -// "modifiedDateBehavior": Determines the behavior in which modifiedDate -// is updated. This overrides setModifiedDate. +// "modifiedDateBehavior": Determines the behavior in which +// `modifiedDate` is updated. This overrides `setModifiedDate`. // // Possible values: // -// "fromBody" - Set modifiedDate to the value provided in the body of +// "fromBody" - Set `modifiedDate` to the value provided in the body // -// the request. No change if no value was provided. +// of the request. No change if no value was provided. // -// "fromBodyIfNeeded" - Set modifiedDate to the value provided in the +// "fromBodyIfNeeded" - Set `modifiedDate` to the value provided in // -// body of the request depending on other contents of the update. +// the body of the request depending on other contents of the update. // // "fromBodyOrNow" - Set modifiedDate to the value provided in the // // body of the request, or to the current time if no value was provided. // -// "noChange" - Maintain the previous value of modifiedDate. -// "now" - Set modifiedDate to the current time. -// "nowIfNeeded" - Set modifiedDate to the current time depending on +// "noChange" - Maintain the previous value of `modifiedDate`. +// "now" - Set `modifiedDate` to the current time. +// "nowIfNeeded" - Set `modifiedDate` to the current time depending on // // contents of the update. func (c *FilesPatchCall) ModifiedDateBehavior(modifiedDateBehavior string) *FilesPatchCall { @@ -11256,8 +11362,8 @@ func (c *FilesPatchCall) ModifiedDateBehavior(modifiedDateBehavior string) *File // preserved for a short period of time. Pinned revisions are stored // indefinitely, using additional storage quota, up to a maximum of 200 // revisions. For details on how revisions are retained, see the Drive -// Help Center. Note that this field is ignored if there is no payload -// in the request. +// Help Center (https://support.google.com/drive/answer/2409045). Note +// that this field is ignored if there is no payload in the request. func (c *FilesPatchCall) NewRevision(newRevision bool) *FilesPatchCall { c.urlParams_.Set("newRevision", fmt.Sprint(newRevision)) return c @@ -11294,10 +11400,10 @@ func (c *FilesPatchCall) RemoveParents(removeParents string) *FilesPatchCall { // SetModifiedDate sets the optional parameter "setModifiedDate": // Whether to set the modified date using the value supplied in the -// request body. Setting this field to true is equivalent to -// modifiedDateBehavior=fromBodyOrNow, and false is equivalent to -// modifiedDateBehavior=now. To prevent any changes to the modified date -// set modifiedDateBehavior=noChange. +// request body. Setting this field to `true` is equivalent to +// `modifiedDateBehavior=fromBodyOrNow`, and `false` is equivalent to +// `modifiedDateBehavior=now`. To prevent any changes to the modified +// date set `modifiedDateBehavior=noChange`. func (c *FilesPatchCall) SetModifiedDate(setModifiedDate bool) *FilesPatchCall { c.urlParams_.Set("setModifiedDate", fmt.Sprint(setModifiedDate)) return c @@ -11312,7 +11418,7 @@ func (c *FilesPatchCall) SupportsAllDrives(supportsAllDrives bool) *FilesPatchCa } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesPatchCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesPatchCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -11439,6 +11545,7 @@ func (c *FilesPatchCall) Do(opts ...googleapi.CallOption) (*File, error) { return ret, nil // { // "description": "Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.", + // "flatPath": "files/{fileId}", // "httpMethod": "PATCH", // "id": "drive.files.patch", // "parameterOrder": [ @@ -11452,13 +11559,13 @@ func (c *FilesPatchCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "convert": { // "default": "false", - // "description": "This parameter is deprecated and has no function.", + // "description": "Deprecated: This parameter has no function.", // "location": "query", // "type": "boolean" // }, // "enforceSingleParent": { // "default": "false", - // "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", + // "description": "Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead.", // "location": "query", // "type": "boolean" // }, @@ -11469,17 +11576,17 @@ func (c *FilesPatchCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "string" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, // "includePermissionsForView": { - // "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + // "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", // "location": "query", // "type": "string" // }, // "modifiedDateBehavior": { - // "description": "Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.", + // "description": "Determines the behavior in which `modifiedDate` is updated. This overrides `setModifiedDate`.", // "enum": [ // "fromBody", // "fromBodyIfNeeded", @@ -11489,19 +11596,19 @@ func (c *FilesPatchCall) Do(opts ...googleapi.CallOption) (*File, error) { // "nowIfNeeded" // ], // "enumDescriptions": [ - // "Set modifiedDate to the value provided in the body of the request. No change if no value was provided.", - // "Set modifiedDate to the value provided in the body of the request depending on other contents of the update.", + // "Set `modifiedDate` to the value provided in the body of the request. No change if no value was provided.", + // "Set `modifiedDate` to the value provided in the body of the request depending on other contents of the update.", // "Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.", - // "Maintain the previous value of modifiedDate.", - // "Set modifiedDate to the current time.", - // "Set modifiedDate to the current time depending on contents of the update." + // "Maintain the previous value of `modifiedDate`.", + // "Set `modifiedDate` to the current time.", + // "Set `modifiedDate` to the current time depending on contents of the update." // ], // "location": "query", // "type": "string" // }, // "newRevision": { // "default": "true", - // "description": "Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. Note that this field is ignored if there is no payload in the request.", + // "description": "Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the [Drive Help Center](https://support.google.com/drive/answer/2409045). Note that this field is ignored if there is no payload in the request.", // "location": "query", // "type": "boolean" // }, @@ -11529,7 +11636,7 @@ func (c *FilesPatchCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "setModifiedDate": { // "default": "false", - // "description": "Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.", + // "description": "Whether to set the modified date using the value supplied in the request body. Setting this field to `true` is equivalent to `modifiedDateBehavior=fromBodyOrNow`, and `false` is equivalent to `modifiedDateBehavior=now`. To prevent any changes to the modified date set `modifiedDateBehavior=noChange`.", // "location": "query", // "type": "boolean" // }, @@ -11541,7 +11648,7 @@ func (c *FilesPatchCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -11607,7 +11714,7 @@ func (r *FilesService) Touch(fileId string) *FilesTouchCall { } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesTouchCall) IncludeLabels(includeLabels string) *FilesTouchCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -11616,7 +11723,7 @@ func (c *FilesTouchCall) IncludeLabels(includeLabels string) *FilesTouchCall { // IncludePermissionsForView sets the optional parameter // "includePermissionsForView": Specifies which additional view's -// permissions to include in the response. Only 'published' is +// permissions to include in the response. Only `published` is // supported. func (c *FilesTouchCall) IncludePermissionsForView(includePermissionsForView string) *FilesTouchCall { c.urlParams_.Set("includePermissionsForView", includePermissionsForView) @@ -11632,7 +11739,7 @@ func (c *FilesTouchCall) SupportsAllDrives(supportsAllDrives bool) *FilesTouchCa } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesTouchCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesTouchCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -11725,6 +11832,7 @@ func (c *FilesTouchCall) Do(opts ...googleapi.CallOption) (*File, error) { return ret, nil // { // "description": "Set the file's updated time to the current server time.", + // "flatPath": "files/{fileId}/touch", // "httpMethod": "POST", // "id": "drive.files.touch", // "parameterOrder": [ @@ -11738,12 +11846,12 @@ func (c *FilesTouchCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "string" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, // "includePermissionsForView": { - // "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + // "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", // "location": "query", // "type": "string" // }, @@ -11755,7 +11863,7 @@ func (c *FilesTouchCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // } @@ -11785,13 +11893,16 @@ type FilesTrashCall struct { header_ http.Header } -// Trash: Moves a file to the trash. The currently authenticated user -// must own the file or be at least a fileOrganizer on the parent for +// Trash: Moves a file to the trash. The currently authenticated user +// must own the file or be at least a `fileOrganizer` on the parent for // shared drive files. Only the owner may trash a file. The trashed item -// is excluded from all files.list responses returned for any user who -// does not own the file. However, all users with access to the file can +// is excluded from all `files.list` responses returned for any user who +// doesn't own the file. However, all users with access to the file can // see the trashed item metadata in an API response. All users with -// access can copy, download, export, and share the file. +// access can copy, download, export, and share the file. *Note:* Files +// moved to the trash still appear by default in results from the +// `files.list` method. To permanently remove a file, use +// `files.delete`. // // - fileId: The ID of the file to trash. func (r *FilesService) Trash(fileId string) *FilesTrashCall { @@ -11801,7 +11912,7 @@ func (r *FilesService) Trash(fileId string) *FilesTrashCall { } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesTrashCall) IncludeLabels(includeLabels string) *FilesTrashCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -11810,7 +11921,7 @@ func (c *FilesTrashCall) IncludeLabels(includeLabels string) *FilesTrashCall { // IncludePermissionsForView sets the optional parameter // "includePermissionsForView": Specifies which additional view's -// permissions to include in the response. Only 'published' is +// permissions to include in the response. Only `published` is // supported. func (c *FilesTrashCall) IncludePermissionsForView(includePermissionsForView string) *FilesTrashCall { c.urlParams_.Set("includePermissionsForView", includePermissionsForView) @@ -11826,7 +11937,7 @@ func (c *FilesTrashCall) SupportsAllDrives(supportsAllDrives bool) *FilesTrashCa } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesTrashCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesTrashCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -11918,7 +12029,8 @@ func (c *FilesTrashCall) Do(opts ...googleapi.CallOption) (*File, error) { } return ret, nil // { - // "description": "Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.", + // "description": " Moves a file to the trash. The currently authenticated user must own the file or be at least a `fileOrganizer` on the parent for shared drive files. Only the owner may trash a file. The trashed item is excluded from all `files.list` responses returned for any user who doesn't own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file. *Note:* Files moved to the trash still appear by default in results from the `files.list` method. To permanently remove a file, use `files.delete`.", + // "flatPath": "files/{fileId}/trash", // "httpMethod": "POST", // "id": "drive.files.trash", // "parameterOrder": [ @@ -11932,12 +12044,12 @@ func (c *FilesTrashCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "string" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, // "includePermissionsForView": { - // "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + // "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", // "location": "query", // "type": "string" // }, @@ -11949,7 +12061,7 @@ func (c *FilesTrashCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // } @@ -11979,7 +12091,7 @@ type FilesUntrashCall struct { } // Untrash: Restores a file from the trash. The currently authenticated -// user must own the file or be at least a fileOrganizer on the parent +// user must own the file or be at least a `fileOrganizer` on the parent // for shared drive files. Only the owner may untrash a file. // // - fileId: The ID of the file to untrash. @@ -11990,7 +12102,7 @@ func (r *FilesService) Untrash(fileId string) *FilesUntrashCall { } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesUntrashCall) IncludeLabels(includeLabels string) *FilesUntrashCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -11999,7 +12111,7 @@ func (c *FilesUntrashCall) IncludeLabels(includeLabels string) *FilesUntrashCall // IncludePermissionsForView sets the optional parameter // "includePermissionsForView": Specifies which additional view's -// permissions to include in the response. Only 'published' is +// permissions to include in the response. Only `published` is // supported. func (c *FilesUntrashCall) IncludePermissionsForView(includePermissionsForView string) *FilesUntrashCall { c.urlParams_.Set("includePermissionsForView", includePermissionsForView) @@ -12015,7 +12127,7 @@ func (c *FilesUntrashCall) SupportsAllDrives(supportsAllDrives bool) *FilesUntra } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesUntrashCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesUntrashCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -12107,7 +12219,8 @@ func (c *FilesUntrashCall) Do(opts ...googleapi.CallOption) (*File, error) { } return ret, nil // { - // "description": "Restores a file from the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may untrash a file.", + // "description": "Restores a file from the trash. The currently authenticated user must own the file or be at least a `fileOrganizer` on the parent for shared drive files. Only the owner may untrash a file.", + // "flatPath": "files/{fileId}/untrash", // "httpMethod": "POST", // "id": "drive.files.untrash", // "parameterOrder": [ @@ -12121,12 +12234,12 @@ func (c *FilesUntrashCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "string" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, // "includePermissionsForView": { - // "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + // "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", // "location": "query", // "type": "string" // }, @@ -12138,7 +12251,7 @@ func (c *FilesUntrashCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // } @@ -12169,10 +12282,17 @@ type FilesUpdateCall struct { header_ http.Header } -// Update: Updates a file's metadata and/or content. When calling this +// Update: Updates a file's metadata and/or content. When calling this // method, only populate fields in the request that you want to modify. // When updating fields, some fields might be changed automatically, -// such as modifiedDate. This method supports patch semantics. +// such as `modifiedDate`. This method supports patch semantics. This +// method supports an */upload* URI and accepts uploaded media with the +// following characteristics: - *Maximum file size:* 5,120 GB - +// *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, +// rather than the literal `*/*` value. The literal `*/*` is only used +// to indicate that any valid MIME type can be uploaded. For more +// information on uploading files, see Upload file data +// (/drive/api/guides/manage-uploads). // // - fileId: The ID of the file to update. func (r *FilesService) Update(fileId string, file *File) *FilesUpdateCall { @@ -12189,23 +12309,23 @@ func (c *FilesUpdateCall) AddParents(addParents string) *FilesUpdateCall { return c } -// Convert sets the optional parameter "convert": This parameter is -// deprecated and has no function. +// Convert sets the optional parameter "convert": Deprecated: This +// parameter has no function. func (c *FilesUpdateCall) Convert(convert bool) *FilesUpdateCall { c.urlParams_.Set("convert", fmt.Sprint(convert)) return c } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. Adding files to multiple folders -// is no longer supported. Use shortcuts instead. +// "enforceSingleParent": Deprecated: Adding files to multiple folders +// is no longer supported. Use `shortcuts` instead. func (c *FilesUpdateCall) EnforceSingleParent(enforceSingleParent bool) *FilesUpdateCall { c.urlParams_.Set("enforceSingleParent", fmt.Sprint(enforceSingleParent)) return c } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesUpdateCall) IncludeLabels(includeLabels string) *FilesUpdateCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -12214,7 +12334,7 @@ func (c *FilesUpdateCall) IncludeLabels(includeLabels string) *FilesUpdateCall { // IncludePermissionsForView sets the optional parameter // "includePermissionsForView": Specifies which additional view's -// permissions to include in the response. Only 'published' is +// permissions to include in the response. Only `published` is // supported. func (c *FilesUpdateCall) IncludePermissionsForView(includePermissionsForView string) *FilesUpdateCall { c.urlParams_.Set("includePermissionsForView", includePermissionsForView) @@ -12222,26 +12342,26 @@ func (c *FilesUpdateCall) IncludePermissionsForView(includePermissionsForView st } // ModifiedDateBehavior sets the optional parameter -// "modifiedDateBehavior": Determines the behavior in which modifiedDate -// is updated. This overrides setModifiedDate. +// "modifiedDateBehavior": Determines the behavior in which +// `modifiedDate` is updated. This overrides `setModifiedDate`. // // Possible values: // -// "fromBody" - Set modifiedDate to the value provided in the body of +// "fromBody" - Set `modifiedDate` to the value provided in the body // -// the request. No change if no value was provided. +// of the request. No change if no value was provided. // -// "fromBodyIfNeeded" - Set modifiedDate to the value provided in the +// "fromBodyIfNeeded" - Set `modifiedDate` to the value provided in // -// body of the request depending on other contents of the update. +// the body of the request depending on other contents of the update. // // "fromBodyOrNow" - Set modifiedDate to the value provided in the // // body of the request, or to the current time if no value was provided. // -// "noChange" - Maintain the previous value of modifiedDate. -// "now" - Set modifiedDate to the current time. -// "nowIfNeeded" - Set modifiedDate to the current time depending on +// "noChange" - Maintain the previous value of `modifiedDate`. +// "now" - Set `modifiedDate` to the current time. +// "nowIfNeeded" - Set `modifiedDate` to the current time depending on // // contents of the update. func (c *FilesUpdateCall) ModifiedDateBehavior(modifiedDateBehavior string) *FilesUpdateCall { @@ -12256,8 +12376,7 @@ func (c *FilesUpdateCall) ModifiedDateBehavior(modifiedDateBehavior string) *Fil // preserved for a short period of time. Pinned revisions are stored // indefinitely, using additional storage quota, up to a maximum of 200 // revisions. For details on how revisions are retained, see the Drive -// Help Center. Note that this field is ignored if there is no payload -// in the request. +// Help Center (https://support.google.com/drive/answer/2409045). func (c *FilesUpdateCall) NewRevision(newRevision bool) *FilesUpdateCall { c.urlParams_.Set("newRevision", fmt.Sprint(newRevision)) return c @@ -12278,8 +12397,7 @@ func (c *FilesUpdateCall) OcrLanguage(ocrLanguage string) *FilesUpdateCall { } // Pinned sets the optional parameter "pinned": Whether to pin the new -// revision. A file can have a maximum of 200 pinned revisions. Note -// that this field is ignored if there is no payload in the request. +// revision. A file can have a maximum of 200 pinned revisions. func (c *FilesUpdateCall) Pinned(pinned bool) *FilesUpdateCall { c.urlParams_.Set("pinned", fmt.Sprint(pinned)) return c @@ -12294,10 +12412,10 @@ func (c *FilesUpdateCall) RemoveParents(removeParents string) *FilesUpdateCall { // SetModifiedDate sets the optional parameter "setModifiedDate": // Whether to set the modified date using the value supplied in the -// request body. Setting this field to true is equivalent to -// modifiedDateBehavior=fromBodyOrNow, and false is equivalent to -// modifiedDateBehavior=now. To prevent any changes to the modified date -// set modifiedDateBehavior=noChange. +// request body. Setting this field to `true` is equivalent to +// `modifiedDateBehavior=fromBodyOrNow`, and `false` is equivalent to +// `modifiedDateBehavior=now`. To prevent any changes to the modified +// date set `modifiedDateBehavior=noChange`. func (c *FilesUpdateCall) SetModifiedDate(setModifiedDate bool) *FilesUpdateCall { c.urlParams_.Set("setModifiedDate", fmt.Sprint(setModifiedDate)) return c @@ -12312,7 +12430,7 @@ func (c *FilesUpdateCall) SupportsAllDrives(supportsAllDrives bool) *FilesUpdate } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesUpdateCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesUpdateCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -12505,14 +12623,15 @@ func (c *FilesUpdateCall) Do(opts ...googleapi.CallOption) (*File, error) { } return ret, nil // { - // "description": "Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as modifiedDate. This method supports patch semantics.", + // "description": " Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads).", + // "flatPath": "files/{fileId}", // "httpMethod": "PUT", // "id": "drive.files.update", // "mediaUpload": { // "accept": [ // "*/*" // ], - // "maxSize": "5120GB", + // "maxSize": "5497558138880", // "protocols": { // "resumable": { // "multipart": true, @@ -12535,13 +12654,13 @@ func (c *FilesUpdateCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "convert": { // "default": "false", - // "description": "This parameter is deprecated and has no function.", + // "description": "Deprecated: This parameter has no function.", // "location": "query", // "type": "boolean" // }, // "enforceSingleParent": { // "default": "false", - // "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", + // "description": "Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead.", // "location": "query", // "type": "boolean" // }, @@ -12552,17 +12671,17 @@ func (c *FilesUpdateCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "string" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, // "includePermissionsForView": { - // "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + // "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", // "location": "query", // "type": "string" // }, // "modifiedDateBehavior": { - // "description": "Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.", + // "description": "Determines the behavior in which `modifiedDate` is updated. This overrides `setModifiedDate`.", // "enum": [ // "fromBody", // "fromBodyIfNeeded", @@ -12572,19 +12691,19 @@ func (c *FilesUpdateCall) Do(opts ...googleapi.CallOption) (*File, error) { // "nowIfNeeded" // ], // "enumDescriptions": [ - // "Set modifiedDate to the value provided in the body of the request. No change if no value was provided.", - // "Set modifiedDate to the value provided in the body of the request depending on other contents of the update.", + // "Set `modifiedDate` to the value provided in the body of the request. No change if no value was provided.", + // "Set `modifiedDate` to the value provided in the body of the request depending on other contents of the update.", // "Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.", - // "Maintain the previous value of modifiedDate.", - // "Set modifiedDate to the current time.", - // "Set modifiedDate to the current time depending on contents of the update." + // "Maintain the previous value of `modifiedDate`.", + // "Set `modifiedDate` to the current time.", + // "Set `modifiedDate` to the current time depending on contents of the update." // ], // "location": "query", // "type": "string" // }, // "newRevision": { // "default": "true", - // "description": "Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. Note that this field is ignored if there is no payload in the request.", + // "description": "Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the [Drive Help Center](https://support.google.com/drive/answer/2409045).", // "location": "query", // "type": "boolean" // }, @@ -12601,7 +12720,7 @@ func (c *FilesUpdateCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "pinned": { // "default": "false", - // "description": "Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. Note that this field is ignored if there is no payload in the request.", + // "description": "Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.", // "location": "query", // "type": "boolean" // }, @@ -12612,7 +12731,7 @@ func (c *FilesUpdateCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "setModifiedDate": { // "default": "false", - // "description": "Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.", + // "description": "Whether to set the modified date using the value supplied in the request body. Setting this field to `true` is equivalent to `modifiedDateBehavior=fromBodyOrNow`, and `false` is equivalent to `modifiedDateBehavior=now`. To prevent any changes to the modified date set `modifiedDateBehavior=noChange`.", // "location": "query", // "type": "boolean" // }, @@ -12624,7 +12743,7 @@ func (c *FilesUpdateCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -12682,7 +12801,7 @@ type FilesWatchCall struct { header_ http.Header } -// Watch: Subscribe to changes on a file. +// Watch: Subscribes to changes to a file. // // - fileId: The ID for the file in question. func (r *FilesService) Watch(fileId string, channel *Channel) *FilesWatchCall { @@ -12701,7 +12820,7 @@ func (c *FilesWatchCall) AcknowledgeAbuse(acknowledgeAbuse bool) *FilesWatchCall } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesWatchCall) IncludeLabels(includeLabels string) *FilesWatchCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -12710,20 +12829,20 @@ func (c *FilesWatchCall) IncludeLabels(includeLabels string) *FilesWatchCall { // IncludePermissionsForView sets the optional parameter // "includePermissionsForView": Specifies which additional view's -// permissions to include in the response. Only 'published' is +// permissions to include in the response. Only `published` is // supported. func (c *FilesWatchCall) IncludePermissionsForView(includePermissionsForView string) *FilesWatchCall { c.urlParams_.Set("includePermissionsForView", includePermissionsForView) return c } -// Projection sets the optional parameter "projection": This parameter -// is deprecated and has no function. +// Projection sets the optional parameter "projection": Deprecated: This +// parameter has no function. // // Possible values: // -// "BASIC" - Deprecated -// "FULL" - Deprecated +// "BASIC" - Deprecated. +// "FULL" - Deprecated. func (c *FilesWatchCall) Projection(projection string) *FilesWatchCall { c.urlParams_.Set("projection", projection) return c @@ -12746,7 +12865,7 @@ func (c *FilesWatchCall) SupportsAllDrives(supportsAllDrives bool) *FilesWatchCa } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesWatchCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesWatchCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -12768,9 +12887,9 @@ func (c *FilesWatchCall) Fields(s ...googleapi.Field) *FilesWatchCall { return c } -// Context sets the context to be used in this call's Do and Download -// methods. Any pending HTTP request will be aborted if the provided -// context is canceled. +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. func (c *FilesWatchCall) Context(ctx context.Context) *FilesWatchCall { c.ctx_ = ctx return c @@ -12813,22 +12932,6 @@ func (c *FilesWatchCall) doRequest(alt string) (*http.Response, error) { return gensupport.SendRequest(c.ctx_, c.s.client, req) } -// Download fetches the API endpoint's "media" value, instead of the normal -// API response value. If the returned error is nil, the Response is guaranteed to -// have a 2xx status code. Callers must close the Response.Body as usual. -func (c *FilesWatchCall) Download(opts ...googleapi.CallOption) (*http.Response, error) { - gensupport.SetOptions(c.urlParams_, opts...) - res, err := c.doRequest("media") - if err != nil { - return nil, err - } - if err := googleapi.CheckResponse(res); err != nil { - res.Body.Close() - return nil, gensupport.WrapError(err) - } - return res, nil -} - // Do executes the "drive.files.watch" call. // Exactly one of *Channel or error will be non-nil. Any non-2xx status // code is an error. Response headers are in either @@ -12867,7 +12970,8 @@ func (c *FilesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { } return ret, nil // { - // "description": "Subscribe to changes on a file.", + // "description": "Subscribes to changes to a file.", + // "flatPath": "files/{fileId}/watch", // "httpMethod": "POST", // "id": "drive.files.watch", // "parameterOrder": [ @@ -12887,24 +12991,24 @@ func (c *FilesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // "type": "string" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, // "includePermissionsForView": { - // "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + // "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", // "location": "query", // "type": "string" // }, // "projection": { - // "description": "This parameter is deprecated and has no function.", + // "description": "Deprecated: This parameter has no function.", // "enum": [ // "BASIC", // "FULL" // ], // "enumDescriptions": [ - // "Deprecated", - // "Deprecated" + // "Deprecated.", + // "Deprecated." // ], // "location": "query", // "type": "string" @@ -12922,7 +13026,7 @@ func (c *FilesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -12950,9 +13054,7 @@ func (c *FilesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // "https://www.googleapis.com/auth/drive.photos.readonly", // "https://www.googleapis.com/auth/drive.readonly" // ], - // "supportsMediaDownload": true, - // "supportsSubscription": true, - // "useMediaDownloadService": true + // "supportsSubscription": true // } } @@ -12980,9 +13082,9 @@ func (r *ParentsService) Delete(fileId string, parentId string) *ParentsDeleteCa } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": 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. +// "enforceSingleParent": Deprecated: If an item is not in a shared +// drive and its last parent is removed, the item is placed under its +// owner's root. func (c *ParentsDeleteCall) EnforceSingleParent(enforceSingleParent bool) *ParentsDeleteCall { c.urlParams_.Set("enforceSingleParent", fmt.Sprint(enforceSingleParent)) return c @@ -13051,6 +13153,7 @@ func (c *ParentsDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Removes a parent from a file.", + // "flatPath": "files/{fileId}/parents/{parentId}", // "httpMethod": "DELETE", // "id": "drive.parents.delete", // "parameterOrder": [ @@ -13060,7 +13163,7 @@ func (c *ParentsDeleteCall) Do(opts ...googleapi.CallOption) error { // "parameters": { // "enforceSingleParent": { // "default": "false", - // "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.", + // "description": "Deprecated: If an item is not in a shared drive and its last parent is removed, the item is placed under its owner's root.", // "location": "query", // "type": "boolean" // }, @@ -13210,6 +13313,7 @@ func (c *ParentsGetCall) Do(opts ...googleapi.CallOption) (*ParentReference, err return ret, nil // { // "description": "Gets a specific parent reference.", + // "flatPath": "files/{fileId}/parents/{parentId}", // "httpMethod": "GET", // "id": "drive.parents.get", // "parameterOrder": [ @@ -13269,8 +13373,8 @@ func (r *ParentsService) Insert(fileId string, parentreference *ParentReference) } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. Adding files to multiple folders -// is no longer supported. Use shortcuts instead. +// "enforceSingleParent": Deprecated: Adding files to multiple folders +// is no longer supported. Use `shortcuts` instead. func (c *ParentsInsertCall) EnforceSingleParent(enforceSingleParent bool) *ParentsInsertCall { c.urlParams_.Set("enforceSingleParent", fmt.Sprint(enforceSingleParent)) return c @@ -13285,7 +13389,7 @@ func (c *ParentsInsertCall) SupportsAllDrives(supportsAllDrives bool) *ParentsIn } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *ParentsInsertCall) SupportsTeamDrives(supportsTeamDrives bool) *ParentsInsertCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -13383,6 +13487,7 @@ func (c *ParentsInsertCall) Do(opts ...googleapi.CallOption) (*ParentReference, return ret, nil // { // "description": "Adds a parent folder for a file.", + // "flatPath": "files/{fileId}/parents", // "httpMethod": "POST", // "id": "drive.parents.insert", // "parameterOrder": [ @@ -13391,7 +13496,7 @@ func (c *ParentsInsertCall) Do(opts ...googleapi.CallOption) (*ParentReference, // "parameters": { // "enforceSingleParent": { // "default": "false", - // "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", + // "description": "Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead.", // "location": "query", // "type": "boolean" // }, @@ -13409,7 +13514,7 @@ func (c *ParentsInsertCall) Do(opts ...googleapi.CallOption) (*ParentReference, // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // } @@ -13550,6 +13655,7 @@ func (c *ParentsListCall) Do(opts ...googleapi.CallOption) (*ParentList, error) return ret, nil // { // "description": "Lists a file's parents.", + // "flatPath": "files/{fileId}/parents", // "httpMethod": "GET", // "id": "drive.parents.list", // "parameterOrder": [ @@ -13592,6 +13698,8 @@ type PermissionsDeleteCall struct { } // Delete: Deletes a permission from a file or shared drive. +// **Warning:** Concurrent permissions operations on the same file are +// not supported; only the last update is applied. // // - fileId: The ID for the file or shared drive. // - permissionId: The ID for the permission. @@ -13611,7 +13719,7 @@ func (c *PermissionsDeleteCall) SupportsAllDrives(supportsAllDrives bool) *Permi } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *PermissionsDeleteCall) SupportsTeamDrives(supportsTeamDrives bool) *PermissionsDeleteCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -13689,7 +13797,8 @@ func (c *PermissionsDeleteCall) Do(opts ...googleapi.CallOption) error { } return nil // { - // "description": "Deletes a permission from a file or shared drive.", + // "description": "Deletes a permission from a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + // "flatPath": "files/{fileId}/permissions/{permissionId}", // "httpMethod": "DELETE", // "id": "drive.permissions.delete", // "parameterOrder": [ @@ -13717,7 +13826,7 @@ func (c *PermissionsDeleteCall) Do(opts ...googleapi.CallOption) error { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -13769,7 +13878,7 @@ func (c *PermissionsGetCall) SupportsAllDrives(supportsAllDrives bool) *Permissi } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *PermissionsGetCall) SupportsTeamDrives(supportsTeamDrives bool) *PermissionsGetCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -13886,6 +13995,7 @@ func (c *PermissionsGetCall) Do(opts ...googleapi.CallOption) (*Permission, erro return ret, nil // { // "description": "Gets a permission by ID.", + // "flatPath": "files/{fileId}/permissions/{permissionId}", // "httpMethod": "GET", // "id": "drive.permissions.get", // "parameterOrder": [ @@ -13913,7 +14023,7 @@ func (c *PermissionsGetCall) Do(opts ...googleapi.CallOption) (*Permission, erro // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -14060,6 +14170,7 @@ func (c *PermissionsGetIdForEmailCall) Do(opts ...googleapi.CallOption) (*Permis return ret, nil // { // "description": "Returns the permission ID for an email address.", + // "flatPath": "permissionIds/{email}", // "httpMethod": "GET", // "id": "drive.permissions.getIdForEmail", // "parameterOrder": [ @@ -14102,7 +14213,9 @@ type PermissionsInsertCall struct { header_ http.Header } -// Insert: Inserts a permission for a file or shared drive. +// Insert: Inserts a permission for a file or shared drive. **Warning:** +// Concurrent permissions operations on the same file are not supported; +// only the last update is applied. // // - fileId: The ID for the file or shared drive. func (r *PermissionsService) Insert(fileId string, permission *Permission) *PermissionsInsertCall { @@ -14120,7 +14233,7 @@ func (c *PermissionsInsertCall) EmailMessage(emailMessage string) *PermissionsIn } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. See moveToNewOwnersRoot for +// "enforceSingleParent": Deprecated: See `moveToNewOwnersRoot` for // details. func (c *PermissionsInsertCall) EnforceSingleParent(enforceSingleParent bool) *PermissionsInsertCall { c.urlParams_.Set("enforceSingleParent", fmt.Sprint(enforceSingleParent)) @@ -14130,9 +14243,9 @@ func (c *PermissionsInsertCall) EnforceSingleParent(enforceSingleParent bool) *P // MoveToNewOwnersRoot sets the optional parameter // "moveToNewOwnersRoot": 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. +// 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. func (c *PermissionsInsertCall) MoveToNewOwnersRoot(moveToNewOwnersRoot bool) *PermissionsInsertCall { c.urlParams_.Set("moveToNewOwnersRoot", fmt.Sprint(moveToNewOwnersRoot)) return c @@ -14141,7 +14254,7 @@ func (c *PermissionsInsertCall) MoveToNewOwnersRoot(moveToNewOwnersRoot bool) *P // SendNotificationEmails sets the optional parameter // "sendNotificationEmails": Whether to send notification emails when // sharing to users or groups. This parameter is ignored and an email is -// sent if the role is owner. +// sent if the `role` is `owner`. func (c *PermissionsInsertCall) SendNotificationEmails(sendNotificationEmails bool) *PermissionsInsertCall { c.urlParams_.Set("sendNotificationEmails", fmt.Sprint(sendNotificationEmails)) return c @@ -14156,7 +14269,7 @@ func (c *PermissionsInsertCall) SupportsAllDrives(supportsAllDrives bool) *Permi } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *PermissionsInsertCall) SupportsTeamDrives(supportsTeamDrives bool) *PermissionsInsertCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -14263,7 +14376,8 @@ func (c *PermissionsInsertCall) Do(opts ...googleapi.CallOption) (*Permission, e } return ret, nil // { - // "description": "Inserts a permission for a file or shared drive.", + // "description": "Inserts a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + // "flatPath": "files/{fileId}/permissions", // "httpMethod": "POST", // "id": "drive.permissions.insert", // "parameterOrder": [ @@ -14277,7 +14391,7 @@ func (c *PermissionsInsertCall) Do(opts ...googleapi.CallOption) (*Permission, e // }, // "enforceSingleParent": { // "default": "false", - // "description": "Deprecated. See moveToNewOwnersRoot for details.", + // "description": "Deprecated: See `moveToNewOwnersRoot` for details.", // "location": "query", // "type": "boolean" // }, @@ -14289,13 +14403,13 @@ func (c *PermissionsInsertCall) Do(opts ...googleapi.CallOption) (*Permission, e // }, // "moveToNewOwnersRoot": { // "default": "false", - // "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.", + // "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" // }, // "sendNotificationEmails": { // "default": "true", - // "description": "Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner.", + // "description": "Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the `role` is `owner`.", // "location": "query", // "type": "boolean" // }, @@ -14307,7 +14421,7 @@ func (c *PermissionsInsertCall) Do(opts ...googleapi.CallOption) (*Permission, e // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -14355,7 +14469,7 @@ func (r *PermissionsService) List(fileId string) *PermissionsListCall { // IncludePermissionsForView sets the optional parameter // "includePermissionsForView": Specifies which additional view's -// permissions to include in the response. Only 'published' is +// permissions to include in the response. Only `published` is // supported. func (c *PermissionsListCall) IncludePermissionsForView(includePermissionsForView string) *PermissionsListCall { c.urlParams_.Set("includePermissionsForView", includePermissionsForView) @@ -14374,7 +14488,7 @@ func (c *PermissionsListCall) MaxResults(maxResults int64) *PermissionsListCall // PageToken sets the optional parameter "pageToken": The token for // continuing a previous list request on the next page. This should be -// set to the value of 'nextPageToken' from the previous response. +// set to the value of `nextPageToken` from the previous response. func (c *PermissionsListCall) PageToken(pageToken string) *PermissionsListCall { c.urlParams_.Set("pageToken", pageToken) return c @@ -14389,7 +14503,7 @@ func (c *PermissionsListCall) SupportsAllDrives(supportsAllDrives bool) *Permiss } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *PermissionsListCall) SupportsTeamDrives(supportsTeamDrives bool) *PermissionsListCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -14505,6 +14619,7 @@ func (c *PermissionsListCall) Do(opts ...googleapi.CallOption) (*PermissionList, return ret, nil // { // "description": "Lists a file's or shared drive's permissions.", + // "flatPath": "files/{fileId}/permissions", // "httpMethod": "GET", // "id": "drive.permissions.list", // "parameterOrder": [ @@ -14518,7 +14633,7 @@ func (c *PermissionsListCall) Do(opts ...googleapi.CallOption) (*PermissionList, // "type": "string" // }, // "includePermissionsForView": { - // "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", + // "description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", // "location": "query", // "type": "string" // }, @@ -14531,7 +14646,7 @@ func (c *PermissionsListCall) Do(opts ...googleapi.CallOption) (*PermissionList, // "type": "integer" // }, // "pageToken": { - // "description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.", + // "description": "The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.", // "location": "query", // "type": "string" // }, @@ -14543,7 +14658,7 @@ func (c *PermissionsListCall) Do(opts ...googleapi.CallOption) (*PermissionList, // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -14603,7 +14718,9 @@ type PermissionsPatchCall struct { header_ http.Header } -// Patch: Updates a permission using patch semantics. +// Patch: Updates a permission using patch semantics. **Warning:** +// Concurrent permissions operations on the same file are not supported; +// only the last update is applied. // // - fileId: The ID for the file or shared drive. // - permissionId: The ID for the permission. @@ -14631,15 +14748,15 @@ func (c *PermissionsPatchCall) SupportsAllDrives(supportsAllDrives bool) *Permis } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *PermissionsPatchCall) SupportsTeamDrives(supportsTeamDrives bool) *PermissionsPatchCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c } // TransferOwnership sets the optional parameter "transferOwnership": -// Whether changing a role to 'owner' downgrades the current owners to -// writers. Does nothing if the specified role is not 'owner'. +// Whether changing a role to `owner` downgrades the current owners to +// writers. Does nothing if the specified role is not `owner`. func (c *PermissionsPatchCall) TransferOwnership(transferOwnership bool) *PermissionsPatchCall { c.urlParams_.Set("transferOwnership", fmt.Sprint(transferOwnership)) return c @@ -14747,7 +14864,8 @@ func (c *PermissionsPatchCall) Do(opts ...googleapi.CallOption) (*Permission, er } return ret, nil // { - // "description": "Updates a permission using patch semantics.", + // "description": "Updates a permission using patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + // "flatPath": "files/{fileId}/permissions/{permissionId}", // "httpMethod": "PATCH", // "id": "drive.permissions.patch", // "parameterOrder": [ @@ -14781,13 +14899,13 @@ func (c *PermissionsPatchCall) Do(opts ...googleapi.CallOption) (*Permission, er // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "transferOwnership": { // "default": "false", - // "description": "Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.", + // "description": "Whether changing a role to `owner` downgrades the current owners to writers. Does nothing if the specified role is not `owner`.", // "location": "query", // "type": "boolean" // }, @@ -14825,7 +14943,9 @@ type PermissionsUpdateCall struct { header_ http.Header } -// Update: Updates a permission. +// Update: Updates a permission. **Warning:** Concurrent permissions +// operations on the same file are not supported; only the last update +// is applied. // // - fileId: The ID for the file or shared drive. // - permissionId: The ID for the permission. @@ -14853,21 +14973,15 @@ func (c *PermissionsUpdateCall) SupportsAllDrives(supportsAllDrives bool) *Permi } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *PermissionsUpdateCall) SupportsTeamDrives(supportsTeamDrives bool) *PermissionsUpdateCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c } // TransferOwnership sets the optional parameter "transferOwnership": -// Whether to transfer ownership to the specified user and downgrade the -// current owner to a writer. This parameter is required as an -// acknowledgement of the side effect. File owners can only transfer -// ownership of files existing on My Drive. Files existing in a shared -// drive are owned by the organization that owns that shared drive. -// Ownership transfers are not supported for files and folders in shared -// drives. Organizers of a shared drive can move items from that shared -// drive into their My Drive which transfers the ownership to them. +// Whether changing a role to `owner` downgrades the current owners to +// writers. Does nothing if the specified role is not `owner`. func (c *PermissionsUpdateCall) TransferOwnership(transferOwnership bool) *PermissionsUpdateCall { c.urlParams_.Set("transferOwnership", fmt.Sprint(transferOwnership)) return c @@ -14975,7 +15089,8 @@ func (c *PermissionsUpdateCall) Do(opts ...googleapi.CallOption) (*Permission, e } return ret, nil // { - // "description": "Updates a permission.", + // "description": "Updates a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + // "flatPath": "files/{fileId}/permissions/{permissionId}", // "httpMethod": "PUT", // "id": "drive.permissions.update", // "parameterOrder": [ @@ -15009,13 +15124,13 @@ func (c *PermissionsUpdateCall) Do(opts ...googleapi.CallOption) (*Permission, e // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "transferOwnership": { // "default": "false", - // "description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them.", + // "description": "Whether changing a role to `owner` downgrades the current owners to writers. Does nothing if the specified role is not `owner`.", // "location": "query", // "type": "boolean" // }, @@ -15133,6 +15248,7 @@ func (c *PropertiesDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Deletes a property.", + // "flatPath": "files/{fileId}/properties/{propertyKey}", // "httpMethod": "DELETE", // "id": "drive.properties.delete", // "parameterOrder": [ @@ -15301,6 +15417,7 @@ func (c *PropertiesGetCall) Do(opts ...googleapi.CallOption) (*Property, error) return ret, nil // { // "description": "Gets a property by its key.", + // "flatPath": "files/{fileId}/properties/{propertyKey}", // "httpMethod": "GET", // "id": "drive.properties.get", // "parameterOrder": [ @@ -15458,6 +15575,7 @@ func (c *PropertiesInsertCall) Do(opts ...googleapi.CallOption) (*Property, erro return ret, nil // { // "description": "Adds a property to a file, or updates it if it already exists.", + // "flatPath": "files/{fileId}/properties", // "httpMethod": "POST", // "id": "drive.properties.insert", // "parameterOrder": [ @@ -15608,6 +15726,7 @@ func (c *PropertiesListCall) Do(opts ...googleapi.CallOption) (*PropertyList, er return ret, nil // { // "description": "Lists a file's properties.", + // "flatPath": "files/{fileId}/properties", // "httpMethod": "GET", // "id": "drive.properties.list", // "parameterOrder": [ @@ -15763,6 +15882,7 @@ func (c *PropertiesPatchCall) Do(opts ...googleapi.CallOption) (*Property, error return ret, nil // { // "description": "Updates a property.", + // "flatPath": "files/{fileId}/properties/{propertyKey}", // "httpMethod": "PATCH", // "id": "drive.properties.patch", // "parameterOrder": [ @@ -15931,6 +16051,7 @@ func (c *PropertiesUpdateCall) Do(opts ...googleapi.CallOption) (*Property, erro return ret, nil // { // "description": "Updates a property.", + // "flatPath": "files/{fileId}/properties/{propertyKey}", // "httpMethod": "PUT", // "id": "drive.properties.update", // "parameterOrder": [ @@ -16063,6 +16184,7 @@ func (c *RepliesDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Deletes a reply.", + // "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", // "httpMethod": "DELETE", // "id": "drive.replies.delete", // "parameterOrder": [ @@ -16234,6 +16356,7 @@ func (c *RepliesGetCall) Do(opts ...googleapi.CallOption) (*CommentReply, error) return ret, nil // { // "description": "Gets a reply.", + // "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", // "httpMethod": "GET", // "id": "drive.replies.get", // "parameterOrder": [ @@ -16397,6 +16520,7 @@ func (c *RepliesInsertCall) Do(opts ...googleapi.CallOption) (*CommentReply, err return ret, nil // { // "description": "Creates a new reply to the given comment.", + // "flatPath": "files/{fileId}/comments/{commentId}/replies", // "httpMethod": "POST", // "id": "drive.replies.insert", // "parameterOrder": [ @@ -16580,6 +16704,7 @@ func (c *RepliesListCall) Do(opts ...googleapi.CallOption) (*CommentReplyList, e return ret, nil // { // "description": "Lists all of the replies to a comment.", + // "flatPath": "files/{fileId}/comments/{commentId}/replies", // "httpMethod": "GET", // "id": "drive.replies.list", // "parameterOrder": [ @@ -16775,6 +16900,7 @@ func (c *RepliesPatchCall) Do(opts ...googleapi.CallOption) (*CommentReply, erro return ret, nil // { // "description": "Updates an existing reply.", + // "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", // "httpMethod": "PATCH", // "id": "drive.replies.patch", // "parameterOrder": [ @@ -16938,6 +17064,7 @@ func (c *RepliesUpdateCall) Do(opts ...googleapi.CallOption) (*CommentReply, err return ret, nil // { // "description": "Updates an existing reply.", + // "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", // "httpMethod": "PUT", // "id": "drive.replies.update", // "parameterOrder": [ @@ -17068,6 +17195,7 @@ func (c *RevisionsDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Permanently deletes a file version. You can only delete revisions for files with binary content, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.", + // "flatPath": "files/{fileId}/revisions/{revisionId}", // "httpMethod": "DELETE", // "id": "drive.revisions.delete", // "parameterOrder": [ @@ -17222,6 +17350,7 @@ func (c *RevisionsGetCall) Do(opts ...googleapi.CallOption) (*Revision, error) { return ret, nil // { // "description": "Gets a specific revision.", + // "flatPath": "files/{fileId}/revisions/{revisionId}", // "httpMethod": "GET", // "id": "drive.revisions.get", // "parameterOrder": [ @@ -17394,6 +17523,7 @@ func (c *RevisionsListCall) Do(opts ...googleapi.CallOption) (*RevisionList, err return ret, nil // { // "description": "Lists a file's revisions.", + // "flatPath": "files/{fileId}/revisions", // "httpMethod": "GET", // "id": "drive.revisions.list", // "parameterOrder": [ @@ -17576,6 +17706,7 @@ func (c *RevisionsPatchCall) Do(opts ...googleapi.CallOption) (*Revision, error) return ret, nil // { // "description": "Updates a revision.", + // "flatPath": "files/{fileId}/revisions/{revisionId}", // "httpMethod": "PATCH", // "id": "drive.revisions.patch", // "parameterOrder": [ @@ -17729,6 +17860,7 @@ func (c *RevisionsUpdateCall) Do(opts ...googleapi.CallOption) (*Revision, error return ret, nil // { // "description": "Updates a revision.", + // "flatPath": "files/{fileId}/revisions/{revisionId}", // "httpMethod": "PUT", // "id": "drive.revisions.update", // "parameterOrder": [ @@ -17775,7 +17907,7 @@ type TeamdrivesDeleteCall struct { header_ http.Header } -// Delete: Deprecated use drives.delete instead. +// Delete: Deprecated: Use `drives.delete` instead. // // - teamDriveId: The ID of the Team Drive. func (r *TeamdrivesService) Delete(teamDriveId string) *TeamdrivesDeleteCall { @@ -17845,7 +17977,8 @@ func (c *TeamdrivesDeleteCall) Do(opts ...googleapi.CallOption) error { } return nil // { - // "description": "Deprecated use drives.delete instead.", + // "description": "Deprecated: Use `drives.delete` instead.", + // "flatPath": "teamdrives/{teamDriveId}", // "httpMethod": "DELETE", // "id": "drive.teamdrives.delete", // "parameterOrder": [ @@ -17878,7 +18011,7 @@ type TeamdrivesGetCall struct { header_ http.Header } -// Get: Deprecated use drives.get instead. +// Get: Deprecated: Use `drives.get` instead. // // - teamDriveId: The ID of the Team Drive. func (r *TeamdrivesService) Get(teamDriveId string) *TeamdrivesGetCall { @@ -17995,7 +18128,8 @@ func (c *TeamdrivesGetCall) Do(opts ...googleapi.CallOption) (*TeamDrive, error) } return ret, nil // { - // "description": "Deprecated use drives.get instead.", + // "description": "Deprecated: Use `drives.get` instead.", + // "flatPath": "teamdrives/{teamDriveId}", // "httpMethod": "GET", // "id": "drive.teamdrives.get", // "parameterOrder": [ @@ -18037,7 +18171,7 @@ type TeamdrivesInsertCall struct { header_ http.Header } -// Insert: Deprecated use drives.insert instead. +// Insert: Deprecated: Use `drives.insert` instead. // // - requestId: An ID, such as a random UUID, which uniquely identifies // this user's request for idempotent creation of a Team Drive. A @@ -18140,7 +18274,8 @@ func (c *TeamdrivesInsertCall) Do(opts ...googleapi.CallOption) (*TeamDrive, err } return ret, nil // { - // "description": "Deprecated use drives.insert instead.", + // "description": "Deprecated: Use `drives.insert` instead.", + // "flatPath": "teamdrives", // "httpMethod": "POST", // "id": "drive.teamdrives.insert", // "parameterOrder": [ @@ -18148,7 +18283,7 @@ func (c *TeamdrivesInsertCall) Do(opts ...googleapi.CallOption) (*TeamDrive, err // ], // "parameters": { // "requestId": { - // "description": "An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.", + // "description": "Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.", // "location": "query", // "required": true, // "type": "string" @@ -18178,7 +18313,7 @@ type TeamdrivesListCall struct { header_ http.Header } -// List: Deprecated use drives.list instead. +// List: Deprecated: Use `drives.list` instead. func (r *TeamdrivesService) List() *TeamdrivesListCall { c := &TeamdrivesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} return c @@ -18310,9 +18445,11 @@ func (c *TeamdrivesListCall) Do(opts ...googleapi.CallOption) (*TeamDriveList, e } return ret, nil // { - // "description": "Deprecated use drives.list instead.", + // "description": "Deprecated: Use `drives.list` instead.", + // "flatPath": "teamdrives", // "httpMethod": "GET", // "id": "drive.teamdrives.list", + // "parameterOrder": [], // "parameters": { // "maxResults": { // "default": "10", @@ -18384,7 +18521,7 @@ type TeamdrivesUpdateCall struct { header_ http.Header } -// Update: Deprecated use drives.update instead. +// Update: Deprecated: Use `drives.update` instead. // // - teamDriveId: The ID of the Team Drive. func (r *TeamdrivesService) Update(teamDriveId string, teamdrive *TeamDrive) *TeamdrivesUpdateCall { @@ -18494,7 +18631,8 @@ func (c *TeamdrivesUpdateCall) Do(opts ...googleapi.CallOption) (*TeamDrive, err } return ret, nil // { - // "description": "Deprecated use drives.update instead.", + // "description": "Deprecated: Use `drives.update` instead.", + // "flatPath": "teamdrives/{teamDriveId}", // "httpMethod": "PUT", // "id": "drive.teamdrives.update", // "parameterOrder": [ diff --git a/drive/v3/drive-api.json b/drive/v3/drive-api.json index 8b36adef0b6..8099bfe7e82 100644 --- a/drive/v3/drive-api.json +++ b/drive/v3/drive-api.json @@ -32,32 +32,59 @@ "basePath": "/drive/v3/", "baseUrl": "https://www.googleapis.com/drive/v3/", "batchPath": "batch/drive/v3", - "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", + "description": "The Google Drive API allows clients to access resources from Google Drive.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/drive/", - "etag": "\"VYc8DWo_6wRTElVugbtvWfkARsc/Rbg-qVi5IMtZXkfgFBOCN9uNluk\"", "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" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "id": "drive:v3", "kind": "discovery#restDescription", + "mtlsRootUrl": "https://www.mtls.googleapis.com/", "name": "drive", "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 the response.", + "description": "Data format for response.", "enum": [ - "json" + "json", + "media", + "proto" ], "enumDescriptions": [ - "Responses with Content-Type of application/json" + "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", @@ -80,12 +107,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" } @@ -96,8 +128,11 @@ "methods": { "get": { "description": "Gets information about the user, the user's Drive, and system capabilities.", + "flatPath": "about", "httpMethod": "GET", "id": "drive.about.get", + "parameterOrder": [], + "parameters": {}, "path": "about", "response": { "$ref": "About" @@ -118,11 +153,13 @@ "methods": { "getStartPageToken": { "description": "Gets the starting pageToken for listing future changes.", + "flatPath": "changes/startPageToken", "httpMethod": "GET", "id": "drive.changes.getStartPageToken", + "parameterOrder": [], "parameters": { "driveId": { - "description": "The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned.", + "description": "The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.", "location": "query", "type": "string" }, @@ -134,12 +171,12 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "teamDriveId": { - "description": "Deprecated use driveId instead.", + "description": "Deprecated: Use `driveId` instead.", "location": "query", "type": "string" } @@ -160,6 +197,7 @@ }, "list": { "description": "Lists the changes for a user or shared drive.", + "flatPath": "changes", "httpMethod": "GET", "id": "drive.changes.list", "parameterOrder": [ @@ -167,7 +205,7 @@ ], "parameters": { "driveId": { - "description": "The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", + "description": "The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", "location": "query", "type": "string" }, @@ -184,7 +222,7 @@ "type": "boolean" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, @@ -201,7 +239,7 @@ }, "includeTeamDriveItems": { "default": "false", - "description": "Deprecated use includeItemsFromAllDrives instead.", + "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -240,12 +278,12 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "teamDriveId": { - "description": "Deprecated use driveId instead.", + "description": "Deprecated: Use `driveId` instead.", "location": "query", "type": "string" } @@ -266,7 +304,8 @@ "supportsSubscription": true }, "watch": { - "description": "Subscribes to changes for a user. To use this method, you must include the pageToken query parameter.", + "description": "Subscribes to changes for a user.", + "flatPath": "changes/watch", "httpMethod": "POST", "id": "drive.changes.watch", "parameterOrder": [ @@ -274,7 +313,7 @@ ], "parameters": { "driveId": { - "description": "The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", + "description": "The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", "location": "query", "type": "string" }, @@ -291,7 +330,7 @@ "type": "boolean" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, @@ -308,7 +347,7 @@ }, "includeTeamDriveItems": { "default": "false", - "description": "Deprecated use includeItemsFromAllDrives instead.", + "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -347,12 +386,12 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "teamDriveId": { - "description": "Deprecated use driveId instead.", + "description": "Deprecated: Use `driveId` instead.", "location": "query", "type": "string" } @@ -381,9 +420,12 @@ "channels": { "methods": { "stop": { - "description": "Stop watching resources through this channel", + "description": "Stops watching resources through this channel.", + "flatPath": "channels/stop", "httpMethod": "POST", "id": "drive.channels.stop", + "parameterOrder": [], + "parameters": {}, "path": "channels/stop", "request": { "$ref": "Channel", @@ -405,6 +447,7 @@ "methods": { "create": { "description": "Creates a comment on a file.", + "flatPath": "files/{fileId}/comments", "httpMethod": "POST", "id": "drive.comments.create", "parameterOrder": [ @@ -432,6 +475,7 @@ }, "delete": { "description": "Deletes a comment.", + "flatPath": "files/{fileId}/comments/{commentId}", "httpMethod": "DELETE", "id": "drive.comments.delete", "parameterOrder": [ @@ -460,6 +504,7 @@ }, "get": { "description": "Gets a comment by ID.", + "flatPath": "files/{fileId}/comments/{commentId}", "httpMethod": "GET", "id": "drive.comments.get", "parameterOrder": [ @@ -498,6 +543,7 @@ }, "list": { "description": "Lists a file's comments.", + "flatPath": "files/{fileId}/comments", "httpMethod": "GET", "id": "drive.comments.list", "parameterOrder": [ @@ -548,6 +594,7 @@ }, "update": { "description": "Updates a comment with patch semantics.", + "flatPath": "files/{fileId}/comments/{commentId}", "httpMethod": "PATCH", "id": "drive.comments.update", "parameterOrder": [ @@ -586,6 +633,7 @@ "methods": { "create": { "description": "Creates a shared drive.", + "flatPath": "drives", "httpMethod": "POST", "id": "drive.drives.create", "parameterOrder": [ @@ -593,7 +641,7 @@ ], "parameters": { "requestId": { - "description": "An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.", + "description": "Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.", "location": "query", "required": true, "type": "string" @@ -612,6 +660,7 @@ }, "delete": { "description": "Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.", + "flatPath": "drives/{driveId}", "httpMethod": "DELETE", "id": "drive.drives.delete", "parameterOrder": [ @@ -620,7 +669,7 @@ "parameters": { "allowItemDeletion": { "default": "false", - "description": "Whether any items inside the shared drive should also be deleted. This option is only supported when useDomainAdminAccess is also set to true.", + "description": "Whether any items inside the shared drive should also be deleted. This option is only supported when `useDomainAdminAccess` is also set to `true`.", "location": "query", "type": "boolean" }, @@ -644,6 +693,7 @@ }, "get": { "description": "Gets a shared drive's metadata by ID.", + "flatPath": "drives/{driveId}", "httpMethod": "GET", "id": "drive.drives.get", "parameterOrder": [ @@ -674,6 +724,7 @@ }, "hide": { "description": "Hides a shared drive from the default view.", + "flatPath": "drives/{driveId}/hide", "httpMethod": "POST", "id": "drive.drives.hide", "parameterOrder": [ @@ -696,9 +747,11 @@ ] }, "list": { - "description": "Lists the user's shared drives.", + "description": " Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/drive/api/guides/search-shareddrives) guide.", + "flatPath": "drives", "httpMethod": "GET", "id": "drive.drives.list", + "parameterOrder": [], "parameters": { "pageSize": { "default": "10", @@ -737,6 +790,7 @@ }, "unhide": { "description": "Restores a shared drive to the default view.", + "flatPath": "drives/{driveId}/unhide", "httpMethod": "POST", "id": "drive.drives.unhide", "parameterOrder": [ @@ -759,7 +813,8 @@ ] }, "update": { - "description": "Updates the metadata for a shared drive.", + "description": "Updates the metadate for a shared drive.", + "flatPath": "drives/{driveId}", "httpMethod": "PATCH", "id": "drive.drives.update", "parameterOrder": [ @@ -774,7 +829,7 @@ }, "useDomainAdminAccess": { "default": "false", - "description": "Issue the request as a domain administrator. If set to true, then the requester is granted access if they're an administrator of the domain to which the shared drive belongs.", + "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.", "location": "query", "type": "boolean" } @@ -795,7 +850,8 @@ "files": { "methods": { "copy": { - "description": "Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.", + "description": "Creates a copy of a file and applies any requested updates with patch semantics.", + "flatPath": "files/{fileId}/copy", "httpMethod": "POST", "id": "drive.files.copy", "parameterOrder": [ @@ -821,7 +877,7 @@ "type": "boolean" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, @@ -849,7 +905,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" } @@ -869,14 +925,15 @@ ] }, "create": { - "description": "Creates a file.", + "description": " Creates a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"name\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.", + "flatPath": "files", "httpMethod": "POST", "id": "drive.files.create", "mediaUpload": { "accept": [ "*/*" ], - "maxSize": "5120GB", + "maxSize": "5497558138880", "protocols": { "resumable": { "multipart": true, @@ -888,6 +945,7 @@ } } }, + "parameterOrder": [], "parameters": { "enforceSingleParent": { "default": "false", @@ -902,7 +960,7 @@ "type": "boolean" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, @@ -930,7 +988,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -953,11 +1011,11 @@ "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file" ], - "supportsMediaUpload": true, - "supportsSubscription": true + "supportsMediaUpload": true }, "delete": { "description": "Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted.", + "flatPath": "files/{fileId}", "httpMethod": "DELETE", "id": "drive.files.delete", "parameterOrder": [ @@ -966,7 +1024,7 @@ "parameters": { "enforceSingleParent": { "default": "false", - "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.", + "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" }, @@ -984,7 +1042,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" } @@ -997,9 +1055,11 @@ ] }, "emptyTrash": { - "description": "Permanently deletes all trashed files of a user or shared drive.", + "description": "Permanently deletes all of the user's trashed files.", + "flatPath": "files/trash", "httpMethod": "DELETE", "id": "drive.files.emptyTrash", + "parameterOrder": [], "parameters": { "driveId": { "description": "If set, empties the trash of the provided shared drive.", @@ -1008,7 +1068,7 @@ }, "enforceSingleParent": { "default": "false", - "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.", + "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" } @@ -1020,6 +1080,7 @@ }, "export": { "description": "Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.", + "flatPath": "files/{fileId}/export", "httpMethod": "GET", "id": "drive.files.export", "parameterOrder": [ @@ -1034,7 +1095,7 @@ "type": "string" }, "mimeType": { - "description": "The MIME type of the format requested for this export.", + "description": "Required. The MIME type of the format requested for this export.", "location": "query", "required": true, "type": "string" @@ -1046,12 +1107,15 @@ "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.readonly" ], - "supportsMediaDownload": true + "supportsMediaDownload": true, + "useMediaDownloadService": true }, "generateIds": { "description": "Generates a set of file IDs which can be provided in create or copy requests.", + "flatPath": "files/generateIds", "httpMethod": "GET", "id": "drive.files.generateIds", + "parameterOrder": [], "parameters": { "count": { "default": "10", @@ -1070,7 +1134,7 @@ }, "type": { "default": "files", - "description": "The type of items which the IDs can be used for. Supported values are 'files' and 'shortcuts'. Note that 'shortcuts' are only supported in the drive 'space'. (Default: 'files')", + "description": "The type of items which the IDs can be used for. Supported values are 'files' and 'shortcuts'. Note that 'shortcuts' are only supported in the `drive` 'space'. (Default: 'files')", "location": "query", "type": "string" } @@ -1086,7 +1150,8 @@ ] }, "get": { - "description": "Gets a file's metadata or content by ID.", + "description": " Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download \u0026 export files](/drive/api/guides/manage-downloads).", + "flatPath": "files/{fileId}", "httpMethod": "GET", "id": "drive.files.get", "parameterOrder": [ @@ -1106,7 +1171,7 @@ "type": "string" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, @@ -1123,7 +1188,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" } @@ -1146,24 +1211,26 @@ "useMediaDownloadService": true }, "list": { - "description": "Lists or searches files.", + "description": " Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files \u0026 folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", + "flatPath": "files", "httpMethod": "GET", "id": "drive.files.list", + "parameterOrder": [], "parameters": { "corpora": { - "description": "Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency.", + "description": "Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive', and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency. By default, corpora is set to 'user'. However, this can change depending on the filter set through the 'q' parameter.", "location": "query", "type": "string" }, "corpus": { - "description": "The source of files to list. Deprecated: use 'corpora' instead.", + "description": "Deprecated: The source of files to list. Use 'corpora' instead.", "enum": [ "domain", "user" ], "enumDescriptions": [ "Files shared to the user's domain.", - "Files owned by or shared to the user. If a user has permissions on a Shared Drive, the files inside it won't be retrieved unless the user has created, opened, or shared the file." + "Files owned by or shared to the user." ], "location": "query", "type": "string" @@ -1180,7 +1247,7 @@ "type": "boolean" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, @@ -1191,12 +1258,12 @@ }, "includeTeamDriveItems": { "default": "false", - "description": "Deprecated use includeItemsFromAllDrives instead.", + "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", "location": "query", "type": "boolean" }, "orderBy": { - "description": "A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.", + "description": "A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name.", "location": "query", "type": "string" }, @@ -1215,7 +1282,7 @@ "type": "string" }, "q": { - "description": "A query for filtering the file results. See the \"Search for Files\" guide for supported syntax.", + "description": "A query for filtering the file results. See the \"Search for files \u0026 folders\" guide for supported syntax.", "location": "query", "type": "string" }, @@ -1233,12 +1300,12 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "teamDriveId": { - "description": "Deprecated use driveId instead.", + "description": "Deprecated: Use `driveId` instead.", "location": "query", "type": "string" } @@ -1259,6 +1326,7 @@ }, "listLabels": { "description": "Lists the labels on a file.", + "flatPath": "files/{fileId}/listLabels", "httpMethod": "GET", "id": "drive.files.listLabels", "parameterOrder": [ @@ -1266,14 +1334,14 @@ ], "parameters": { "fileId": { - "description": "The ID of the file.", + "description": "The ID for the file or shared drive.", "location": "path", "required": true, "type": "string" }, "maxResults": { "default": "100", - "description": "The maximum number of labels to return per page. When not set, this defaults to 100.", + "description": "The maximum number of labels to return per page. When not set, defaults to 100.", "format": "int32", "location": "query", "maximum": "100", @@ -1299,7 +1367,8 @@ ] }, "modifyLabels": { - "description": "Modifies the set of labels on a file.", + "description": "Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.", + "flatPath": "files/{fileId}/modifyLabels", "httpMethod": "POST", "id": "drive.files.modifyLabels", "parameterOrder": [ @@ -1307,7 +1376,7 @@ ], "parameters": { "fileId": { - "description": "The ID of the file for which the labels are modified.", + "description": "The ID of the file to which the labels belong.", "location": "path", "required": true, "type": "string" @@ -1327,14 +1396,15 @@ ] }, "update": { - "description": "Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.", + "description": " Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads).", + "flatPath": "files/{fileId}", "httpMethod": "PATCH", "id": "drive.files.update", "mediaUpload": { "accept": [ "*/*" ], - "maxSize": "5120GB", + "maxSize": "5497558138880", "protocols": { "resumable": { "multipart": true, @@ -1357,7 +1427,7 @@ }, "enforceSingleParent": { "default": "false", - "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", + "description": "Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.", "location": "query", "type": "boolean" }, @@ -1368,7 +1438,7 @@ "type": "string" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, @@ -1401,7 +1471,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -1429,7 +1499,8 @@ "supportsMediaUpload": true }, "watch": { - "description": "Subscribe to changes on a file.", + "description": "Subscribes to changes to a file.", + "flatPath": "files/{fileId}/watch", "httpMethod": "POST", "id": "drive.files.watch", "parameterOrder": [ @@ -1449,7 +1520,7 @@ "type": "string" }, "includeLabels": { - "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", "location": "query", "type": "string" }, @@ -1466,7 +1537,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" } @@ -1488,16 +1559,15 @@ "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly" ], - "supportsMediaDownload": true, - "supportsSubscription": true, - "useMediaDownloadService": true + "supportsSubscription": true } } }, "permissions": { "methods": { "create": { - "description": "Creates a permission for a file or shared drive. For more information on creating permissions, see Share files, folders \u0026 drives.", + "description": "Creates a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + "flatPath": "files/{fileId}/permissions", "httpMethod": "POST", "id": "drive.permissions.create", "parameterOrder": [ @@ -1511,7 +1581,7 @@ }, "enforceSingleParent": { "default": "false", - "description": "Deprecated. See moveToNewOwnersRoot for details.", + "description": "Deprecated: See `moveToNewOwnersRoot` for details.", "location": "query", "type": "boolean" }, @@ -1523,7 +1593,7 @@ }, "moveToNewOwnersRoot": { "default": "false", - "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.", + "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" }, @@ -1540,13 +1610,13 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "transferOwnership": { "default": "false", - "description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them.", + "description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.", "location": "query", "type": "boolean" }, @@ -1570,7 +1640,8 @@ ] }, "delete": { - "description": "Deletes a permission.", + "description": "Deletes a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + "flatPath": "files/{fileId}/permissions/{permissionId}", "httpMethod": "DELETE", "id": "drive.permissions.delete", "parameterOrder": [ @@ -1598,7 +1669,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -1617,6 +1688,7 @@ }, "get": { "description": "Gets a permission by ID.", + "flatPath": "files/{fileId}/permissions/{permissionId}", "httpMethod": "GET", "id": "drive.permissions.get", "parameterOrder": [ @@ -1644,7 +1716,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -1670,6 +1742,7 @@ }, "list": { "description": "Lists a file's or shared drive's permissions.", + "flatPath": "files/{fileId}/permissions", "httpMethod": "GET", "id": "drive.permissions.list", "parameterOrder": [ @@ -1708,7 +1781,7 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, @@ -1733,7 +1806,8 @@ ] }, "update": { - "description": "Updates a permission with patch semantics.", + "description": "Updates a permission with patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + "flatPath": "files/{fileId}/permissions/{permissionId}", "httpMethod": "PATCH", "id": "drive.permissions.update", "parameterOrder": [ @@ -1767,13 +1841,13 @@ }, "supportsTeamDrives": { "default": "false", - "description": "Deprecated use supportsAllDrives instead.", + "description": "Deprecated: Use `supportsAllDrives` instead.", "location": "query", "type": "boolean" }, "transferOwnership": { "default": "false", - "description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them.", + "description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.", "location": "query", "type": "boolean" }, @@ -1802,6 +1876,7 @@ "methods": { "create": { "description": "Creates a reply to a comment.", + "flatPath": "files/{fileId}/comments/{commentId}/replies", "httpMethod": "POST", "id": "drive.replies.create", "parameterOrder": [ @@ -1836,6 +1911,7 @@ }, "delete": { "description": "Deletes a reply.", + "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", "httpMethod": "DELETE", "id": "drive.replies.delete", "parameterOrder": [ @@ -1871,6 +1947,7 @@ }, "get": { "description": "Gets a reply by ID.", + "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", "httpMethod": "GET", "id": "drive.replies.get", "parameterOrder": [ @@ -1916,6 +1993,7 @@ }, "list": { "description": "Lists a comment's replies.", + "flatPath": "files/{fileId}/comments/{commentId}/replies", "httpMethod": "GET", "id": "drive.replies.list", "parameterOrder": [ @@ -1968,6 +2046,7 @@ }, "update": { "description": "Updates a reply with patch semantics.", + "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", "httpMethod": "PATCH", "id": "drive.replies.update", "parameterOrder": [ @@ -2013,6 +2092,7 @@ "methods": { "delete": { "description": "Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.", + "flatPath": "files/{fileId}/revisions/{revisionId}", "httpMethod": "DELETE", "id": "drive.revisions.delete", "parameterOrder": [ @@ -2042,6 +2122,7 @@ }, "get": { "description": "Gets a revision's metadata or content by ID.", + "flatPath": "files/{fileId}/revisions/{revisionId}", "httpMethod": "GET", "id": "drive.revisions.get", "parameterOrder": [ @@ -2086,6 +2167,7 @@ }, "list": { "description": "Lists a file's revisions.", + "flatPath": "files/{fileId}/revisions", "httpMethod": "GET", "id": "drive.revisions.list", "parameterOrder": [ @@ -2129,6 +2211,7 @@ }, "update": { "description": "Updates a revision with patch semantics.", + "flatPath": "files/{fileId}/revisions/{revisionId}", "httpMethod": "PATCH", "id": "drive.revisions.update", "parameterOrder": [ @@ -2167,7 +2250,8 @@ "teamdrives": { "methods": { "create": { - "description": "Deprecated use drives.create instead.", + "description": "Deprecated: Use `drives.create` instead.", + "flatPath": "teamdrives", "httpMethod": "POST", "id": "drive.teamdrives.create", "parameterOrder": [ @@ -2175,7 +2259,7 @@ ], "parameters": { "requestId": { - "description": "An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.", + "description": "Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.", "location": "query", "required": true, "type": "string" @@ -2193,7 +2277,8 @@ ] }, "delete": { - "description": "Deprecated use drives.delete instead.", + "description": "Deprecated: Use `drives.delete` instead.", + "flatPath": "teamdrives/{teamDriveId}", "httpMethod": "DELETE", "id": "drive.teamdrives.delete", "parameterOrder": [ @@ -2213,7 +2298,8 @@ ] }, "get": { - "description": "Deprecated use drives.get instead.", + "description": "Deprecated: Use `drives.get` instead.", + "flatPath": "teamdrives/{teamDriveId}", "httpMethod": "GET", "id": "drive.teamdrives.get", "parameterOrder": [ @@ -2243,9 +2329,11 @@ ] }, "list": { - "description": "Deprecated use drives.list instead.", + "description": "Deprecated: Use `drives.list` instead.", + "flatPath": "teamdrives", "httpMethod": "GET", "id": "drive.teamdrives.list", + "parameterOrder": [], "parameters": { "pageSize": { "default": "10", @@ -2283,7 +2371,8 @@ ] }, "update": { - "description": "Deprecated use drives.update instead", + "description": "Deprecated: Use `drives.update` instead.", + "flatPath": "teamdrives/{teamDriveId}", "httpMethod": "PATCH", "id": "drive.teamdrives.update", "parameterOrder": [ @@ -2317,7 +2406,7 @@ } } }, - "revision": "20230514", + "revision": "20230517", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -2333,7 +2422,7 @@ "type": "boolean" }, "canCreateTeamDrives": { - "description": "Deprecated - use canCreateDrives instead.", + "description": "Deprecated: Use `canCreateDrives` instead.", "type": "boolean" }, "driveThemes": { @@ -2386,7 +2475,7 @@ }, "kind": { "default": "drive#about", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#about\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#about\"`.", "type": "string" }, "maxImportSizes": { @@ -2429,19 +2518,19 @@ "type": "object" }, "teamDriveThemes": { - "description": "Deprecated - use driveThemes instead.", + "description": "Deprecated: Use `driveThemes` instead.", "items": { "properties": { "backgroundImageLink": { - "description": "Deprecated - use driveThemes/backgroundImageLink instead.", + "description": "Deprecated: Use `driveThemes/backgroundImageLink` instead.", "type": "string" }, "colorRgb": { - "description": "Deprecated - use driveThemes/colorRgb instead.", + "description": "Deprecated: Use `driveThemes/colorRgb` instead.", "type": "string" }, "id": { - "description": "Deprecated - use driveThemes/id instead.", + "description": "Deprecated: Use `driveThemes/id` instead.", "type": "string" } }, @@ -2461,7 +2550,7 @@ "id": "Change", "properties": { "changeType": { - "description": "The type of the change. Possible values are file and drive.", + "description": "The type of the change. Possible values are `file` and `drive`.", "type": "string" }, "drive": { @@ -2482,7 +2571,7 @@ }, "kind": { "default": "drive#change", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#change\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#change\"`.", "type": "string" }, "removed": { @@ -2491,10 +2580,10 @@ }, "teamDrive": { "$ref": "TeamDrive", - "description": "Deprecated - use drive instead." + "description": "Deprecated: Use `drive` instead." }, "teamDriveId": { - "description": "Deprecated - use driveId instead.", + "description": "Deprecated: Use `driveId` instead.", "type": "string" }, "time": { @@ -2503,7 +2592,7 @@ "type": "string" }, "type": { - "description": "Deprecated - use changeType instead.", + "description": "Deprecated: Use `changeType` instead.", "type": "string" } }, @@ -2522,7 +2611,7 @@ }, "kind": { "default": "drive#changeList", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#changeList\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#changeList\"`.", "type": "string" }, "newStartPageToken": { @@ -2537,7 +2626,7 @@ "type": "object" }, "Channel": { - "description": "An notification channel used to watch for resource changes.", + "description": "A notification channel used to watch for resource changes.", "id": "Channel", "properties": { "address": { @@ -2555,12 +2644,11 @@ }, "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": { "additionalProperties": { - "description": "Declares a new parameter by name.", "type": "string" }, "description": "Additional parameters controlling delivery channel behavior. Optional.", @@ -2583,7 +2671,7 @@ "type": "string" }, "type": { - "description": "The type of delivery mechanism used for this channel. Valid values are \"web_hook\" (or \"webhook\"). Both values refer to a channel where Http requests are used to deliver messages.", + "description": "The type of delivery mechanism used for this channel.", "type": "string" } }, @@ -2594,12 +2682,12 @@ "id": "Comment", "properties": { "anchor": { - "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies.", + "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/drive/api/v3/manage-comments).", "type": "string" }, "author": { "$ref": "User", - "description": "The author of the comment. The author's email address and permission ID will not be populated." + "description": "Output only. The author of the comment. The author's email address and permission ID will not be populated." }, "content": { "annotations": { @@ -2608,7 +2696,7 @@ "drive.comments.update" ] }, - "description": "The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.", + "description": "The plain text content of the comment. This field is used for setting the content, while `htmlContent` should be displayed.", "type": "string" }, "createdTime": { @@ -2617,20 +2705,20 @@ "type": "string" }, "deleted": { - "description": "Whether the comment has been deleted. A deleted comment has no content.", + "description": "Output only. Whether the comment has been deleted. A deleted comment has no content.", "type": "boolean" }, "htmlContent": { - "description": "The content of the comment with HTML formatting.", + "description": "Output only. The content of the comment with HTML formatting.", "type": "string" }, "id": { - "description": "The ID of the comment.", + "description": "Output only. The ID of the comment.", "type": "string" }, "kind": { "default": "drive#comment", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#comment\".", + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#comment\"`.", "type": "string" }, "modifiedTime": { @@ -2653,14 +2741,14 @@ "type": "object" }, "replies": { - "description": "The full list of replies to the comment in chronological order.", + "description": "Output only. The full list of replies to the comment in chronological order.", "items": { "$ref": "Reply" }, "type": "array" }, "resolved": { - "description": "Whether the comment has been resolved by one of its replies.", + "description": "Output only. Whether the comment has been resolved by one of its replies.", "type": "boolean" } }, @@ -2679,7 +2767,7 @@ }, "kind": { "default": "drive#commentList", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#commentList\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#commentList\"`.", "type": "string" }, "nextPageToken": { @@ -2698,12 +2786,12 @@ "type": "boolean" }, "reason": { - "description": "Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.", + "description": "Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.", "type": "string" }, "restrictingUser": { "$ref": "User", - "description": "The user who set the content restriction. Only populated if readOnly is true." + "description": "Output only. The user who set the content restriction. Only populated if `readOnly` is true." }, "restrictionTime": { "description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.", @@ -2711,7 +2799,7 @@ "type": "string" }, "type": { - "description": "The type of the content restriction. Currently the only possible value is globalContentRestriction.", + "description": "Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.", "type": "string" } }, @@ -2722,7 +2810,7 @@ "id": "Drive", "properties": { "backgroundImageFile": { - "description": "An image file and cropping parameters from which a background image for this shared drive is set. This is a write-only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.", + "description": "An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.", "properties": { "id": { "description": "The ID of an image file in Google Drive to use for the background image.", @@ -2747,97 +2835,97 @@ "type": "object" }, "backgroundImageLink": { - "description": "A short-lived link to this shared drive's background image.", + "description": "Output only. A short-lived link to this shared drive's background image.", "type": "string" }, "capabilities": { - "description": "Capabilities the current user has on this shared drive.", + "description": "Output only. Capabilities the current user has on this shared drive.", "properties": { "canAddChildren": { - "description": "Whether the current user can add children to folders in this shared drive.", + "description": "Output only. Whether the current user can add children to folders in this shared drive.", "type": "boolean" }, "canChangeCopyRequiresWriterPermissionRestriction": { - "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.", + "description": "Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.", "type": "boolean" }, "canChangeDomainUsersOnlyRestriction": { - "description": "Whether the current user can change the domainUsersOnly restriction of this shared drive.", + "description": "Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.", "type": "boolean" }, "canChangeDriveBackground": { - "description": "Whether the current user can change the background of this shared drive.", + "description": "Output only. Whether the current user can change the background of this shared drive.", "type": "boolean" }, "canChangeDriveMembersOnlyRestriction": { - "description": "Whether the current user can change the driveMembersOnly restriction of this shared drive.", + "description": "Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.", "type": "boolean" }, "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": { - "description": "Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this shared drive.", + "description": "Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.", "type": "boolean" }, "canComment": { - "description": "Whether the current user can comment on files in this shared drive.", + "description": "Output only. Whether the current user can comment on files in this shared drive.", "type": "boolean" }, "canCopy": { - "description": "Whether the current user can copy files in this shared drive.", + "description": "Output only. Whether the current user can copy files in this shared drive.", "type": "boolean" }, "canDeleteChildren": { - "description": "Whether the current user can delete children from folders in this shared drive.", + "description": "Output only. Whether the current user can delete children from folders in this shared drive.", "type": "boolean" }, "canDeleteDrive": { - "description": "Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.", + "description": "Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.", "type": "boolean" }, "canDownload": { - "description": "Whether the current user can download files in this shared drive.", + "description": "Output only. Whether the current user can download files in this shared drive.", "type": "boolean" }, "canEdit": { - "description": "Whether the current user can edit files in this shared drive", + "description": "Output only. Whether the current user can edit files in this shared drive", "type": "boolean" }, "canListChildren": { - "description": "Whether the current user can list the children of folders in this shared drive.", + "description": "Output only. Whether the current user can list the children of folders in this shared drive.", "type": "boolean" }, "canManageMembers": { - "description": "Whether the current user can add members to this shared drive or remove them or change their role.", + "description": "Output only. Whether the current user can add members to this shared drive or remove them or change their role.", "type": "boolean" }, "canReadRevisions": { - "description": "Whether the current user can read the revisions resource of files in this shared drive.", + "description": "Output only. Whether the current user can read the revisions resource of files in this shared drive.", "type": "boolean" }, "canRename": { - "description": "Whether the current user can rename files or folders in this shared drive.", + "description": "Output only. Whether the current user can rename files or folders in this shared drive.", "type": "boolean" }, "canRenameDrive": { - "description": "Whether the current user can rename this shared drive.", + "description": "Output only. Whether the current user can rename this shared drive.", "type": "boolean" }, "canResetDriveRestrictions": { - "description": "Whether the current user can reset the shared drive restrictions to defaults.", + "description": "Output only. Whether the current user can reset the shared drive restrictions to defaults.", "type": "boolean" }, "canShare": { - "description": "Whether the current user can share files or folders in this shared drive.", + "description": "Output only. Whether the current user can share files or folders in this shared drive.", "type": "boolean" }, "canTrashChildren": { - "description": "Whether the current user can trash children from folders in this shared drive.", + "description": "Output only. Whether the current user can trash children from folders in this shared drive.", "type": "boolean" } }, "type": "object" }, "colorRgb": { - "description": "The color of this shared drive as an RGB hex string. It can only be set on drive.drives.update requests that don't set themeId.", + "description": "The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.", "type": "string" }, "createdTime": { @@ -2850,25 +2938,20 @@ "type": "boolean" }, "id": { - "description": "The ID of this shared drive which is also the ID of the top level folder of this shared drive.", + "description": "Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.", "type": "string" }, "kind": { "default": "drive#drive", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#drive\".", + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#drive\"`.", "type": "string" }, "name": { - "annotations": { - "required": [ - "drive.drives.create" - ] - }, "description": "The name of this shared drive.", "type": "string" }, "orgUnitId": { - "description": "The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true.", + "description": "Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.", "type": "string" }, "restrictions": { @@ -2879,7 +2962,7 @@ "type": "boolean" }, "copyRequiresWriterPermission": { - "description": "Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this shared drive.", + "description": "Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this shared drive.", "type": "boolean" }, "domainUsersOnly": { @@ -2898,7 +2981,7 @@ "type": "object" }, "themeId": { - "description": "The ID of the theme from which the background image and color are set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.", + "description": "The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.", "type": "string" } }, @@ -2917,7 +3000,7 @@ }, "kind": { "default": "drive#driveList", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#driveList\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#driveList\"`.", "type": "string" }, "nextPageToken": { @@ -2935,162 +3018,162 @@ "additionalProperties": { "type": "string" }, - "description": "A collection of arbitrary key-value pairs that 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 an OAuth 2 client ID. You cannot use an API key to retrieve private properties.", + "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": { - "description": "Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user can take.", + "description": "Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.", "properties": { "canAcceptOwnership": { - "description": "Whether the current user is the pending owner of the file. Not populated for shared drive files.", + "description": "Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.", "type": "boolean" }, "canAddChildren": { - "description": "Whether the current user can add children to this folder. This is always false when the item isn't a folder.", + "description": "Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder.", "type": "boolean" }, "canAddFolderFromAnotherDrive": { - "description": "Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item isn't a folder. Only populated for items in shared drives.", + "description": "Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canAddMyDriveParent": { - "description": "Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.", + "description": "Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.", "type": "boolean" }, "canChangeCopyRequiresWriterPermission": { - "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this file.", + "description": "Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.", "type": "boolean" }, "canChangeSecurityUpdateEnabled": { - "description": "Whether the current user can change the securityUpdateEnabled field on link share metadata.", + "description": "Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.", "type": "boolean" }, "canChangeViewersCanCopyContent": { - "description": "Deprecated", + "description": "Deprecated: Output only.", "type": "boolean" }, "canComment": { - "description": "Whether the current user can comment on this file.", + "description": "Output only. Whether the current user can comment on this file.", "type": "boolean" }, "canCopy": { - "description": "Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it's not a folder.", + "description": "Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.", "type": "boolean" }, "canDelete": { - "description": "Whether the current user can delete this file.", + "description": "Output only. Whether the current user can delete this file.", "type": "boolean" }, "canDeleteChildren": { - "description": "Whether the current user can delete children of this folder. This is false when the item isn't a folder. Only populated for items in shared drives.", + "description": "Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canDownload": { - "description": "Whether the current user can download this file.", + "description": "Output only. Whether the current user can download this file.", "type": "boolean" }, "canEdit": { - "description": "Whether the current user can edit this file. Other factors might limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.", + "description": "Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.", "type": "boolean" }, "canListChildren": { - "description": "Whether the current user can list the children of this folder. This is always false when the item isn't a folder.", + "description": "Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.", "type": "boolean" }, "canModifyContent": { - "description": "Whether the current user can modify the content of this file.", + "description": "Output only. Whether the current user can modify the content of this file.", "type": "boolean" }, "canModifyContentRestriction": { - "description": "Whether the current user can modify restrictions on content of this file.", + "description": "Output only. Whether the current user can modify restrictions on content of this file.", "type": "boolean" }, "canModifyLabels": { - "description": "Whether the current user can modify the labels on this file.", + "description": "Output only. Whether the current user can modify the labels on the file.", "type": "boolean" }, "canMoveChildrenOutOfDrive": { - "description": "Whether the current user can move children of this folder outside of the shared drive. This is false when the item isn't a folder. Only populated for items in shared drives.", + "description": "Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canMoveChildrenOutOfTeamDrive": { - "description": "Deprecated - use canMoveChildrenOutOfDrive instead.", + "description": "Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.", "type": "boolean" }, "canMoveChildrenWithinDrive": { - "description": "Whether the current user can move children of this folder within this shared drive or My Drive. This is false when the item isn't a folder. Note that a request to move the child might still fail depending on the current user's access to the child and to the destination folder.", + "description": "Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.", "type": "boolean" }, "canMoveChildrenWithinTeamDrive": { - "description": "Deprecated - use canMoveChildrenWithinDrive instead.", + "description": "Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.", "type": "boolean" }, "canMoveItemIntoTeamDrive": { - "description": "Deprecated - use canMoveItemOutOfDrive instead.", + "description": "Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.", "type": "boolean" }, "canMoveItemOutOfDrive": { - "description": "Whether the current user can move this item outside of this shared drive or My Drive by changing its parent. Note that a request to change the parent of the item might still fail depending on the new parent that's being added.", + "description": "Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.", "type": "boolean" }, "canMoveItemOutOfTeamDrive": { - "description": "Deprecated - use canMoveItemOutOfDrive instead.", + "description": "Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.", "type": "boolean" }, "canMoveItemWithinDrive": { - "description": "Whether the current user can move this item within this shared drive or My Drive. Note that a request to change the parent of the item might still fail depending on the new parent that's being added and the parent that's being removed.", + "description": "Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.", "type": "boolean" }, "canMoveItemWithinTeamDrive": { - "description": "Deprecated - use canMoveItemWithinDrive instead.", + "description": "Deprecated: Output only. Use `canMoveItemWithinDrive` instead.", "type": "boolean" }, "canMoveTeamDriveItem": { - "description": "Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.", + "description": "Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.", "type": "boolean" }, "canReadDrive": { - "description": "Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.", + "description": "Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.", "type": "boolean" }, "canReadLabels": { - "description": "Whether the current user can read the labels on this file.", + "description": "Output only. Whether the current user can read the labels on the file.", "type": "boolean" }, "canReadRevisions": { - "description": "Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it's not a folder, can be read.", + "description": "Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.", "type": "boolean" }, "canReadTeamDrive": { - "description": "Deprecated - use canReadDrive instead.", + "description": "Deprecated: Output only. Use `canReadDrive` instead.", "type": "boolean" }, "canRemoveChildren": { - "description": "Whether the current user can remove children from this folder. This is always false when the item isn't a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.", + "description": "Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.", "type": "boolean" }, "canRemoveMyDriveParent": { - "description": "Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.", + "description": "Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.", "type": "boolean" }, "canRename": { - "description": "Whether the current user can rename this file.", + "description": "Output only. Whether the current user can rename this file.", "type": "boolean" }, "canShare": { - "description": "Whether the current user can modify the sharing settings for this file.", + "description": "Output only. Whether the current user can modify the sharing settings for this file.", "type": "boolean" }, "canTrash": { - "description": "Whether the current user can move this file to trash.", + "description": "Output only. Whether the current user can move this file to trash.", "type": "boolean" }, "canTrashChildren": { - "description": "Whether the current user can trash children of this folder. This is false when the item isn't a folder. Only populated for items in shared drives.", + "description": "Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canUntrash": { - "description": "Whether the current user can restore this file from trash.", + "description": "Output only. Whether the current user can restore this file from trash.", "type": "boolean" } }, @@ -3100,7 +3183,7 @@ "description": "Additional information about the content of the file. These fields are never populated in responses.", "properties": { "indexableText": { - "description": "Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and might contain HTML elements. For more information, see Manage file metadata.", + "description": "Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.", "type": "string" }, "thumbnail": { @@ -3142,48 +3225,47 @@ "type": "string" }, "driveId": { - "description": "ID of the shared drive the file resides in. Only populated for items in shared drives.", + "description": "Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.", "type": "string" }, "explicitlyTrashed": { - "description": "Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.", + "description": "Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.", "type": "boolean" }, "exportLinks": { "additionalProperties": { - "description": "A mapping from export format to URL", "type": "string" }, - "description": "Links for exporting Docs Editors files to specific formats.", + "description": "Output only. Links for exporting Docs Editors files to specific formats.", "readOnly": true, "type": "object" }, "fileExtension": { - "description": "The final component of fullFileExtension. This is only available for files with binary content in Google Drive.", + "description": "Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.", "type": "string" }, "folderColorRgb": { - "description": "The color for a folder or shortcut to a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.\nIf an unsupported color is specified, the closest color in the palette will be used instead.", + "description": "The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the About resource. If an unsupported color is specified, the closest color in the palette is used instead.", "type": "string" }, "fullFileExtension": { - "description": "The full file extension extracted from the name field. Can contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive.\nThis is automatically updated when the name field changes, however it's not cleared if the new name does not contain a valid extension.", + "description": "Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it is not cleared if the new name does not contain a valid extension.", "type": "string" }, "hasAugmentedPermissions": { - "description": "Whether there are permissions directly on this file. This field is only populated for items in shared drives.", + "description": "Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.", "type": "boolean" }, "hasThumbnail": { - "description": "Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.", + "description": "Output only. Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.", "type": "boolean" }, "headRevisionId": { - "description": "The ID of the file's head revision. This is only available for files with binary content in Google Drive.", + "description": "Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.", "type": "string" }, "iconLink": { - "description": "A static, unauthenticated link to the file's icon.", + "description": "Output only. A static, unauthenticated link to the file's icon.", "type": "string" }, "id": { @@ -3191,77 +3273,77 @@ "type": "string" }, "imageMediaMetadata": { - "description": "Additional metadata about image media, if available.", + "description": "Output only. Additional metadata about image media, if available.", "properties": { "aperture": { - "description": "The aperture used to create the photo (f-number).", + "description": "Output only. The aperture used to create the photo (f-number).", "format": "float", "type": "number" }, "cameraMake": { - "description": "The make of the camera used to create the photo.", + "description": "Output only. The make of the camera used to create the photo.", "type": "string" }, "cameraModel": { - "description": "The model of the camera used to create the photo.", + "description": "Output only. The model of the camera used to create the photo.", "type": "string" }, "colorSpace": { - "description": "The color space of the photo.", + "description": "Output only. The color space of the photo.", "type": "string" }, "exposureBias": { - "description": "The exposure bias of the photo (APEX value).", + "description": "Output only. The exposure bias of the photo (APEX value).", "format": "float", "type": "number" }, "exposureMode": { - "description": "The exposure mode used to create the photo.", + "description": "Output only. The exposure mode used to create the photo.", "type": "string" }, "exposureTime": { - "description": "The length of the exposure, in seconds.", + "description": "Output only. The length of the exposure, in seconds.", "format": "float", "type": "number" }, "flashUsed": { - "description": "Whether a flash was used to create the photo.", + "description": "Output only. Whether a flash was used to create the photo.", "type": "boolean" }, "focalLength": { - "description": "The focal length used to create the photo, in millimeters.", + "description": "Output only. The focal length used to create the photo, in millimeters.", "format": "float", "type": "number" }, "height": { - "description": "The height of the image in pixels.", + "description": "Output only. The height of the image in pixels.", "format": "int32", "type": "integer" }, "isoSpeed": { - "description": "The ISO speed used to create the photo.", + "description": "Output only. The ISO speed used to create the photo.", "format": "int32", "type": "integer" }, "lens": { - "description": "The lens used to create the photo.", + "description": "Output only. The lens used to create the photo.", "type": "string" }, "location": { - "description": "Geographic location information stored in the image.", + "description": "Output only. Geographic location information stored in the image.", "properties": { "altitude": { - "description": "The altitude stored in the image.", + "description": "Output only. The altitude stored in the image.", "format": "double", "type": "number" }, "latitude": { - "description": "The latitude stored in the image.", + "description": "Output only. The latitude stored in the image.", "format": "double", "type": "number" }, "longitude": { - "description": "The longitude stored in the image.", + "description": "Output only. The longitude stored in the image.", "format": "double", "type": "number" } @@ -3269,38 +3351,38 @@ "type": "object" }, "maxApertureValue": { - "description": "The smallest f-number of the lens at the focal length used to create the photo (APEX value).", + "description": "Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).", "format": "float", "type": "number" }, "meteringMode": { - "description": "The metering mode used to create the photo.", + "description": "Output only. The metering mode used to create the photo.", "type": "string" }, "rotation": { - "description": "The number of clockwise 90-degree rotations applied from the image's original orientation.", + "description": "Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.", "format": "int32", "type": "integer" }, "sensor": { - "description": "The type of sensor used to create the photo.", + "description": "Output only. The type of sensor used to create the photo.", "type": "string" }, "subjectDistance": { - "description": "The distance to the subject of the photo, in meters.", + "description": "Output only. The distance to the subject of the photo, in meters.", "format": "int32", "type": "integer" }, "time": { - "description": "The date and time the photo was taken (EXIF DateTime).", + "description": "Output only. The date and time the photo was taken (EXIF DateTime).", "type": "string" }, "whiteBalance": { - "description": "The white balance mode used to create the photo.", + "description": "Output only. The white balance mode used to create the photo.", "type": "string" }, "width": { - "description": "The width of the image in pixels.", + "description": "Output only. The width of the image in pixels.", "format": "int32", "type": "integer" } @@ -3308,19 +3390,19 @@ "type": "object" }, "isAppAuthorized": { - "description": "Whether the requesting app created or opened the file.", + "description": "Output only. Whether the file was created or opened by the requesting app.", "type": "boolean" }, "kind": { "default": "drive#file", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#file\".", + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#file\"`.", "type": "string" }, "labelInfo": { - "description": "An overview of the labels on the file.", + "description": "Output only. An overview of the labels on the file.", "properties": { "labels": { - "description": "The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned.", + "description": "Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.", "items": { "$ref": "Label" }, @@ -3331,79 +3413,79 @@ }, "lastModifyingUser": { "$ref": "User", - "description": "The last user to modify the file." + "description": "Output only. The last user to modify the file." }, "linkShareMetadata": { "description": "Contains details about the link URLs that clients are using to refer to this item.", "properties": { "securityUpdateEligible": { - "description": "Whether the file is eligible for security update.", + "description": "Output only. Whether the file is eligible for security update.", "type": "boolean" }, "securityUpdateEnabled": { - "description": "Whether the security update is enabled for this file.", + "description": "Output only. Whether the security update is enabled for this file.", "type": "boolean" } }, "type": "object" }, "md5Checksum": { - "description": "The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.", + "description": "Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.", "type": "string" }, "mimeType": { - "description": "The MIME type of the file.\nGoogle Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.\nIf a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.", + "description": "The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the About resource.", "type": "string" }, "modifiedByMe": { - "description": "Whether this user has modified the file.", + "description": "Output only. Whether the file has been modified by this user.", "type": "boolean" }, "modifiedByMeTime": { - "description": "The last time the user modified the file (RFC 3339 date-time).", + "description": "The last time the file was modified by the user (RFC 3339 date-time).", "format": "date-time", "type": "string" }, "modifiedTime": { - "description": "The last time anyone modified the file (RFC 3339 date-time).\nNote that setting modifiedTime will also update modifiedByMeTime for the user.", + "description": "he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.", "format": "date-time", "type": "string" }, "name": { - "description": "The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.", + "description": "The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.", "type": "string" }, "originalFilename": { - "description": "The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.", + "description": "The original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive.", "type": "string" }, "ownedByMe": { - "description": "Whether the user owns the file. Not populated for items in shared drives.", + "description": "Output only. Whether the user owns the file. Not populated for items in shared drives.", "type": "boolean" }, "owners": { - "description": "The owner of this file. Only certain legacy files might have more than one owner. This field isn't populated for items in shared drives.", + "description": "Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.", "items": { "$ref": "User" }, "type": "array" }, "parents": { - "description": "The IDs of the parent folders that contain the file.\nIf not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.", + "description": "The IDs of the parent folders which contain the file. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parents of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.", "items": { "type": "string" }, "type": "array" }, "permissionIds": { - "description": "List of permission IDs for users with access to this file.", + "description": "Output only. List of permission IDs for users with access to this file.", "items": { "type": "string" }, "type": "array" }, "permissions": { - "description": "The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.", + "description": "Output only. The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.", "items": { "$ref": "Permission" }, @@ -3413,28 +3495,28 @@ "additionalProperties": { "type": "string" }, - "description": "A collection of arbitrary key-value pairs that are visible to all apps.\nEntries with null values are cleared in update and copy requests.", + "description": "A collection of arbitrary key-value pairs which are visible to all apps.\nEntries with null values are cleared in update and copy requests.", "type": "object" }, "quotaBytesUsed": { - "description": "The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.", + "description": "Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.", "format": "int64", "type": "string" }, "resourceKey": { - "description": "A key needed to access the item via a shared link.", + "description": "Output only. A key needed to access the item via a shared link.", "type": "string" }, "sha1Checksum": { - "description": "The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.", + "description": "Output only. The SHA1 checksum associated with this file, if available. 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" }, "sha256Checksum": { - "description": "The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.", + "description": "Output only. The SHA256 checksum associated with this file, if available. 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" }, "shared": { - "description": "Whether the file has been shared. Not populated for items in shared drives.", + "description": "Output only. Whether the file has been shared. Not populated for items in shared drives.", "type": "boolean" }, "sharedWithMeTime": { @@ -3444,33 +3526,33 @@ }, "sharingUser": { "$ref": "User", - "description": "The user who shared the file with the requesting user, if applicable." + "description": "Output only. The user who shared the file with the requesting user, if applicable." }, "shortcutDetails": { - "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.", + "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`.", "properties": { "targetId": { "description": "The ID of the file that this shortcut points to.", "type": "string" }, "targetMimeType": { - "description": "The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.", + "description": "Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.", "type": "string" }, "targetResourceKey": { - "description": "The ResourceKey for the target file.", + "description": "Output only. The ResourceKey for the target file.", "type": "string" } }, "type": "object" }, "size": { - "description": "The size of the file's content in bytes. This field is populated for files with binary content stored in Google Drive and for Docs Editors files; it's not populated for shortcuts or folders.", + "description": "Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.", "format": "int64", "type": "string" }, "spaces": { - "description": "The list of spaces that contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.", + "description": "Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.", "items": { "type": "string" }, @@ -3481,20 +3563,20 @@ "type": "boolean" }, "teamDriveId": { - "description": "Deprecated - use driveId instead.", + "description": "Deprecated: Output only. Use `driveId` instead.", "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. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.", + "description": "Output only. 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.", "type": "string" }, "thumbnailVersion": { - "description": "The thumbnail version for use in thumbnail cache invalidation.", + "description": "Output only. The thumbnail version for use in thumbnail cache invalidation.", "format": "int64", "type": "string" }, "trashed": { - "description": "Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner can trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.", + "description": "Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.", "type": "boolean" }, "trashedTime": { @@ -3504,28 +3586,28 @@ }, "trashingUser": { "$ref": "User", - "description": "If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives." + "description": "Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives." }, "version": { - "description": "A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.", + "description": "Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.", "format": "int64", "type": "string" }, "videoMediaMetadata": { - "description": "Additional metadata about video media. This might not be available immediately upon upload.", + "description": "Output only. Additional metadata about video media. This may not be available immediately upon upload.", "properties": { "durationMillis": { - "description": "The duration of the video in milliseconds.", + "description": "Output only. The duration of the video in milliseconds.", "format": "int64", "type": "string" }, "height": { - "description": "The height of the video in pixels.", + "description": "Output only. The height of the video in pixels.", "format": "int32", "type": "integer" }, "width": { - "description": "The width of the video in pixels.", + "description": "Output only. The width of the video in pixels.", "format": "int32", "type": "integer" } @@ -3533,28 +3615,28 @@ "type": "object" }, "viewedByMe": { - "description": "Whether this user has viewed the file.", + "description": "Output only. Whether the file has been viewed by this user.", "type": "boolean" }, "viewedByMeTime": { - "description": "The last time the user viewed the file (RFC 3339 date-time).", + "description": "The last time the file was viewed by the user (RFC 3339 date-time).", "format": "date-time", "type": "string" }, "viewersCanCopyContent": { - "description": "Deprecated - use copyRequiresWriterPermission instead.", + "description": "Deprecated: Use `copyRequiresWriterPermission` instead.", "type": "boolean" }, "webContentLink": { - "description": "A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.", + "description": "Output only. A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.", "type": "string" }, "webViewLink": { - "description": "A link for opening the file in a relevant Google editor or viewer in a browser.", + "description": "Output only. A link for opening the file in a relevant Google editor or viewer in a browser.", "type": "string" }, "writersCanShare": { - "description": "Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.", + "description": "Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.", "type": "boolean" } }, @@ -3572,12 +3654,12 @@ "type": "array" }, "incompleteSearch": { - "description": "Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple drives with the \"allDrives\" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as \"user\" or \"drive\".", + "description": "Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the 'allDrives' corpora, but all corpora couldn't be searched. When this happens, it's suggested that clients narrow their query by choosing a different corpus such as 'user' or 'drive'.", "type": "boolean" }, "kind": { "default": "drive#fileList", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#fileList\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#fileList\"`.", "type": "string" }, "nextPageToken": { @@ -3600,7 +3682,7 @@ }, "kind": { "default": "drive#generatedIds", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#generatedIds\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#generatedIds\"`.", "type": "string" }, "space": { @@ -3611,14 +3693,14 @@ "type": "object" }, "Label": { - "description": "Representation of a label and its fields.", + "description": "Representation of label and label fields.", "id": "Label", "properties": { "fields": { "additionalProperties": { "$ref": "LabelField" }, - "description": "A map of the label's fields keyed by the field ID.", + "description": "A map of the fields on the label, keyed by the field's ID.", "type": "object" }, "id": { @@ -3626,7 +3708,6 @@ "type": "string" }, "kind": { - "default": "drive#label", "description": "This is always drive#label", "type": "string" }, @@ -3638,7 +3719,7 @@ "type": "object" }, "LabelField": { - "description": "Representation of a label field.", + "description": "Representation of field, which is a typed key-value pair.", "id": "LabelField", "properties": { "dateString": { @@ -3650,11 +3731,11 @@ "type": "array" }, "id": { - "description": "The identifier of this field.", + "description": "The identifier of this label field.", "type": "string" }, "integer": { - "description": "Only present if valueType is integer.", + "description": "Only present if `valueType` is `integer`.", "items": { "format": "int64", "type": "string" @@ -3662,33 +3743,32 @@ "type": "array" }, "kind": { - "default": "drive#labelField", "description": "This is always drive#labelField.", "type": "string" }, "selection": { - "description": "Only present if valueType is selection.", + "description": "Only present if `valueType` is `selection`", "items": { "type": "string" }, "type": "array" }, "text": { - "description": "Only present if valueType is text.", + "description": "Only present if `valueType` is `text`.", "items": { "type": "string" }, "type": "array" }, "user": { - "description": "Only present if valueType is user.", + "description": "Only present if `valueType` is `user`.", "items": { "$ref": "User" }, "type": "array" }, "valueType": { - "description": "The field type. While new values may be supported in the future, the following are currently allowed: \n- dateString \n- integer \n- selection \n- text \n- user", + "description": "The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`", "type": "string" } }, @@ -3699,16 +3779,15 @@ "id": "LabelFieldModification", "properties": { "fieldId": { - "description": "The ID of the Field to be modified.", + "description": "The ID of the field to be modified.", "type": "string" }, "kind": { - "default": "drive#labelFieldModification", "description": "This is always drive#labelFieldModification.", "type": "string" }, "setDateValues": { - "description": "Replaces a dateString field with these new values. The values must be strings in the RFC 3339 full-date format: YYYY-MM-DD.", + "description": "Replaces the value of a dateString Field with these new values. The string must be in the RFC 3339 full-date format: YYYY-MM-DD.", "items": { "format": "date", "type": "string" @@ -3716,7 +3795,7 @@ "type": "array" }, "setIntegerValues": { - "description": "Replaces an integer field with these new values.", + "description": "Replaces the value of an `integer` field with these new values.", "items": { "format": "int64", "type": "string" @@ -3724,21 +3803,21 @@ "type": "array" }, "setSelectionValues": { - "description": "Replaces a selection field with these new values.", + "description": "Replaces a `selection` field with these new values.", "items": { "type": "string" }, "type": "array" }, "setTextValues": { - "description": "Replaces a text field with these new values.", + "description": "Sets the value of a `text` field.", "items": { "type": "string" }, "type": "array" }, "setUserValues": { - "description": "Replaces a user field with these new values. The values must be valid email addresses.", + "description": "Replaces a `user` field with these new values. The values must be valid email addresses.", "items": { "type": "string" }, @@ -3752,11 +3831,10 @@ "type": "object" }, "LabelList": { - "description": "A list of labels.", + "description": "A list of labels applied to a file.", "id": "LabelList", "properties": { "kind": { - "default": "drive#labelList", "description": "This is always drive#labelList", "type": "string" }, @@ -3786,7 +3864,6 @@ "type": "array" }, "kind": { - "default": "drive#labelModification", "description": "This is always drive#labelModification.", "type": "string" }, @@ -3807,12 +3884,11 @@ "type": "object" }, "ModifyLabelsRequest": { - "description": "A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail transactionally.", + "description": "A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail atomically.", "id": "ModifyLabelsRequest", "properties": { "kind": { - "default": "drive#modifyLabelsRequest", - "description": "This is always drive#modifyLabelsRequest", + "description": "This is always drive#modifyLabelsRequest.", "type": "string" }, "labelModifications": { @@ -3830,7 +3906,6 @@ "id": "ModifyLabelsResponse", "properties": { "kind": { - "default": "drive#modifyLabelsResponse", "description": "This is always drive#modifyLabelsResponse", "type": "string" }, @@ -3845,23 +3920,23 @@ "type": "object" }, "Permission": { - "description": "A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy.", + "description": "A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.", "id": "Permission", "properties": { "allowFileDiscovery": { - "description": "Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.", + "description": "Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`.", "type": "boolean" }, "deleted": { - "description": "Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.", + "description": "Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.", "type": "boolean" }, "displayName": { - "description": "The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: \n- user - User's full name, as defined for their Google Account, such as \"Joe Smith.\" \n- group - Name of the Google Group, such as \"The Company Administrators.\" \n- domain - String domain name, such as \"your-company.com.\" \n- anyone - No displayName is present.", + "description": "Output only. The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as \"Joe Smith.\" * `group` - Name of the Google Group, such as \"The Company Administrators.\" * `domain` - String domain name, such as \"thecompany.com.\" * `anyone` - No `displayName` is present.", "type": "string" }, "domain": { - "description": "The domain to which this permission refers. The following options are currently allowed: \n- The entire domain, such as \"your-company.com.\" \n- A target audience, such as \"ID.audience.googledomains.com.\"", + "description": "The domain to which this permission refers.", "type": "string" }, "emailAddress": { @@ -3869,41 +3944,41 @@ "type": "string" }, "expirationTime": { - "description": "The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: \n- They cannot be set on shared drive items. \n- They can only be set on user and group permissions. \n- The time must be in the future. \n- The time cannot be more than one year in the future.", + "description": "The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future", "format": "date-time", "type": "string" }, "id": { - "description": "The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.", + "description": "Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values.", "type": "string" }, "kind": { "default": "drive#permission", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#permission\".", + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#permission\"`.", "type": "string" }, "pendingOwner": { - "description": "Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that aren't in a shared drive.", + "description": "Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.", "type": "boolean" }, "permissionDetails": { - "description": "Details of whether the permissions on this shared drive item are inherited or are directly on this item. This is an output-only field that's present only for shared drive items.", + "description": "Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.", "items": { "properties": { "inherited": { - "description": "Whether this permission is inherited. This field is always populated. This is an output-only field.", + "description": "Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.", "type": "boolean" }, "inheritedFrom": { - "description": "The ID of the item from which this permission is inherited. This is an output-only field.", + "description": "Output only. The ID of the item from which this permission is inherited. This is an output-only field.", "type": "string" }, "permissionType": { - "description": "The permission type for this user. While new values may be added in future, the following are currently allowed: \n- file \n- member", + "description": "Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`", "type": "string" }, "role": { - "description": "The primary role for this user. While new values may be added in the future, the following are currently allowed: \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader", + "description": "Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`", "type": "string" } }, @@ -3913,7 +3988,7 @@ "type": "array" }, "photoLink": { - "description": "A link to the user's profile photo, if available.", + "description": "Output only. A link to the user's profile photo, if available.", "type": "string" }, "role": { @@ -3922,27 +3997,27 @@ "drive.permissions.create" ] }, - "description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: \n- owner \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader", + "description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`", "type": "string" }, "teamDrivePermissionDetails": { - "description": "Deprecated - use permissionDetails instead.", + "description": "Output only. Deprecated: Output only. Use `permissionDetails` instead.", "items": { "properties": { "inherited": { - "description": "Deprecated - use permissionDetails/inherited instead.", + "description": "Deprecated: Output only. Use `permissionDetails/inherited` instead.", "type": "boolean" }, "inheritedFrom": { - "description": "Deprecated - use permissionDetails/inheritedFrom instead.", + "description": "Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.", "type": "string" }, "role": { - "description": "Deprecated - use permissionDetails/role instead.", + "description": "Deprecated: Output only. Use `permissionDetails/role` instead.", "type": "string" }, "teamDrivePermissionType": { - "description": "Deprecated - use permissionDetails/permissionType instead.", + "description": "Deprecated: Output only. Use `permissionDetails/permissionType` instead.", "type": "string" } }, @@ -3957,11 +4032,11 @@ "drive.permissions.create" ] }, - "description": "The type of the grantee. Valid values are: \n- user \n- group \n- domain \n- anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for the anyone type.", + "description": "The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type.", "type": "string" }, "view": { - "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.", + "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value.", "type": "string" } }, @@ -3973,7 +4048,7 @@ "properties": { "kind": { "default": "drive#permissionList", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#permissionList\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#permissionList\"`.", "type": "string" }, "nextPageToken": { @@ -3995,12 +4070,12 @@ "id": "Reply", "properties": { "action": { - "description": "The action the reply performed to the parent comment. Valid values are: \n- resolve \n- reopen", + "description": "The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen`", "type": "string" }, "author": { "$ref": "User", - "description": "The author of the reply. The author's email address and permission ID will not be populated." + "description": "Output only. The author of the reply. The author's email address and permission ID will not be populated." }, "content": { "annotations": { @@ -4008,7 +4083,7 @@ "drive.replies.update" ] }, - "description": "The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.", + "description": "The plain text content of the reply. This field is used for setting the content, while `htmlContent` should be displayed. This is required on creates if no `action` is specified.", "type": "string" }, "createdTime": { @@ -4017,20 +4092,20 @@ "type": "string" }, "deleted": { - "description": "Whether the reply has been deleted. A deleted reply has no content.", + "description": "Output only. Whether the reply has been deleted. A deleted reply has no content.", "type": "boolean" }, "htmlContent": { - "description": "The content of the reply with HTML formatting.", + "description": "Output only. The content of the reply with HTML formatting.", "type": "string" }, "id": { - "description": "The ID of the reply.", + "description": "Output only. The ID of the reply.", "type": "string" }, "kind": { "default": "drive#reply", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#reply\".", + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#reply\"`.", "type": "string" }, "modifiedTime": { @@ -4047,7 +4122,7 @@ "properties": { "kind": { "default": "drive#replyList", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#replyList\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#replyList\"`.", "type": "string" }, "nextPageToken": { @@ -4070,35 +4145,34 @@ "properties": { "exportLinks": { "additionalProperties": { - "description": "A mapping from export format to URL", "type": "string" }, - "description": "Links for exporting Docs Editors files to specific formats.", + "description": "Output only. Links for exporting Docs Editors files to specific formats.", "type": "object" }, "id": { - "description": "The ID of the revision.", + "description": "Output only. The ID of the revision.", "type": "string" }, "keepForever": { - "description": "Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.\nThis field is only applicable to files with binary content in Drive.", + "description": "Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file. This field is only applicable to files with binary content in Drive.", "type": "boolean" }, "kind": { "default": "drive#revision", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#revision\".", + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#revision\"`.", "type": "string" }, "lastModifyingUser": { "$ref": "User", - "description": "The last user to modify this revision." + "description": "Output only. The last user to modify this revision." }, "md5Checksum": { - "description": "The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.", + "description": "Output only. The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.", "type": "string" }, "mimeType": { - "description": "The MIME type of the revision.", + "description": "Output only. The MIME type of the revision.", "type": "string" }, "modifiedTime": { @@ -4107,7 +4181,7 @@ "type": "string" }, "originalFilename": { - "description": "The original filename used to create this revision. This is only applicable to files with binary content in Drive.", + "description": "Output only. The original filename used to create this revision. This is only applicable to files with binary content in Drive.", "type": "string" }, "publishAuto": { @@ -4119,7 +4193,7 @@ "type": "boolean" }, "publishedLink": { - "description": "A link to the published revision. This is only populated for Google Sites files.", + "description": "Output only. A link to the published revision. This is only populated for Google Sites files.", "type": "string" }, "publishedOutsideDomain": { @@ -4127,7 +4201,7 @@ "type": "boolean" }, "size": { - "description": "The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.", + "description": "Output only. The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.", "format": "int64", "type": "string" } @@ -4140,7 +4214,7 @@ "properties": { "kind": { "default": "drive#revisionList", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#revisionList\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#revisionList\"`.", "type": "string" }, "nextPageToken": { @@ -4162,7 +4236,7 @@ "properties": { "kind": { "default": "drive#startPageToken", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#startPageToken\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#startPageToken\"`.", "type": "string" }, "startPageToken": { @@ -4177,7 +4251,7 @@ "id": "TeamDrive", "properties": { "backgroundImageFile": { - "description": "An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.", + "description": "An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on `drive.teamdrives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.", "properties": { "id": { "description": "The ID of an image file in Drive to use for the background image.", @@ -4213,15 +4287,15 @@ "type": "boolean" }, "canChangeCopyRequiresWriterPermissionRestriction": { - "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive.", + "description": "Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.", "type": "boolean" }, "canChangeDomainUsersOnlyRestriction": { - "description": "Whether the current user can change the domainUsersOnly restriction of this Team Drive.", + "description": "Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.", "type": "boolean" }, "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": { - "description": "Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this Team Drive.", + "description": "Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.", "type": "boolean" }, "canChangeTeamDriveBackground": { @@ -4229,7 +4303,7 @@ "type": "boolean" }, "canChangeTeamMembersOnlyRestriction": { - "description": "Whether the current user can change the teamMembersOnly restriction of this Team Drive.", + "description": "Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.", "type": "boolean" }, "canComment": { @@ -4269,7 +4343,7 @@ "type": "boolean" }, "canRemoveChildren": { - "description": "Deprecated - use canDeleteChildren or canTrashChildren instead.", + "description": "Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.", "type": "boolean" }, "canRename": { @@ -4296,7 +4370,7 @@ "type": "object" }, "colorRgb": { - "description": "The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId.", + "description": "The color of this Team Drive as an RGB hex string. It can only be set on a `drive.teamdrives.update` request that does not set `themeId`.", "type": "string" }, "createdTime": { @@ -4310,20 +4384,15 @@ }, "kind": { "default": "drive#teamDrive", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#teamDrive\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#teamDrive\"`.", "type": "string" }, "name": { - "annotations": { - "required": [ - "drive.teamdrives.create" - ] - }, "description": "The name of this Team Drive.", "type": "string" }, "orgUnitId": { - "description": "The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true.", + "description": "The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.", "type": "string" }, "restrictions": { @@ -4334,7 +4403,7 @@ "type": "boolean" }, "copyRequiresWriterPermission": { - "description": "Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this Team Drive.", + "description": "Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this Team Drive.", "type": "boolean" }, "domainUsersOnly": { @@ -4353,7 +4422,7 @@ "type": "object" }, "themeId": { - "description": "The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.", + "description": "The ID of the theme from which the background image and color will be set. The set of possible `teamDriveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.teamdrives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.", "type": "string" } }, @@ -4365,7 +4434,7 @@ "properties": { "kind": { "default": "drive#teamDriveList", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#teamDriveList\".", + "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#teamDriveList\"`.", "type": "string" }, "nextPageToken": { @@ -4387,28 +4456,28 @@ "id": "User", "properties": { "displayName": { - "description": "A plain text displayable name for this user.", + "description": "Output only. A plain text displayable name for this user.", "type": "string" }, "emailAddress": { - "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", + "description": "Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", - "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#user\"`.", "type": "string" }, "me": { - "description": "Whether this user is the requesting user.", + "description": "Output only. Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { - "description": "The user's ID as visible in Permission resources.", + "description": "Output only. The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { - "description": "A link to the user's profile photo, if available.", + "description": "Output only. A link to the user's profile photo, if available.", "type": "string" } }, @@ -4416,6 +4485,6 @@ } }, "servicePath": "drive/v3/", - "title": "Drive API", + "title": "Google Drive API", "version": "v3" } \ No newline at end of file diff --git a/drive/v3/drive-gen.go b/drive/v3/drive-gen.go index b538a712f20..ece3e0ddf12 100644 --- a/drive/v3/drive-gen.go +++ b/drive/v3/drive-gen.go @@ -4,7 +4,7 @@ // Code generated file. DO NOT EDIT. -// Package drive provides access to the Drive API. +// Package drive provides access to the Google Drive API. // // For product documentation, see: https://developers.google.com/drive/ // @@ -81,6 +81,7 @@ const apiId = "drive:v3" const apiName = "drive" const apiVersion = "v3" const basePath = "https://www.googleapis.com/drive/v3/" +const mtlsBasePath = "https://www.mtls.googleapis.com/drive/v3/" // OAuth2 scopes used by this API. const ( @@ -126,6 +127,7 @@ func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, err // NOTE: prepend, so we don't override user-specified scopes. opts = append([]option.ClientOption{scopesOption}, opts...) opts = append(opts, internaloption.WithDefaultEndpoint(basePath)) + opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath)) client, endpoint, err := htransport.NewClient(ctx, opts...) if err != nil { return nil, err @@ -295,7 +297,7 @@ type About struct { // CanCreateDrives: Whether the user can create shared drives. CanCreateDrives bool `json:"canCreateDrives,omitempty"` - // CanCreateTeamDrives: Deprecated - use canCreateDrives instead. + // CanCreateTeamDrives: Deprecated: Use `canCreateDrives` instead. CanCreateTeamDrives bool `json:"canCreateTeamDrives,omitempty"` // DriveThemes: A list of themes that are supported for shared drives. @@ -327,7 +329,7 @@ type About struct { // are measured in bytes. StorageQuota *AboutStorageQuota `json:"storageQuota,omitempty"` - // TeamDriveThemes: Deprecated - use driveThemes instead. + // TeamDriveThemes: Deprecated: Use `driveThemes` instead. TeamDriveThemes []*AboutTeamDriveThemes `json:"teamDriveThemes,omitempty"` // User: The authenticated user. @@ -434,14 +436,14 @@ func (s *AboutStorageQuota) MarshalJSON() ([]byte, error) { } type AboutTeamDriveThemes struct { - // BackgroundImageLink: Deprecated - use driveThemes/backgroundImageLink - // instead. + // BackgroundImageLink: Deprecated: Use + // `driveThemes/backgroundImageLink` instead. BackgroundImageLink string `json:"backgroundImageLink,omitempty"` - // ColorRgb: Deprecated - use driveThemes/colorRgb instead. + // ColorRgb: Deprecated: Use `driveThemes/colorRgb` instead. ColorRgb string `json:"colorRgb,omitempty"` - // Id: Deprecated - use driveThemes/id instead. + // Id: Deprecated: Use `driveThemes/id` instead. Id string `json:"id,omitempty"` // ForceSendFields is a list of field names (e.g. "BackgroundImageLink") @@ -470,8 +472,8 @@ func (s *AboutTeamDriveThemes) MarshalJSON() ([]byte, error) { // Change: A change to a file or shared drive. type Change struct { - // ChangeType: The type of the change. Possible values are file and - // drive. + // ChangeType: The type of the change. Possible values are `file` and + // `drive`. ChangeType string `json:"changeType,omitempty"` // Drive: The updated state of the shared drive. Present if the @@ -497,16 +499,16 @@ type Change struct { // list of changes, for example by deletion or loss of access. Removed bool `json:"removed,omitempty"` - // TeamDrive: Deprecated - use drive instead. + // TeamDrive: Deprecated: Use `drive` instead. TeamDrive *TeamDrive `json:"teamDrive,omitempty"` - // TeamDriveId: Deprecated - use driveId instead. + // TeamDriveId: Deprecated: Use `driveId` instead. TeamDriveId string `json:"teamDriveId,omitempty"` // Time: The time of this change (RFC 3339 date-time). Time string `json:"time,omitempty"` - // Type: Deprecated - use changeType instead. + // Type: Deprecated: Use `changeType` instead. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "ChangeType") to @@ -581,7 +583,7 @@ func (s *ChangeList) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Channel: An notification channel used to watch for resource changes. +// Channel: A notification channel used to watch for resource changes. type Channel struct { // Address: The address where notifications are delivered for this // channel. @@ -595,7 +597,7 @@ type Channel struct { Id string `json:"id,omitempty"` // Kind: Identifies this as a notification channel used to watch for - // changes to a resource, which is "api#channel". + // changes to a resource, which is `api#channel`. Kind string `json:"kind,omitempty"` // Params: Additional parameters controlling delivery channel behavior. @@ -617,9 +619,7 @@ type Channel struct { // notification delivered over this channel. Optional. Token string `json:"token,omitempty"` - // Type: The type of delivery mechanism used for this channel. Valid - // values are "web_hook" (or "webhook"). Both values refer to a channel - // where Http requests are used to deliver messages. + // Type: The type of delivery mechanism used for this channel. Type string `json:"type,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -652,34 +652,35 @@ func (s *Channel) MarshalJSON() ([]byte, error) { // Comment: A comment on a file. type Comment struct { // Anchor: A region of the document represented as a JSON string. For - // details on defining anchor properties, refer to Add comments and - // replies. + // details on defining anchor properties, refer to Manage comments and + // replies (https://developers.google.com/drive/api/v3/manage-comments). Anchor string `json:"anchor,omitempty"` - // Author: The author of the comment. The author's email address and - // permission ID will not be populated. + // Author: Output only. The author of the comment. The author's email + // address and permission ID will not be populated. Author *User `json:"author,omitempty"` // Content: The plain text content of the comment. This field is used - // for setting the content, while htmlContent should be displayed. + // for setting the content, while `htmlContent` should be displayed. Content string `json:"content,omitempty"` // CreatedTime: The time at which the comment was created (RFC 3339 // date-time). CreatedTime string `json:"createdTime,omitempty"` - // Deleted: Whether the comment has been deleted. A deleted comment has - // no content. + // Deleted: Output only. Whether the comment has been deleted. A deleted + // comment has no content. Deleted bool `json:"deleted,omitempty"` - // HtmlContent: The content of the comment with HTML formatting. + // HtmlContent: Output only. The content of the comment with HTML + // formatting. HtmlContent string `json:"htmlContent,omitempty"` - // Id: The ID of the comment. + // Id: Output only. The ID of the comment. Id string `json:"id,omitempty"` - // Kind: Identifies what kind of resource this is. Value: the fixed - // string "drive#comment". + // Kind: Output only. Identifies what kind of resource this is. Value: + // the fixed string "drive#comment". Kind string `json:"kind,omitempty"` // ModifiedTime: The last time the comment or any of its replies was @@ -691,12 +692,12 @@ type Comment struct { // this would be the text at the location of the comment. QuotedFileContent *CommentQuotedFileContent `json:"quotedFileContent,omitempty"` - // Replies: The full list of replies to the comment in chronological - // order. + // Replies: Output only. The full list of replies to the comment in + // chronological order. Replies []*Reply `json:"replies,omitempty"` - // Resolved: Whether the comment has been resolved by one of its - // replies. + // Resolved: Output only. Whether the comment has been resolved by one + // of its replies. Resolved bool `json:"resolved,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -814,19 +815,19 @@ type ContentRestriction struct { ReadOnly bool `json:"readOnly,omitempty"` // Reason: Reason for why the content of the file is restricted. This is - // only mutable on requests that also set readOnly=true. + // only mutable on requests that also set `readOnly=true`. Reason string `json:"reason,omitempty"` - // RestrictingUser: The user who set the content restriction. Only - // populated if readOnly is true. + // RestrictingUser: Output only. The user who set the content + // restriction. Only populated if `readOnly` is true. RestrictingUser *User `json:"restrictingUser,omitempty"` // RestrictionTime: The time at which the content restriction was set // (formatted RFC 3339 timestamp). Only populated if readOnly is true. RestrictionTime string `json:"restrictionTime,omitempty"` - // Type: The type of the content restriction. Currently the only - // possible value is globalContentRestriction. + // Type: Output only. The type of the content restriction. Currently the + // only possible value is `globalContentRestriction`. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "ReadOnly") to @@ -855,21 +856,23 @@ func (s *ContentRestriction) MarshalJSON() ([]byte, error) { // Drive: Representation of a shared drive. type Drive struct { // BackgroundImageFile: An image file and cropping parameters from which - // a background image for this shared drive is set. This is a write-only - // field; it can only be set on drive.drives.update requests that don't - // set themeId. When specified, all fields of the backgroundImageFile - // must be set. + // a background image for this shared drive is set. This is a write only + // field; it can only be set on `drive.drives.update` requests that + // don't set `themeId`. When specified, all fields of the + // `backgroundImageFile` must be set. BackgroundImageFile *DriveBackgroundImageFile `json:"backgroundImageFile,omitempty"` - // BackgroundImageLink: A short-lived link to this shared drive's - // background image. + // BackgroundImageLink: Output only. A short-lived link to this shared + // drive's background image. BackgroundImageLink string `json:"backgroundImageLink,omitempty"` - // Capabilities: Capabilities the current user has on this shared drive. + // Capabilities: Output only. Capabilities the current user has on this + // shared drive. Capabilities *DriveCapabilities `json:"capabilities,omitempty"` // ColorRgb: The color of this shared drive as an RGB hex string. It can - // only be set on drive.drives.update requests that don't set themeId. + // only be set on a `drive.drives.update` request that does not set + // `themeId`. ColorRgb string `json:"colorRgb,omitempty"` // CreatedTime: The time at which the shared drive was created (RFC 3339 @@ -879,20 +882,20 @@ type Drive struct { // Hidden: Whether the shared drive is hidden from default view. Hidden bool `json:"hidden,omitempty"` - // Id: The ID of this shared drive which is also the ID of the top level - // folder of this shared drive. + // Id: Output only. The ID of this shared drive which is also the ID of + // the top level folder of this shared drive. Id string `json:"id,omitempty"` - // Kind: Identifies what kind of resource this is. Value: the fixed - // string "drive#drive". + // Kind: Output only. Identifies what kind of resource this is. Value: + // the fixed string "drive#drive". Kind string `json:"kind,omitempty"` // Name: The name of this shared drive. Name string `json:"name,omitempty"` - // OrgUnitId: The organizational unit of this shared drive. This field - // is only populated on drives.list responses when the - // useDomainAdminAccess parameter is set to true. + // OrgUnitId: Output only. The organizational unit of this shared drive. + // This field is only populated on `drives.list` responses when the + // `useDomainAdminAccess` parameter is set to `true`. OrgUnitId string `json:"orgUnitId,omitempty"` // Restrictions: A set of restrictions that apply to this shared drive @@ -900,12 +903,12 @@ type Drive struct { Restrictions *DriveRestrictions `json:"restrictions,omitempty"` // ThemeId: The ID of the theme from which the background image and - // color are set. The set of possible driveThemes can be retrieved from - // a drive.about.get response. When not specified on a - // drive.drives.create request, a random theme is chosen from which the - // background image and color are set. This is a write-only field; it - // can only be set on requests that don't set colorRgb or - // backgroundImageFile. + // color will be set. The set of possible `driveThemes` can be retrieved + // from a `drive.about.get` response. When not specified on a + // `drive.drives.create` request, a random theme is chosen from which + // the background image and color are set. This is a write-only field; + // it can only be set on requests that don't set `colorRgb` or + // `backgroundImageFile`. ThemeId string `json:"themeId,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -938,9 +941,9 @@ func (s *Drive) MarshalJSON() ([]byte, error) { // DriveBackgroundImageFile: An image file and cropping parameters from // which a background image for this shared drive is set. This is a -// write-only field; it can only be set on drive.drives.update requests -// that don't set themeId. When specified, all fields of the -// backgroundImageFile must be set. +// write only field; it can only be set on `drive.drives.update` +// requests that don't set `themeId`. When specified, all fields of the +// `backgroundImageFile` must be set. type DriveBackgroundImageFile struct { // Id: The ID of an image file in Google Drive to use for the background // image. @@ -1008,90 +1011,93 @@ func (s *DriveBackgroundImageFile) UnmarshalJSON(data []byte) error { return nil } -// DriveCapabilities: Capabilities the current user has on this shared -// drive. +// DriveCapabilities: Output only. Capabilities the current user has on +// this shared drive. type DriveCapabilities struct { - // CanAddChildren: Whether the current user can add children to folders - // in this shared drive. + // CanAddChildren: Output only. Whether the current user can add + // children to folders in this shared drive. CanAddChildren bool `json:"canAddChildren,omitempty"` - // CanChangeCopyRequiresWriterPermissionRestriction: Whether the current - // user can change the copyRequiresWriterPermission restriction of this - // shared drive. + // CanChangeCopyRequiresWriterPermissionRestriction: Output only. + // Whether the current user can change the + // `copyRequiresWriterPermission` restriction of this shared drive. CanChangeCopyRequiresWriterPermissionRestriction bool `json:"canChangeCopyRequiresWriterPermissionRestriction,omitempty"` - // CanChangeDomainUsersOnlyRestriction: Whether the current user can - // change the domainUsersOnly restriction of this shared drive. + // CanChangeDomainUsersOnlyRestriction: Output only. Whether the current + // user can change the `domainUsersOnly` restriction of this shared + // drive. CanChangeDomainUsersOnlyRestriction bool `json:"canChangeDomainUsersOnlyRestriction,omitempty"` - // CanChangeDriveBackground: Whether the current user can change the - // background of this shared drive. + // CanChangeDriveBackground: Output only. Whether the current user can + // change the background of this shared drive. CanChangeDriveBackground bool `json:"canChangeDriveBackground,omitempty"` - // CanChangeDriveMembersOnlyRestriction: Whether the current user can - // change the driveMembersOnly restriction of this shared drive. + // CanChangeDriveMembersOnlyRestriction: Output only. Whether the + // current user can change the `driveMembersOnly` restriction of this + // shared drive. CanChangeDriveMembersOnlyRestriction bool `json:"canChangeDriveMembersOnlyRestriction,omitempty"` - // CanChangeSharingFoldersRequiresOrganizerPermissionRestriction: - // Whether the current user can change the - // sharingFoldersRequiresOrganizerPermission restriction of this shared - // drive. + // CanChangeSharingFoldersRequiresOrganizerPermissionRestriction: Output + // only. Whether the current user can change the + // `sharingFoldersRequiresOrganizerPermission` restriction of this + // shared drive. CanChangeSharingFoldersRequiresOrganizerPermissionRestriction bool `json:"canChangeSharingFoldersRequiresOrganizerPermissionRestriction,omitempty"` - // CanComment: Whether the current user can comment on files in this - // shared drive. + // CanComment: Output only. Whether the current user can comment on + // files in this shared drive. CanComment bool `json:"canComment,omitempty"` - // CanCopy: Whether the current user can copy files in this shared - // drive. + // CanCopy: Output only. Whether the current user can copy files in this + // shared drive. CanCopy bool `json:"canCopy,omitempty"` - // CanDeleteChildren: Whether the current user can delete children from - // folders in this shared drive. + // CanDeleteChildren: Output only. Whether the current user can delete + // children from folders in this shared drive. CanDeleteChildren bool `json:"canDeleteChildren,omitempty"` - // CanDeleteDrive: Whether the current user can delete this shared - // drive. Attempting to delete the shared drive may still fail if there - // are untrashed items inside the shared drive. + // CanDeleteDrive: Output only. Whether the current user can delete this + // shared drive. Attempting to delete the shared drive may still fail if + // there are untrashed items inside the shared drive. CanDeleteDrive bool `json:"canDeleteDrive,omitempty"` - // CanDownload: Whether the current user can download files in this - // shared drive. + // CanDownload: Output only. Whether the current user can download files + // in this shared drive. CanDownload bool `json:"canDownload,omitempty"` - // CanEdit: Whether the current user can edit files in this shared drive + // CanEdit: Output only. Whether the current user can edit files in this + // shared drive CanEdit bool `json:"canEdit,omitempty"` - // CanListChildren: Whether the current user can list the children of - // folders in this shared drive. + // CanListChildren: Output only. Whether the current user can list the + // children of folders in this shared drive. CanListChildren bool `json:"canListChildren,omitempty"` - // CanManageMembers: Whether the current user can add members to this - // shared drive or remove them or change their role. + // CanManageMembers: Output only. Whether the current user can add + // members to this shared drive or remove them or change their role. CanManageMembers bool `json:"canManageMembers,omitempty"` - // CanReadRevisions: Whether the current user can read the revisions - // resource of files in this shared drive. + // CanReadRevisions: Output only. Whether the current user can read the + // revisions resource of files in this shared drive. CanReadRevisions bool `json:"canReadRevisions,omitempty"` - // CanRename: Whether the current user can rename files or folders in - // this shared drive. + // CanRename: Output only. Whether the current user can rename files or + // folders in this shared drive. CanRename bool `json:"canRename,omitempty"` - // CanRenameDrive: Whether the current user can rename this shared - // drive. + // CanRenameDrive: Output only. Whether the current user can rename this + // shared drive. CanRenameDrive bool `json:"canRenameDrive,omitempty"` - // CanResetDriveRestrictions: Whether the current user can reset the - // shared drive restrictions to defaults. + // CanResetDriveRestrictions: Output only. Whether the current user can + // reset the shared drive restrictions to defaults. CanResetDriveRestrictions bool `json:"canResetDriveRestrictions,omitempty"` - // CanShare: Whether the current user can share files or folders in this - // shared drive. + // CanShare: Output only. Whether the current user can share files or + // folders in this shared drive. CanShare bool `json:"canShare,omitempty"` - // CanTrashChildren: Whether the current user can trash children from - // folders in this shared drive. + // CanTrashChildren: Output only. Whether the current user can trash + // children from folders in this shared drive. CanTrashChildren bool `json:"canTrashChildren,omitempty"` // ForceSendFields is a list of field names (e.g. "CanAddChildren") to @@ -1127,9 +1133,9 @@ type DriveRestrictions struct { // CopyRequiresWriterPermission: Whether the options to copy, print, or // download files inside this shared drive, should be disabled for - // readers and commenters. When this restriction is set to true, it will - // override the similarly named field to true for any file inside this - // shared drive. + // readers and commenters. When this restriction is set to `true`, it + // will override the similarly named field to `true` for any file inside + // this shared drive. CopyRequiresWriterPermission bool `json:"copyRequiresWriterPermission,omitempty"` // DomainUsersOnly: Whether access to this shared drive and items inside @@ -1218,17 +1224,18 @@ func (s *DriveList) MarshalJSON() ([]byte, error) { // File: The metadata for a file. type File struct { - // AppProperties: A collection of arbitrary key-value pairs that are + // AppProperties: A collection of arbitrary key-value pairs which are // private to the requesting app. // Entries 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 - // an OAuth 2 client ID. You cannot use an API key to retrieve private + // a OAuth 2 client ID. You cannot use an API key to retrieve private // properties. AppProperties map[string]string `json:"appProperties,omitempty"` - // Capabilities: Capabilities the current user has on this file. Each - // capability corresponds to a fine-grained action that a user can take. + // Capabilities: Output only. Capabilities the current user has on this + // file. Each capability corresponds to a fine-grained action that a + // user may take. Capabilities *FileCapabilities `json:"capabilities,omitempty"` // ContentHints: Additional information about the content of the file. @@ -1250,256 +1257,258 @@ type File struct { // Description: A short description of the file. Description string `json:"description,omitempty"` - // DriveId: ID of the shared drive the file resides in. Only populated - // for items in shared drives. + // DriveId: Output only. ID of the shared drive the file resides in. + // Only populated for items in shared drives. DriveId string `json:"driveId,omitempty"` - // ExplicitlyTrashed: Whether the file has been explicitly trashed, as - // opposed to recursively trashed from a parent folder. + // ExplicitlyTrashed: Output only. Whether the file has been explicitly + // trashed, as opposed to recursively trashed from a parent folder. ExplicitlyTrashed bool `json:"explicitlyTrashed,omitempty"` - // ExportLinks: Links for exporting Docs Editors files to specific - // formats. + // ExportLinks: Output only. Links for exporting Docs Editors files to + // specific formats. ExportLinks map[string]string `json:"exportLinks,omitempty"` - // FileExtension: The final component of fullFileExtension. This is only - // available for files with binary content in Google Drive. + // FileExtension: Output only. The final component of + // `fullFileExtension`. This is only available for files with binary + // content in Google Drive. FileExtension string `json:"fileExtension,omitempty"` - // FolderColorRgb: The color for a folder or shortcut to a folder as an - // RGB hex string. The supported colors are published in the - // folderColorPalette field of the About resource. - // If an unsupported color is specified, the closest color in the - // palette will be used instead. + // FolderColorRgb: The color for a folder or a shortcut to a folder as + // an RGB hex string. The supported colors are published in the + // `folderColorPalette` field of the About resource. If an unsupported + // color is specified, the closest color in the palette is used instead. FolderColorRgb string `json:"folderColorRgb,omitempty"` - // FullFileExtension: The full file extension extracted from the name - // field. Can contain multiple concatenated extensions, such as - // "tar.gz". This is only available for files with binary content in - // Google Drive. - // This is automatically updated when the name field changes, however - // it's not cleared if the new name does not contain a valid extension. + // FullFileExtension: Output only. The full file extension extracted + // from the `name` field. May contain multiple concatenated extensions, + // such as "tar.gz". This is only available for files with binary + // content in Google Drive. This is automatically updated when the + // `name` field changes, however it is not cleared if the new name does + // not contain a valid extension. FullFileExtension string `json:"fullFileExtension,omitempty"` - // HasAugmentedPermissions: Whether there are permissions directly on - // this file. This field is only populated for items in shared drives. + // HasAugmentedPermissions: Output only. Whether there are permissions + // directly on this file. This field is only populated for items in + // shared drives. HasAugmentedPermissions bool `json:"hasAugmentedPermissions,omitempty"` - // HasThumbnail: Whether this file has a thumbnail. This does not - // indicate whether the requesting app has access to the thumbnail. To - // check access, look for the presence of the thumbnailLink field. + // HasThumbnail: Output only. Whether this file has a thumbnail. This + // does not indicate whether the requesting app has access to the + // thumbnail. To check access, look for the presence of the + // thumbnailLink field. HasThumbnail bool `json:"hasThumbnail,omitempty"` - // HeadRevisionId: The ID of the file's head revision. This is only - // available for files with binary content in Google Drive. + // HeadRevisionId: Output only. The ID of the file's head revision. This + // is currently only available for files with binary content in Google + // Drive. HeadRevisionId string `json:"headRevisionId,omitempty"` - // IconLink: A static, unauthenticated link to the file's icon. + // IconLink: Output only. A static, unauthenticated link to the file's + // icon. IconLink string `json:"iconLink,omitempty"` // Id: The ID of the file. Id string `json:"id,omitempty"` - // ImageMediaMetadata: Additional metadata about image media, if - // available. + // ImageMediaMetadata: Output only. Additional metadata about image + // media, if available. ImageMediaMetadata *FileImageMediaMetadata `json:"imageMediaMetadata,omitempty"` - // IsAppAuthorized: Whether the requesting app created or opened the - // file. + // IsAppAuthorized: Output only. Whether the file was created or opened + // by the requesting app. IsAppAuthorized bool `json:"isAppAuthorized,omitempty"` - // Kind: Identifies what kind of resource this is. Value: the fixed - // string "drive#file". + // Kind: Output only. Identifies what kind of resource this is. Value: + // the fixed string "drive#file". Kind string `json:"kind,omitempty"` - // LabelInfo: An overview of the labels on the file. + // LabelInfo: Output only. An overview of the labels on the file. LabelInfo *FileLabelInfo `json:"labelInfo,omitempty"` - // LastModifyingUser: The last user to modify the file. + // LastModifyingUser: Output only. The last user to modify the file. LastModifyingUser *User `json:"lastModifyingUser,omitempty"` // LinkShareMetadata: Contains details about the link URLs that clients // are using to refer to this item. LinkShareMetadata *FileLinkShareMetadata `json:"linkShareMetadata,omitempty"` - // Md5Checksum: The MD5 checksum for the content of the file. This is - // only applicable to files with binary content in Google Drive. + // Md5Checksum: Output only. The MD5 checksum for the content of the + // file. This is only applicable to files with binary content in Google + // Drive. Md5Checksum string `json:"md5Checksum,omitempty"` - // MimeType: The MIME type of the file. - // Google Drive will attempt to automatically detect an appropriate - // value from uploaded content if no value is provided. The value cannot - // be changed unless a new revision is uploaded. - // If a file is created with a Google Doc MIME type, the uploaded - // content will be imported if possible. The supported import formats - // are published in the About resource. + // MimeType: The MIME type of the file. Google Drive attempts to + // automatically detect an appropriate value from uploaded content, if + // no value is provided. The value cannot be changed unless a new + // revision is uploaded. If a file is created with a Google Doc MIME + // type, the uploaded content is imported, if possible. The supported + // import formats are published in the About resource. MimeType string `json:"mimeType,omitempty"` - // ModifiedByMe: Whether this user has modified the file. + // ModifiedByMe: Output only. Whether the file has been modified by this + // user. ModifiedByMe bool `json:"modifiedByMe,omitempty"` - // ModifiedByMeTime: The last time the user modified the file (RFC 3339 - // date-time). + // ModifiedByMeTime: The last time the file was modified by the user + // (RFC 3339 date-time). ModifiedByMeTime string `json:"modifiedByMeTime,omitempty"` - // ModifiedTime: The last time anyone modified the file (RFC 3339 - // date-time). - // Note that setting modifiedTime will also update modifiedByMeTime for - // the user. + // ModifiedTime: he last time the file was modified by anyone (RFC 3339 + // date-time). Note that setting modifiedTime will also update + // modifiedByMeTime for the user. ModifiedTime string `json:"modifiedTime,omitempty"` - // Name: The name of the file. This isn't necessarily unique within a - // folder. Note that for immutable items such as the top-level folders + // Name: The name of the file. This is not necessarily unique within a + // folder. Note that for immutable items such as the top level folders // of shared drives, My Drive root folder, and Application Data folder // the name is constant. Name string `json:"name,omitempty"` // OriginalFilename: The original filename of the uploaded content if - // available, or else the original value of the name field. This is only - // available for files with binary content in Google Drive. + // available, or else the original value of the `name` field. This is + // only available for files with binary content in Google Drive. OriginalFilename string `json:"originalFilename,omitempty"` - // OwnedByMe: Whether the user owns the file. Not populated for items in - // shared drives. + // OwnedByMe: Output only. Whether the user owns the file. Not populated + // for items in shared drives. OwnedByMe bool `json:"ownedByMe,omitempty"` - // Owners: The owner of this file. Only certain legacy files might have - // more than one owner. This field isn't populated for items in shared - // drives. + // Owners: Output only. The owner of this file. Only certain legacy + // files may have more than one owner. This field isn't populated for + // items in shared drives. Owners []*User `json:"owners,omitempty"` - // Parents: The IDs of the parent folders that contain the file. - // If not specified as part of a create request, the file will be placed - // directly in the user's My Drive folder. If not specified as part of a - // copy request, the file will inherit any discoverable parents of the - // source file. Update requests must use the addParents and - // removeParents parameters to modify the parents list. + // Parents: The IDs of the parent folders which contain the file. If not + // specified as part of a create request, the file is placed directly in + // the user's My Drive folder. If not specified as part of a copy + // request, the file inherits any discoverable parents of the source + // file. Update requests must use the `addParents` and `removeParents` + // parameters to modify the parents list. Parents []string `json:"parents,omitempty"` - // PermissionIds: List of permission IDs for users with access to this - // file. + // PermissionIds: Output only. List of permission IDs for users with + // access to this file. PermissionIds []string `json:"permissionIds,omitempty"` - // Permissions: The full list of permissions for the file. This is only - // available if the requesting user can share the file. Not populated - // for items in shared drives. + // Permissions: Output only. The full list of permissions for the file. + // This is only available if the requesting user can share the file. Not + // populated for items in shared drives. Permissions []*Permission `json:"permissions,omitempty"` - // Properties: A collection of arbitrary key-value pairs that are + // Properties: A collection of arbitrary key-value pairs which are // visible to all apps. // Entries with null values are cleared in update and copy requests. Properties map[string]string `json:"properties,omitempty"` - // QuotaBytesUsed: The number of storage quota bytes used by the file. - // This includes the head revision as well as previous revisions with - // keepForever enabled. + // QuotaBytesUsed: Output only. The number of storage quota bytes used + // by the file. This includes the head revision as well as previous + // revisions with `keepForever` enabled. QuotaBytesUsed int64 `json:"quotaBytesUsed,omitempty,string"` - // ResourceKey: A key needed to access the item via a shared link. + // ResourceKey: Output only. A key needed to access the item via a + // shared link. ResourceKey string `json:"resourceKey,omitempty"` - // Sha1Checksum: The SHA1 checksum associated with this file, if - // available. This field is only populated for files with content stored - // in Google Drive; it's not populated for Docs Editors or shortcut - // files. + // Sha1Checksum: Output only. The SHA1 checksum associated with this + // file, if available. This field is only populated for files with + // content stored in Google Drive; it is not populated for Docs Editors + // or shortcut files. Sha1Checksum string `json:"sha1Checksum,omitempty"` - // Sha256Checksum: The SHA256 checksum associated with this file, if - // available. This field is only populated for files with content stored - // in Google Drive; it's not populated for Docs Editors or shortcut - // files. + // Sha256Checksum: Output only. The SHA256 checksum associated with this + // file, if available. This field is only populated for files with + // content stored in Google Drive; it is not populated for Docs Editors + // or shortcut files. Sha256Checksum string `json:"sha256Checksum,omitempty"` - // Shared: Whether the file has been shared. Not populated for items in - // shared drives. + // Shared: Output only. Whether the file has been shared. Not populated + // for items in shared drives. Shared bool `json:"shared,omitempty"` // SharedWithMeTime: The time at which the file was shared with the // user, if applicable (RFC 3339 date-time). SharedWithMeTime string `json:"sharedWithMeTime,omitempty"` - // SharingUser: The user who shared the file with the requesting user, - // if applicable. + // SharingUser: Output only. The user who shared the file with the + // requesting user, if applicable. SharingUser *User `json:"sharingUser,omitempty"` // ShortcutDetails: Shortcut file details. Only populated for shortcut // files, which have the mimeType field set to - // application/vnd.google-apps.shortcut. + // `application/vnd.google-apps.shortcut`. ShortcutDetails *FileShortcutDetails `json:"shortcutDetails,omitempty"` - // Size: The size of the file's content in bytes. This field is - // populated for files with binary content stored in Google Drive and - // for Docs Editors files; it's not populated for shortcuts or folders. + // Size: Output only. Size in bytes of blobs and first party editor + // files. Won't be populated for files that have no size, like shortcuts + // and folders. Size int64 `json:"size,omitempty,string"` - // Spaces: The list of spaces that contain the file. The currently - // supported values are 'drive', 'appDataFolder' and 'photos'. + // Spaces: Output only. The list of spaces which contain the file. The + // currently supported values are 'drive', 'appDataFolder' and 'photos'. Spaces []string `json:"spaces,omitempty"` // Starred: Whether the user has starred the file. Starred bool `json:"starred,omitempty"` - // TeamDriveId: Deprecated - use driveId instead. + // TeamDriveId: Deprecated: Output only. Use `driveId` instead. TeamDriveId string `json:"teamDriveId,omitempty"` - // ThumbnailLink: 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. + // ThumbnailLink: Output only. 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. ThumbnailLink string `json:"thumbnailLink,omitempty"` - // ThumbnailVersion: The thumbnail version for use in thumbnail cache - // invalidation. + // ThumbnailVersion: Output only. The thumbnail version for use in + // thumbnail cache invalidation. ThumbnailVersion int64 `json:"thumbnailVersion,omitempty,string"` // Trashed: Whether the file has been trashed, either explicitly or from - // a trashed parent folder. Only the owner can trash a file. The trashed - // item is excluded from all files.list responses returned for any user - // who does not own the file. However, all users with access to the file - // can see the trashed item metadata in an API response. All users with - // access can copy, download, export, and share the file. + // a trashed parent folder. Only the owner may trash a file, and other + // users cannot see files in the owner's trash. Trashed bool `json:"trashed,omitempty"` // TrashedTime: The time that the item was trashed (RFC 3339 date-time). // Only populated for items in shared drives. TrashedTime string `json:"trashedTime,omitempty"` - // TrashingUser: If the file has been explicitly trashed, the user who - // trashed it. Only populated for items in shared drives. + // TrashingUser: Output only. If the file has been explicitly trashed, + // the user who trashed it. Only populated for items in shared drives. TrashingUser *User `json:"trashingUser,omitempty"` - // Version: A monotonically increasing version number for the file. This - // reflects every change made to the file on the server, even those not - // visible to the user. + // Version: Output only. A monotonically increasing version number for + // the file. This reflects every change made to the file on the server, + // even those not visible to the user. Version int64 `json:"version,omitempty,string"` - // VideoMediaMetadata: Additional metadata about video media. This might - // not be available immediately upon upload. + // VideoMediaMetadata: Output only. Additional metadata about video + // media. This may not be available immediately upon upload. VideoMediaMetadata *FileVideoMediaMetadata `json:"videoMediaMetadata,omitempty"` - // ViewedByMe: Whether this user has viewed the file. + // ViewedByMe: Output only. Whether the file has been viewed by this + // user. ViewedByMe bool `json:"viewedByMe,omitempty"` - // ViewedByMeTime: The last time the user viewed the file (RFC 3339 - // date-time). + // ViewedByMeTime: The last time the file was viewed by the user (RFC + // 3339 date-time). ViewedByMeTime string `json:"viewedByMeTime,omitempty"` - // ViewersCanCopyContent: Deprecated - use copyRequiresWriterPermission + // ViewersCanCopyContent: Deprecated: Use `copyRequiresWriterPermission` // instead. ViewersCanCopyContent bool `json:"viewersCanCopyContent,omitempty"` - // WebContentLink: A link for downloading the content of the file in a - // browser. This is only available for files with binary content in - // Google Drive. + // WebContentLink: Output only. A link for downloading the content of + // the file in a browser. This is only available for files with binary + // content in Google Drive. WebContentLink string `json:"webContentLink,omitempty"` - // WebViewLink: A link for opening the file in a relevant Google editor - // or viewer in a browser. + // WebViewLink: Output only. A link for opening the file in a relevant + // Google editor or viewer in a browser. WebViewLink string `json:"webViewLink,omitempty"` - // WritersCanShare: Whether users with only writer permission can modify - // the file's permissions. Not populated for items in shared drives. + // WritersCanShare: Whether users with only `writer` permission can + // modify the file's permissions. Not populated for items in shared + // drives. WritersCanShare bool `json:"writersCanShare,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1529,174 +1538,186 @@ func (s *File) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// FileCapabilities: Capabilities the current user has on this file. -// Each capability corresponds to a fine-grained action that a user can -// take. +// FileCapabilities: Output only. Capabilities the current user has on +// this file. Each capability corresponds to a fine-grained action that +// a user may take. type FileCapabilities struct { - // CanAcceptOwnership: Whether the current user is the pending owner of - // the file. Not populated for shared drive files. + // CanAcceptOwnership: Output only. Whether the current user is the + // pending owner of the file. Not populated for shared drive files. CanAcceptOwnership bool `json:"canAcceptOwnership,omitempty"` - // CanAddChildren: Whether the current user can add children to this - // folder. This is always false when the item isn't a folder. + // CanAddChildren: Output only. Whether the current user can add + // children to this folder. This is always false when the item is not a + // folder. CanAddChildren bool `json:"canAddChildren,omitempty"` - // CanAddFolderFromAnotherDrive: Whether the current user can add a - // folder from another drive (different shared drive or My Drive) to - // this folder. This is false when the item isn't a folder. Only - // populated for items in shared drives. + // CanAddFolderFromAnotherDrive: Output only. Whether the current user + // can add a folder from another drive (different shared drive or My + // Drive) to this folder. This is false when the item is not a folder. + // Only populated for items in shared drives. CanAddFolderFromAnotherDrive bool `json:"canAddFolderFromAnotherDrive,omitempty"` - // CanAddMyDriveParent: Whether the current user can add a parent for - // the item without removing an existing parent in the same request. Not - // populated for shared drive files. + // CanAddMyDriveParent: Output only. Whether the current user can add a + // parent for the item without removing an existing parent in the same + // request. Not populated for shared drive files. CanAddMyDriveParent bool `json:"canAddMyDriveParent,omitempty"` - // CanChangeCopyRequiresWriterPermission: Whether the current user can - // change the copyRequiresWriterPermission restriction of this file. + // CanChangeCopyRequiresWriterPermission: Output only. Whether the + // current user can change the `copyRequiresWriterPermission` + // restriction of this file. CanChangeCopyRequiresWriterPermission bool `json:"canChangeCopyRequiresWriterPermission,omitempty"` - // CanChangeSecurityUpdateEnabled: Whether the current user can change - // the securityUpdateEnabled field on link share metadata. + // CanChangeSecurityUpdateEnabled: Output only. Whether the current user + // can change the securityUpdateEnabled field on link share metadata. CanChangeSecurityUpdateEnabled bool `json:"canChangeSecurityUpdateEnabled,omitempty"` - // CanChangeViewersCanCopyContent: Deprecated + // CanChangeViewersCanCopyContent: Deprecated: Output only. CanChangeViewersCanCopyContent bool `json:"canChangeViewersCanCopyContent,omitempty"` - // CanComment: Whether the current user can comment on this file. + // CanComment: Output only. Whether the current user can comment on this + // file. CanComment bool `json:"canComment,omitempty"` - // CanCopy: Whether the current user can copy this file. For an item in - // a shared drive, whether the current user can copy non-folder - // descendants of this item, or this item itself if it's not a folder. + // CanCopy: Output only. Whether the current user can copy this file. + // For an item in a shared drive, whether the current user can copy + // non-folder descendants of this item, or this item itself if it is not + // a folder. CanCopy bool `json:"canCopy,omitempty"` - // CanDelete: Whether the current user can delete this file. + // CanDelete: Output only. Whether the current user can delete this + // file. CanDelete bool `json:"canDelete,omitempty"` - // CanDeleteChildren: Whether the current user can delete children of - // this folder. This is false when the item isn't a folder. Only - // populated for items in shared drives. + // CanDeleteChildren: Output only. Whether the current user can delete + // children of this folder. This is false when the item is not a folder. + // Only populated for items in shared drives. CanDeleteChildren bool `json:"canDeleteChildren,omitempty"` - // CanDownload: Whether the current user can download this file. + // CanDownload: Output only. Whether the current user can download this + // file. CanDownload bool `json:"canDownload,omitempty"` - // CanEdit: Whether the current user can edit this file. Other factors - // might limit the type of changes a user can make to a file. For - // example, see canChangeCopyRequiresWriterPermission or - // canModifyContent. + // CanEdit: Output only. Whether the current user can edit this file. + // Other factors may limit the type of changes a user can make to a + // file. For example, see `canChangeCopyRequiresWriterPermission` or + // `canModifyContent`. CanEdit bool `json:"canEdit,omitempty"` - // CanListChildren: Whether the current user can list the children of - // this folder. This is always false when the item isn't a folder. + // CanListChildren: Output only. Whether the current user can list the + // children of this folder. This is always false when the item is not a + // folder. CanListChildren bool `json:"canListChildren,omitempty"` - // CanModifyContent: Whether the current user can modify the content of - // this file. + // CanModifyContent: Output only. Whether the current user can modify + // the content of this file. CanModifyContent bool `json:"canModifyContent,omitempty"` - // CanModifyContentRestriction: Whether the current user can modify - // restrictions on content of this file. + // CanModifyContentRestriction: Output only. Whether the current user + // can modify restrictions on content of this file. CanModifyContentRestriction bool `json:"canModifyContentRestriction,omitempty"` - // CanModifyLabels: Whether the current user can modify the labels on - // this file. + // CanModifyLabels: Output only. Whether the current user can modify the + // labels on the file. CanModifyLabels bool `json:"canModifyLabels,omitempty"` - // CanMoveChildrenOutOfDrive: Whether the current user can move children - // of this folder outside of the shared drive. This is false when the - // item isn't a folder. Only populated for items in shared drives. + // CanMoveChildrenOutOfDrive: Output only. Whether the current user can + // move children of this folder outside of the shared drive. This is + // false when the item is not a folder. Only populated for items in + // shared drives. CanMoveChildrenOutOfDrive bool `json:"canMoveChildrenOutOfDrive,omitempty"` - // CanMoveChildrenOutOfTeamDrive: Deprecated - use - // canMoveChildrenOutOfDrive instead. + // CanMoveChildrenOutOfTeamDrive: Deprecated: Output only. Use + // `canMoveChildrenOutOfDrive` instead. CanMoveChildrenOutOfTeamDrive bool `json:"canMoveChildrenOutOfTeamDrive,omitempty"` - // CanMoveChildrenWithinDrive: Whether the current user can move - // children of this folder within this shared drive or My Drive. This is - // false when the item isn't a folder. Note that a request to move the - // child might still fail depending on the current user's access to the - // child and to the destination folder. + // CanMoveChildrenWithinDrive: Output only. Whether the current user can + // move children of this folder within this drive. This is false when + // the item is not a folder. Note that a request to move the child may + // still fail depending on the current user's access to the child and to + // the destination folder. CanMoveChildrenWithinDrive bool `json:"canMoveChildrenWithinDrive,omitempty"` - // CanMoveChildrenWithinTeamDrive: Deprecated - use - // canMoveChildrenWithinDrive instead. + // CanMoveChildrenWithinTeamDrive: Deprecated: Output only. Use + // `canMoveChildrenWithinDrive` instead. CanMoveChildrenWithinTeamDrive bool `json:"canMoveChildrenWithinTeamDrive,omitempty"` - // CanMoveItemIntoTeamDrive: Deprecated - use canMoveItemOutOfDrive - // instead. + // CanMoveItemIntoTeamDrive: Deprecated: Output only. Use + // `canMoveItemOutOfDrive` instead. CanMoveItemIntoTeamDrive bool `json:"canMoveItemIntoTeamDrive,omitempty"` - // CanMoveItemOutOfDrive: Whether the current user can move this item - // outside of this shared drive or My Drive by changing its parent. Note - // that a request to change the parent of the item might still fail - // depending on the new parent that's being added. + // CanMoveItemOutOfDrive: Output only. Whether the current user can move + // this item outside of this drive by changing its parent. Note that a + // request to change the parent of the item may still fail depending on + // the new parent that is being added. CanMoveItemOutOfDrive bool `json:"canMoveItemOutOfDrive,omitempty"` - // CanMoveItemOutOfTeamDrive: Deprecated - use canMoveItemOutOfDrive - // instead. + // CanMoveItemOutOfTeamDrive: Deprecated: Output only. Use + // `canMoveItemOutOfDrive` instead. CanMoveItemOutOfTeamDrive bool `json:"canMoveItemOutOfTeamDrive,omitempty"` - // CanMoveItemWithinDrive: Whether the current user can move this item - // within this shared drive or My Drive. Note that a request to change - // the parent of the item might still fail depending on the new parent - // that's being added and the parent that's being removed. + // CanMoveItemWithinDrive: Output only. Whether the current user can + // move this item within this drive. Note that a request to change the + // parent of the item may still fail depending on the new parent that is + // being added and the parent that is being removed. CanMoveItemWithinDrive bool `json:"canMoveItemWithinDrive,omitempty"` - // CanMoveItemWithinTeamDrive: Deprecated - use canMoveItemWithinDrive - // instead. + // CanMoveItemWithinTeamDrive: Deprecated: Output only. Use + // `canMoveItemWithinDrive` instead. CanMoveItemWithinTeamDrive bool `json:"canMoveItemWithinTeamDrive,omitempty"` - // CanMoveTeamDriveItem: Deprecated - use canMoveItemWithinDrive or - // canMoveItemOutOfDrive instead. + // CanMoveTeamDriveItem: Deprecated: Output only. Use + // `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. CanMoveTeamDriveItem bool `json:"canMoveTeamDriveItem,omitempty"` - // CanReadDrive: Whether the current user can read the shared drive to - // which this file belongs. Only populated for items in shared drives. + // CanReadDrive: Output only. Whether the current user can read the + // shared drive to which this file belongs. Only populated for items in + // shared drives. CanReadDrive bool `json:"canReadDrive,omitempty"` - // CanReadLabels: Whether the current user can read the labels on this - // file. + // CanReadLabels: Output only. Whether the current user can read the + // labels on the file. CanReadLabels bool `json:"canReadLabels,omitempty"` - // CanReadRevisions: Whether the current user can read the revisions - // resource of this file. For a shared drive item, whether revisions of - // non-folder descendants of this item, or this item itself if it's not - // a folder, can be read. + // CanReadRevisions: Output only. Whether the current user can read the + // revisions resource of this file. For a shared drive item, whether + // revisions of non-folder descendants of this item, or this item itself + // if it is not a folder, can be read. CanReadRevisions bool `json:"canReadRevisions,omitempty"` - // CanReadTeamDrive: Deprecated - use canReadDrive instead. + // CanReadTeamDrive: Deprecated: Output only. Use `canReadDrive` + // instead. CanReadTeamDrive bool `json:"canReadTeamDrive,omitempty"` - // CanRemoveChildren: Whether the current user can remove children from - // this folder. This is always false when the item isn't a folder. For a - // folder in a shared drive, use canDeleteChildren or canTrashChildren - // instead. + // CanRemoveChildren: Output only. Whether the current user can remove + // children from this folder. This is always false when the item is not + // a folder. For a folder in a shared drive, use `canDeleteChildren` or + // `canTrashChildren` instead. CanRemoveChildren bool `json:"canRemoveChildren,omitempty"` - // CanRemoveMyDriveParent: Whether the current user can remove a parent - // from the item without adding another parent in the same request. Not - // populated for shared drive files. + // CanRemoveMyDriveParent: Output only. Whether the current user can + // remove a parent from the item without adding another parent in the + // same request. Not populated for shared drive files. CanRemoveMyDriveParent bool `json:"canRemoveMyDriveParent,omitempty"` - // CanRename: Whether the current user can rename this file. + // CanRename: Output only. Whether the current user can rename this + // file. CanRename bool `json:"canRename,omitempty"` - // CanShare: Whether the current user can modify the sharing settings - // for this file. + // CanShare: Output only. Whether the current user can modify the + // sharing settings for this file. CanShare bool `json:"canShare,omitempty"` - // CanTrash: Whether the current user can move this file to trash. + // CanTrash: Output only. Whether the current user can move this file to + // trash. CanTrash bool `json:"canTrash,omitempty"` - // CanTrashChildren: Whether the current user can trash children of this - // folder. This is false when the item isn't a folder. Only populated - // for items in shared drives. + // CanTrashChildren: Output only. Whether the current user can trash + // children of this folder. This is false when the item is not a folder. + // Only populated for items in shared drives. CanTrashChildren bool `json:"canTrashChildren,omitempty"` - // CanUntrash: Whether the current user can restore this file from - // trash. + // CanUntrash: Output only. Whether the current user can restore this + // file from trash. CanUntrash bool `json:"canUntrash,omitempty"` // ForceSendFields is a list of field names (e.g. "CanAcceptOwnership") @@ -1727,8 +1748,8 @@ func (s *FileCapabilities) MarshalJSON() ([]byte, error) { // file. These fields are never populated in responses. type FileContentHints struct { // IndexableText: Text to be indexed for the file to improve fullText - // queries. This is limited to 128 KB in length and might contain HTML - // elements. For more information, see Manage file metadata. + // queries. This is limited to 128KB in length and may contain HTML + // elements. IndexableText string `json:"indexableText,omitempty"` // Thumbnail: A thumbnail for the file. This will only be used if Google @@ -1791,73 +1812,83 @@ func (s *FileContentHintsThumbnail) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// FileImageMediaMetadata: Additional metadata about image media, if -// available. +// FileImageMediaMetadata: Output only. Additional metadata about image +// media, if available. type FileImageMediaMetadata struct { - // Aperture: The aperture used to create the photo (f-number). + // Aperture: Output only. The aperture used to create the photo + // (f-number). Aperture float64 `json:"aperture,omitempty"` - // CameraMake: The make of the camera used to create the photo. + // CameraMake: Output only. The make of the camera used to create the + // photo. CameraMake string `json:"cameraMake,omitempty"` - // CameraModel: The model of the camera used to create the photo. + // CameraModel: Output only. The model of the camera used to create the + // photo. CameraModel string `json:"cameraModel,omitempty"` - // ColorSpace: The color space of the photo. + // ColorSpace: Output only. The color space of the photo. ColorSpace string `json:"colorSpace,omitempty"` - // ExposureBias: The exposure bias of the photo (APEX value). + // ExposureBias: Output only. The exposure bias of the photo (APEX + // value). ExposureBias float64 `json:"exposureBias,omitempty"` - // ExposureMode: The exposure mode used to create the photo. + // ExposureMode: Output only. The exposure mode used to create the + // photo. ExposureMode string `json:"exposureMode,omitempty"` - // ExposureTime: The length of the exposure, in seconds. + // ExposureTime: Output only. The length of the exposure, in seconds. ExposureTime float64 `json:"exposureTime,omitempty"` - // FlashUsed: Whether a flash was used to create the photo. + // FlashUsed: Output only. Whether a flash was used to create the photo. FlashUsed bool `json:"flashUsed,omitempty"` - // FocalLength: The focal length used to create the photo, in - // millimeters. + // FocalLength: Output only. The focal length used to create the photo, + // in millimeters. FocalLength float64 `json:"focalLength,omitempty"` - // Height: The height of the image in pixels. + // Height: Output only. The height of the image in pixels. Height int64 `json:"height,omitempty"` - // IsoSpeed: The ISO speed used to create the photo. + // IsoSpeed: Output only. The ISO speed used to create the photo. IsoSpeed int64 `json:"isoSpeed,omitempty"` - // Lens: The lens used to create the photo. + // Lens: Output only. The lens used to create the photo. Lens string `json:"lens,omitempty"` - // Location: Geographic location information stored in the image. + // Location: Output only. Geographic location information stored in the + // image. Location *FileImageMediaMetadataLocation `json:"location,omitempty"` - // MaxApertureValue: The smallest f-number of the lens at the focal - // length used to create the photo (APEX value). + // MaxApertureValue: Output only. The smallest f-number of the lens at + // the focal length used to create the photo (APEX value). MaxApertureValue float64 `json:"maxApertureValue,omitempty"` - // MeteringMode: The metering mode used to create the photo. + // MeteringMode: Output only. The metering mode used to create the + // photo. MeteringMode string `json:"meteringMode,omitempty"` - // Rotation: The number of clockwise 90-degree rotations applied from - // the image's original orientation. + // Rotation: Output only. The number of clockwise 90 degree rotations + // applied from the image's original orientation. Rotation int64 `json:"rotation,omitempty"` - // Sensor: The type of sensor used to create the photo. + // Sensor: Output only. The type of sensor used to create the photo. Sensor string `json:"sensor,omitempty"` - // SubjectDistance: The distance to the subject of the photo, in meters. + // SubjectDistance: Output only. The distance to the subject of the + // photo, in meters. SubjectDistance int64 `json:"subjectDistance,omitempty"` - // Time: The date and time the photo was taken (EXIF DateTime). + // Time: Output only. The date and time the photo was taken (EXIF + // DateTime). Time string `json:"time,omitempty"` - // WhiteBalance: The white balance mode used to create the photo. + // WhiteBalance: Output only. The white balance mode used to create the + // photo. WhiteBalance string `json:"whiteBalance,omitempty"` - // Width: The width of the image in pixels. + // Width: Output only. The width of the image in pixels. Width int64 `json:"width,omitempty"` // ForceSendFields is a list of field names (e.g. "Aperture") to @@ -1905,16 +1936,16 @@ func (s *FileImageMediaMetadata) UnmarshalJSON(data []byte) error { return nil } -// FileImageMediaMetadataLocation: Geographic location information -// stored in the image. +// FileImageMediaMetadataLocation: Output only. Geographic location +// information stored in the image. type FileImageMediaMetadataLocation struct { - // Altitude: The altitude stored in the image. + // Altitude: Output only. The altitude stored in the image. Altitude float64 `json:"altitude,omitempty"` - // Latitude: The latitude stored in the image. + // Latitude: Output only. The latitude stored in the image. Latitude float64 `json:"latitude,omitempty"` - // Longitude: The longitude stored in the image. + // Longitude: Output only. The longitude stored in the image. Longitude float64 `json:"longitude,omitempty"` // ForceSendFields is a list of field names (e.g. "Altitude") to @@ -1958,10 +1989,11 @@ func (s *FileImageMediaMetadataLocation) UnmarshalJSON(data []byte) error { return nil } -// FileLabelInfo: An overview of the labels on the file. +// FileLabelInfo: Output only. An overview of the labels on the file. type FileLabelInfo struct { - // Labels: The set of labels on the file as requested by the label IDs - // in the includeLabels parameter. By default, no labels are returned. + // Labels: Output only. The set of labels on the file as requested by + // the label IDs in the `includeLabels` parameter. By default, no labels + // are returned. Labels []*Label `json:"labels,omitempty"` // ForceSendFields is a list of field names (e.g. "Labels") to @@ -1990,12 +2022,12 @@ func (s *FileLabelInfo) MarshalJSON() ([]byte, error) { // FileLinkShareMetadata: Contains details about the link URLs that // clients are using to refer to this item. type FileLinkShareMetadata struct { - // SecurityUpdateEligible: Whether the file is eligible for security - // update. + // SecurityUpdateEligible: Output only. Whether the file is eligible for + // security update. SecurityUpdateEligible bool `json:"securityUpdateEligible,omitempty"` - // SecurityUpdateEnabled: Whether the security update is enabled for - // this file. + // SecurityUpdateEnabled: Output only. Whether the security update is + // enabled for this file. SecurityUpdateEnabled bool `json:"securityUpdateEnabled,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -2025,17 +2057,17 @@ func (s *FileLinkShareMetadata) MarshalJSON() ([]byte, error) { // FileShortcutDetails: Shortcut file details. Only populated for // shortcut files, which have the mimeType field set to -// application/vnd.google-apps.shortcut. +// `application/vnd.google-apps.shortcut`. type FileShortcutDetails struct { // TargetId: The ID of the file that this shortcut points to. TargetId string `json:"targetId,omitempty"` - // TargetMimeType: The MIME type of the file that this shortcut points - // to. The value of this field is a snapshot of the target's MIME type, - // captured when the shortcut is created. + // TargetMimeType: Output only. The MIME type of the file that this + // shortcut points to. The value of this field is a snapshot of the + // target's MIME type, captured when the shortcut is created. TargetMimeType string `json:"targetMimeType,omitempty"` - // TargetResourceKey: The ResourceKey for the target file. + // TargetResourceKey: Output only. The ResourceKey for the target file. TargetResourceKey string `json:"targetResourceKey,omitempty"` // ForceSendFields is a list of field names (e.g. "TargetId") to @@ -2061,16 +2093,17 @@ func (s *FileShortcutDetails) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// FileVideoMediaMetadata: Additional metadata about video media. This -// might not be available immediately upon upload. +// FileVideoMediaMetadata: Output only. Additional metadata about video +// media. This may not be available immediately upon upload. type FileVideoMediaMetadata struct { - // DurationMillis: The duration of the video in milliseconds. + // DurationMillis: Output only. The duration of the video in + // milliseconds. DurationMillis int64 `json:"durationMillis,omitempty,string"` - // Height: The height of the video in pixels. + // Height: Output only. The height of the video in pixels. Height int64 `json:"height,omitempty"` - // Width: The width of the video in pixels. + // Width: Output only. The width of the video in pixels. Width int64 `json:"width,omitempty"` // ForceSendFields is a list of field names (e.g. "DurationMillis") to @@ -2105,11 +2138,11 @@ type FileList struct { Files []*File `json:"files,omitempty"` // IncompleteSearch: Whether the search process was incomplete. If true, - // then some search results may be missing, since all documents were not - // searched. This may occur when searching multiple drives with the - // "allDrives" corpora, but all corpora could not be searched. When this - // happens, it is suggested that clients narrow their query by choosing - // a different corpus such as "user" or "drive". + // then some search results might be missing, since all documents were + // not searched. This can occur when searching multiple drives with the + // 'allDrives' corpora, but all corpora couldn't be searched. When this + // happens, it's suggested that clients narrow their query by choosing a + // different corpus such as 'user' or 'drive'. IncompleteSearch bool `json:"incompleteSearch,omitempty"` // Kind: Identifies what kind of resource this is. Value: the fixed @@ -2190,9 +2223,9 @@ func (s *GeneratedIds) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Label: Representation of a label and its fields. +// Label: Representation of label and label fields. type Label struct { - // Fields: A map of the label's fields keyed by the field ID. + // Fields: A map of the fields on the label, keyed by the field's ID. Fields map[string]LabelField `json:"fields,omitempty"` // Id: The ID of the label. @@ -2227,37 +2260,33 @@ func (s *Label) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// LabelField: Representation of a label field. +// LabelField: Representation of field, which is a typed key-value pair. type LabelField struct { // DateString: Only present if valueType is dateString. RFC 3339 // formatted date: YYYY-MM-DD. DateString []string `json:"dateString,omitempty"` - // Id: The identifier of this field. + // Id: The identifier of this label field. Id string `json:"id,omitempty"` - // Integer: Only present if valueType is integer. + // Integer: Only present if `valueType` is `integer`. Integer googleapi.Int64s `json:"integer,omitempty"` // Kind: This is always drive#labelField. Kind string `json:"kind,omitempty"` - // Selection: Only present if valueType is selection. + // Selection: Only present if `valueType` is `selection` Selection []string `json:"selection,omitempty"` - // Text: Only present if valueType is text. + // Text: Only present if `valueType` is `text`. Text []string `json:"text,omitempty"` - // User: Only present if valueType is user. + // User: Only present if `valueType` is `user`. User []*User `json:"user,omitempty"` // ValueType: The field type. While new values may be supported in the - // future, the following are currently allowed: - // - dateString - // - integer - // - selection - // - text - // - user + // future, the following are currently allowed: * `dateString` * + // `integer` * `selection` * `text` * `user` ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "DateString") to @@ -2285,26 +2314,29 @@ func (s *LabelField) MarshalJSON() ([]byte, error) { // LabelFieldModification: A modification to a label's field. type LabelFieldModification struct { - // FieldId: The ID of the Field to be modified. + // FieldId: The ID of the field to be modified. FieldId string `json:"fieldId,omitempty"` // Kind: This is always drive#labelFieldModification. Kind string `json:"kind,omitempty"` - // SetDateValues: Replaces a dateString field with these new values. The - // values must be strings in the RFC 3339 full-date format: YYYY-MM-DD. + // SetDateValues: Replaces the value of a dateString Field with these + // new values. The string must be in the RFC 3339 full-date format: + // YYYY-MM-DD. SetDateValues []string `json:"setDateValues,omitempty"` - // SetIntegerValues: Replaces an integer field with these new values. + // SetIntegerValues: Replaces the value of an `integer` field with these + // new values. SetIntegerValues googleapi.Int64s `json:"setIntegerValues,omitempty"` - // SetSelectionValues: Replaces a selection field with these new values. + // SetSelectionValues: Replaces a `selection` field with these new + // values. SetSelectionValues []string `json:"setSelectionValues,omitempty"` - // SetTextValues: Replaces a text field with these new values. + // SetTextValues: Sets the value of a `text` field. SetTextValues []string `json:"setTextValues,omitempty"` - // SetUserValues: Replaces a user field with these new values. The + // SetUserValues: Replaces a `user` field with these new values. The // values must be valid email addresses. SetUserValues []string `json:"setUserValues,omitempty"` @@ -2334,7 +2366,7 @@ func (s *LabelFieldModification) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// LabelList: A list of labels. +// LabelList: A list of labels applied to a file. type LabelList struct { // Kind: This is always drive#labelList Kind string `json:"kind,omitempty"` @@ -2417,9 +2449,9 @@ func (s *LabelModification) MarshalJSON() ([]byte, error) { // ModifyLabelsRequest: A request to modify the set of labels on a file. // This request may contain many modifications that will either all -// succeed or all fail transactionally. +// succeed or all fail atomically. type ModifyLabelsRequest struct { - // Kind: This is always drive#modifyLabelsRequest + // Kind: This is always drive#modifyLabelsRequest. Kind string `json:"kind,omitempty"` // LabelModifications: The list of modifications to apply to the labels @@ -2488,31 +2520,28 @@ func (s *ModifyLabelsResponse) MarshalJSON() ([]byte, error) { } // Permission: A permission for a file. A permission grants a user, -// group, domain, or the world access to a file or a folder hierarchy. +// group, domain or the world access to a file or a folder hierarchy. type Permission struct { // AllowFileDiscovery: Whether the permission allows the file to be // discovered through search. This is only applicable for permissions of - // type domain or anyone. + // type `domain` or `anyone`. AllowFileDiscovery bool `json:"allowFileDiscovery,omitempty"` - // Deleted: Whether the account associated with this permission has been - // deleted. This field only pertains to user and group permissions. + // Deleted: Output only. Whether the account associated with this + // permission has been deleted. This field only pertains to user and + // group permissions. Deleted bool `json:"deleted,omitempty"` - // DisplayName: The "pretty" name of the value of the permission. The - // following is a list of examples for each type of permission: - // - user - User's full name, as defined for their Google Account, such - // as "Joe Smith." - // - group - Name of the Google Group, such as "The Company - // Administrators." - // - domain - String domain name, such as "your-company.com." - // - anyone - No displayName is present. + // DisplayName: Output only. The "pretty" name of the value of the + // permission. The following is a list of examples for each type of + // permission: * `user` - User's full name, as defined for their Google + // account, such as "Joe Smith." * `group` - Name of the Google Group, + // such as "The Company Administrators." * `domain` - String domain + // name, such as "thecompany.com." * `anyone` - No `displayName` is + // present. DisplayName string `json:"displayName,omitempty"` - // Domain: The domain to which this permission refers. The following - // options are currently allowed: - // - The entire domain, such as "your-company.com." - // - A target audience, such as "ID.audience.googledomains.com." + // Domain: The domain to which this permission refers. Domain string `json:"domain,omitempty"` // EmailAddress: The email address of the user or group to which this @@ -2520,62 +2549,53 @@ type Permission struct { EmailAddress string `json:"emailAddress,omitempty"` // ExpirationTime: The time at which this permission will expire (RFC - // 3339 date-time). Expiration times have the following restrictions: - // - // - They cannot be set on shared drive items. - // - They can only be set on user and group permissions. - // - The time must be in the future. - // - The time cannot be more than one year in the future. + // 3339 date-time). Expiration times have the following restrictions: - + // They can only be set on user and group permissions - The time must be + // in the future - The time cannot be more than a year in the future ExpirationTime string `json:"expirationTime,omitempty"` - // Id: The ID of this permission. This is a unique identifier for the - // grantee, and is published in User resources as permissionId. IDs - // should be treated as opaque values. + // Id: Output only. The ID of this permission. This is a unique + // identifier for the grantee, and is published in User resources as + // `permissionId`. IDs should be treated as opaque values. Id string `json:"id,omitempty"` - // Kind: Identifies what kind of resource this is. Value: the fixed - // string "drive#permission". + // Kind: Output only. Identifies what kind of resource this is. Value: + // the fixed string "drive#permission". Kind string `json:"kind,omitempty"` // PendingOwner: Whether the account associated with this permission is - // a pending owner. Only populated for user type permissions for files - // that aren't in a shared drive. + // a pending owner. Only populated for `user` type permissions for files + // that are not in a shared drive. PendingOwner bool `json:"pendingOwner,omitempty"` - // PermissionDetails: Details of whether the permissions on this shared - // drive item are inherited or are directly on this item. This is an - // output-only field that's present only for shared drive items. + // PermissionDetails: Output only. Details of whether the permissions on + // this shared drive item are inherited or directly on this item. This + // is an output-only field which is present only for shared drive items. PermissionDetails []*PermissionPermissionDetails `json:"permissionDetails,omitempty"` - // PhotoLink: A link to the user's profile photo, if available. + // PhotoLink: Output only. A link to the user's profile photo, if + // available. PhotoLink string `json:"photoLink,omitempty"` // Role: The role granted by this permission. While new values may be - // supported in the future, the following are currently allowed: - // - owner - // - organizer - // - fileOrganizer - // - writer - // - commenter - // - reader + // supported in the future, the following are currently allowed: * + // `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * + // `reader` Role string `json:"role,omitempty"` - // TeamDrivePermissionDetails: Deprecated - use permissionDetails - // instead. + // TeamDrivePermissionDetails: Output only. Deprecated: Output only. Use + // `permissionDetails` instead. TeamDrivePermissionDetails []*PermissionTeamDrivePermissionDetails `json:"teamDrivePermissionDetails,omitempty"` - // Type: The type of the grantee. Valid values are: - // - user - // - group - // - domain - // - anyone When creating a permission, if type is user or group, you - // must provide an emailAddress for the user or group. When type is - // domain, you must provide a domain. There isn't extra information - // required for the anyone type. + // Type: The type of the grantee. Valid values are: * `user` * `group` * + // `domain` * `anyone` When creating a permission, if `type` is `user` + // or `group`, you must provide an `emailAddress` for the user or group. + // When `type` is `domain`, you must provide a `domain`. There isn't + // extra information required for an `anyone` type. Type string `json:"type,omitempty"` // View: Indicates the view for this permission. Only populated for - // permissions that belong to a view. published is the only supported + // permissions that belong to a view. 'published' is the only supported // value. View string `json:"view,omitempty"` @@ -2608,27 +2628,22 @@ func (s *Permission) MarshalJSON() ([]byte, error) { } type PermissionPermissionDetails struct { - // Inherited: Whether this permission is inherited. This field is always - // populated. This is an output-only field. + // Inherited: Output only. Whether this permission is inherited. This + // field is always populated. This is an output-only field. Inherited bool `json:"inherited,omitempty"` - // InheritedFrom: The ID of the item from which this permission is - // inherited. This is an output-only field. + // InheritedFrom: Output only. The ID of the item from which this + // permission is inherited. This is an output-only field. InheritedFrom string `json:"inheritedFrom,omitempty"` - // PermissionType: The permission type for this user. While new values - // may be added in future, the following are currently allowed: - // - file - // - member + // PermissionType: Output only. The permission type for this user. While + // new values may be added in future, the following are currently + // possible: * `file` * `member` PermissionType string `json:"permissionType,omitempty"` - // Role: The primary role for this user. While new values may be added - // in the future, the following are currently allowed: - // - organizer - // - fileOrganizer - // - writer - // - commenter - // - reader + // Role: Output only. The primary role for this user. While new values + // may be added in the future, the following are currently possible: * + // `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` Role string `json:"role,omitempty"` // ForceSendFields is a list of field names (e.g. "Inherited") to @@ -2655,18 +2670,19 @@ func (s *PermissionPermissionDetails) MarshalJSON() ([]byte, error) { } type PermissionTeamDrivePermissionDetails struct { - // Inherited: Deprecated - use permissionDetails/inherited instead. + // Inherited: Deprecated: Output only. Use `permissionDetails/inherited` + // instead. Inherited bool `json:"inherited,omitempty"` - // InheritedFrom: Deprecated - use permissionDetails/inheritedFrom - // instead. + // InheritedFrom: Deprecated: Output only. Use + // `permissionDetails/inheritedFrom` instead. InheritedFrom string `json:"inheritedFrom,omitempty"` - // Role: Deprecated - use permissionDetails/role instead. + // Role: Deprecated: Output only. Use `permissionDetails/role` instead. Role string `json:"role,omitempty"` - // TeamDrivePermissionType: Deprecated - use - // permissionDetails/permissionType instead. + // TeamDrivePermissionType: Deprecated: Output only. Use + // `permissionDetails/permissionType` instead. TeamDrivePermissionType string `json:"teamDrivePermissionType,omitempty"` // ForceSendFields is a list of field names (e.g. "Inherited") to @@ -2740,36 +2756,35 @@ func (s *PermissionList) MarshalJSON() ([]byte, error) { // Reply: A reply to a comment on a file. type Reply struct { // Action: The action the reply performed to the parent comment. Valid - // values are: - // - resolve - // - reopen + // values are: * `resolve` * `reopen` Action string `json:"action,omitempty"` - // Author: The author of the reply. The author's email address and - // permission ID will not be populated. + // Author: Output only. The author of the reply. The author's email + // address and permission ID will not be populated. Author *User `json:"author,omitempty"` // Content: The plain text content of the reply. This field is used for - // setting the content, while htmlContent should be displayed. This is - // required on creates if no action is specified. + // setting the content, while `htmlContent` should be displayed. This is + // required on creates if no `action` is specified. Content string `json:"content,omitempty"` // CreatedTime: The time at which the reply was created (RFC 3339 // date-time). CreatedTime string `json:"createdTime,omitempty"` - // Deleted: Whether the reply has been deleted. A deleted reply has no - // content. + // Deleted: Output only. Whether the reply has been deleted. A deleted + // reply has no content. Deleted bool `json:"deleted,omitempty"` - // HtmlContent: The content of the reply with HTML formatting. + // HtmlContent: Output only. The content of the reply with HTML + // formatting. HtmlContent string `json:"htmlContent,omitempty"` - // Id: The ID of the reply. + // Id: Output only. The ID of the reply. Id string `json:"id,omitempty"` - // Kind: Identifies what kind of resource this is. Value: the fixed - // string "drive#reply". + // Kind: Output only. Identifies what kind of resource this is. Value: + // the fixed string "drive#reply". Kind string `json:"kind,omitempty"` // ModifiedTime: The last time the reply was modified (RFC 3339 @@ -2849,40 +2864,42 @@ func (s *ReplyList) MarshalJSON() ([]byte, error) { // Revision: The metadata for a revision to a file. type Revision struct { - // ExportLinks: Links for exporting Docs Editors files to specific - // formats. + // ExportLinks: Output only. Links for exporting Docs Editors files to + // specific formats. ExportLinks map[string]string `json:"exportLinks,omitempty"` - // Id: The ID of the revision. + // Id: Output only. The ID of the revision. Id string `json:"id,omitempty"` // KeepForever: Whether to keep this revision forever, even if it is no // longer the head revision. If not set, the revision will be // automatically purged 30 days after newer content is uploaded. This - // can be set on a maximum of 200 revisions for a file. - // This field is only applicable to files with binary content in Drive. + // can be set on a maximum of 200 revisions for a file. This field is + // only applicable to files with binary content in Drive. KeepForever bool `json:"keepForever,omitempty"` - // Kind: Identifies what kind of resource this is. Value: the fixed - // string "drive#revision". + // Kind: Output only. Identifies what kind of resource this is. Value: + // the fixed string "drive#revision". Kind string `json:"kind,omitempty"` - // LastModifyingUser: The last user to modify this revision. + // LastModifyingUser: Output only. The last user to modify this + // revision. LastModifyingUser *User `json:"lastModifyingUser,omitempty"` - // Md5Checksum: The MD5 checksum of the revision's content. This is only - // applicable to files with binary content in Drive. + // Md5Checksum: Output only. The MD5 checksum of the revision's content. + // This is only applicable to files with binary content in Drive. Md5Checksum string `json:"md5Checksum,omitempty"` - // MimeType: The MIME type of the revision. + // MimeType: Output only. The MIME type of the revision. MimeType string `json:"mimeType,omitempty"` // ModifiedTime: The last time the revision was modified (RFC 3339 // date-time). ModifiedTime string `json:"modifiedTime,omitempty"` - // OriginalFilename: The original filename used to create this revision. - // This is only applicable to files with binary content in Drive. + // OriginalFilename: Output only. The original filename used to create + // this revision. This is only applicable to files with binary content + // in Drive. OriginalFilename string `json:"originalFilename,omitempty"` // PublishAuto: Whether subsequent revisions will be automatically @@ -2893,16 +2910,16 @@ type Revision struct { // applicable to Docs Editors files. Published bool `json:"published,omitempty"` - // PublishedLink: A link to the published revision. This is only - // populated for Google Sites files. + // PublishedLink: Output only. A link to the published revision. This is + // only populated for Google Sites files. PublishedLink string `json:"publishedLink,omitempty"` // PublishedOutsideDomain: Whether this revision is published outside // the domain. This is only applicable to Docs Editors files. PublishedOutsideDomain bool `json:"publishedOutsideDomain,omitempty"` - // Size: The size of the revision's content in bytes. This is only - // applicable to files with binary content in Drive. + // Size: Output only. The size of the revision's content in bytes. This + // is only applicable to files with binary content in Drive. Size int64 `json:"size,omitempty,string"` // ServerResponse contains the HTTP response code and headers from the @@ -3015,9 +3032,9 @@ func (s *StartPageToken) MarshalJSON() ([]byte, error) { type TeamDrive struct { // BackgroundImageFile: An image file and cropping parameters from which // a background image for this Team Drive is set. This is a write only - // field; it can only be set on drive.teamdrives.update requests that - // don't set themeId. When specified, all fields of the - // backgroundImageFile must be set. + // field; it can only be set on `drive.teamdrives.update` requests that + // don't set `themeId`. When specified, all fields of the + // `backgroundImageFile` must be set. BackgroundImageFile *TeamDriveBackgroundImageFile `json:"backgroundImageFile,omitempty"` // BackgroundImageLink: A short-lived link to this Team Drive's @@ -3028,8 +3045,8 @@ type TeamDrive struct { Capabilities *TeamDriveCapabilities `json:"capabilities,omitempty"` // ColorRgb: The color of this Team Drive as an RGB hex string. It can - // only be set on a drive.teamdrives.update request that does not set - // themeId. + // only be set on a `drive.teamdrives.update` request that does not set + // `themeId`. ColorRgb string `json:"colorRgb,omitempty"` // CreatedTime: The time at which the Team Drive was created (RFC 3339 @@ -3048,8 +3065,8 @@ type TeamDrive struct { Name string `json:"name,omitempty"` // OrgUnitId: The organizational unit of this shared drive. This field - // is only populated on drives.list responses when the - // useDomainAdminAccess parameter is set to true. + // is only populated on `drives.list` responses when the + // `useDomainAdminAccess` parameter is set to `true`. OrgUnitId string `json:"orgUnitId,omitempty"` // Restrictions: A set of restrictions that apply to this Team Drive or @@ -3057,12 +3074,12 @@ type TeamDrive struct { Restrictions *TeamDriveRestrictions `json:"restrictions,omitempty"` // ThemeId: The ID of the theme from which the background image and - // color will be set. The set of possible teamDriveThemes can be - // retrieved from a drive.about.get response. When not specified on a - // drive.teamdrives.create request, a random theme is chosen from which - // the background image and color are set. This is a write-only field; - // it can only be set on requests that don't set colorRgb or - // backgroundImageFile. + // color will be set. The set of possible `teamDriveThemes` can be + // retrieved from a `drive.about.get` response. When not specified on a + // `drive.teamdrives.create` request, a random theme is chosen from + // which the background image and color are set. This is a write-only + // field; it can only be set on requests that don't set `colorRgb` or + // `backgroundImageFile`. ThemeId string `json:"themeId,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -3095,9 +3112,9 @@ func (s *TeamDrive) MarshalJSON() ([]byte, error) { // TeamDriveBackgroundImageFile: An image file and cropping parameters // from which a background image for this Team Drive is set. This is a -// write only field; it can only be set on drive.teamdrives.update -// requests that don't set themeId. When specified, all fields of the -// backgroundImageFile must be set. +// write only field; it can only be set on `drive.teamdrives.update` +// requests that don't set `themeId`. When specified, all fields of the +// `backgroundImageFile` must be set. type TeamDriveBackgroundImageFile struct { // Id: The ID of an image file in Drive to use for the background image. Id string `json:"id,omitempty"` @@ -3172,17 +3189,17 @@ type TeamDriveCapabilities struct { CanAddChildren bool `json:"canAddChildren,omitempty"` // CanChangeCopyRequiresWriterPermissionRestriction: Whether the current - // user can change the copyRequiresWriterPermission restriction of this - // Team Drive. + // user can change the `copyRequiresWriterPermission` restriction of + // this Team Drive. CanChangeCopyRequiresWriterPermissionRestriction bool `json:"canChangeCopyRequiresWriterPermissionRestriction,omitempty"` // CanChangeDomainUsersOnlyRestriction: Whether the current user can - // change the domainUsersOnly restriction of this Team Drive. + // change the `domainUsersOnly` restriction of this Team Drive. CanChangeDomainUsersOnlyRestriction bool `json:"canChangeDomainUsersOnlyRestriction,omitempty"` // CanChangeSharingFoldersRequiresOrganizerPermissionRestriction: // Whether the current user can change the - // sharingFoldersRequiresOrganizerPermission restriction of this Team + // `sharingFoldersRequiresOrganizerPermission` restriction of this Team // Drive. CanChangeSharingFoldersRequiresOrganizerPermissionRestriction bool `json:"canChangeSharingFoldersRequiresOrganizerPermissionRestriction,omitempty"` @@ -3191,7 +3208,7 @@ type TeamDriveCapabilities struct { CanChangeTeamDriveBackground bool `json:"canChangeTeamDriveBackground,omitempty"` // CanChangeTeamMembersOnlyRestriction: Whether the current user can - // change the teamMembersOnly restriction of this Team Drive. + // change the `teamMembersOnly` restriction of this Team Drive. CanChangeTeamMembersOnlyRestriction bool `json:"canChangeTeamMembersOnlyRestriction,omitempty"` // CanComment: Whether the current user can comment on files in this @@ -3229,8 +3246,8 @@ type TeamDriveCapabilities struct { // resource of files in this Team Drive. CanReadRevisions bool `json:"canReadRevisions,omitempty"` - // CanRemoveChildren: Deprecated - use canDeleteChildren or - // canTrashChildren instead. + // CanRemoveChildren: Deprecated: Use `canDeleteChildren` or + // `canTrashChildren` instead. CanRemoveChildren bool `json:"canRemoveChildren,omitempty"` // CanRename: Whether the current user can rename files or folders in @@ -3286,8 +3303,8 @@ type TeamDriveRestrictions struct { // CopyRequiresWriterPermission: Whether the options to copy, print, or // download files inside this Team Drive, should be disabled for readers - // and commenters. When this restriction is set to true, it will - // override the similarly named field to true for any file inside this + // and commenters. When this restriction is set to `true`, it will + // override the similarly named field to `true` for any file inside this // Team Drive. CopyRequiresWriterPermission bool `json:"copyRequiresWriterPermission,omitempty"` @@ -3377,25 +3394,28 @@ func (s *TeamDriveList) MarshalJSON() ([]byte, error) { // User: Information about a Drive user. type User struct { - // DisplayName: A plain text displayable name for this user. + // DisplayName: Output only. A plain text displayable name for this + // user. DisplayName string `json:"displayName,omitempty"` - // EmailAddress: The email address of the user. This may not be present - // in certain contexts if the user has not made their email address - // visible to the requester. + // EmailAddress: Output only. The email address of the user. This may + // not be present in certain contexts if the user has not made their + // email address visible to the requester. EmailAddress string `json:"emailAddress,omitempty"` - // Kind: Identifies what kind of resource this is. Value: the fixed - // string "drive#user". + // Kind: Output only. Identifies what kind of resource this is. Value: + // the fixed string "drive#user". Kind string `json:"kind,omitempty"` - // Me: Whether this user is the requesting user. + // Me: Output only. Whether this user is the requesting user. Me bool `json:"me,omitempty"` - // PermissionId: The user's ID as visible in Permission resources. + // PermissionId: Output only. The user's ID as visible in Permission + // resources. PermissionId string `json:"permissionId,omitempty"` - // PhotoLink: A link to the user's profile photo, if available. + // PhotoLink: Output only. A link to the user's profile photo, if + // available. PhotoLink string `json:"photoLink,omitempty"` // ForceSendFields is a list of field names (e.g. "DisplayName") to @@ -3535,8 +3555,11 @@ func (c *AboutGetCall) Do(opts ...googleapi.CallOption) (*About, error) { return ret, nil // { // "description": "Gets information about the user, the user's Drive, and system capabilities.", + // "flatPath": "about", // "httpMethod": "GET", // "id": "drive.about.get", + // "parameterOrder": [], + // "parameters": {}, // "path": "about", // "response": { // "$ref": "About" @@ -3573,7 +3596,7 @@ func (r *ChangesService) GetStartPageToken() *ChangesGetStartPageTokenCall { // DriveId sets the optional parameter "driveId": The ID of the shared // drive for which the starting pageToken for listing future changes -// from that shared drive is returned. +// from that shared drive will be returned. func (c *ChangesGetStartPageTokenCall) DriveId(driveId string) *ChangesGetStartPageTokenCall { c.urlParams_.Set("driveId", driveId) return c @@ -3588,14 +3611,14 @@ func (c *ChangesGetStartPageTokenCall) SupportsAllDrives(supportsAllDrives bool) } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *ChangesGetStartPageTokenCall) SupportsTeamDrives(supportsTeamDrives bool) *ChangesGetStartPageTokenCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c } -// TeamDriveId sets the optional parameter "teamDriveId": Deprecated use -// driveId instead. +// TeamDriveId sets the optional parameter "teamDriveId": Deprecated: +// Use `driveId` instead. func (c *ChangesGetStartPageTokenCall) TeamDriveId(teamDriveId string) *ChangesGetStartPageTokenCall { c.urlParams_.Set("teamDriveId", teamDriveId) return c @@ -3698,11 +3721,13 @@ func (c *ChangesGetStartPageTokenCall) Do(opts ...googleapi.CallOption) (*StartP return ret, nil // { // "description": "Gets the starting pageToken for listing future changes.", + // "flatPath": "changes/startPageToken", // "httpMethod": "GET", // "id": "drive.changes.getStartPageToken", + // "parameterOrder": [], // "parameters": { // "driveId": { - // "description": "The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned.", + // "description": "The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.", // "location": "query", // "type": "string" // }, @@ -3714,12 +3739,12 @@ func (c *ChangesGetStartPageTokenCall) Do(opts ...googleapi.CallOption) (*StartP // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "teamDriveId": { - // "description": "Deprecated use driveId instead.", + // "description": "Deprecated: Use `driveId` instead.", // "location": "query", // "type": "string" // } @@ -3764,7 +3789,7 @@ func (r *ChangesService) List(pageToken string) *ChangesListCall { } // DriveId sets the optional parameter "driveId": The shared drive from -// which changes are returned. If specified the change IDs will be +// which changes will be returned. If specified the change IDs will be // reflective of the shared drive; use the combined drive ID and change // ID as an identifier. func (c *ChangesListCall) DriveId(driveId string) *ChangesListCall { @@ -3791,7 +3816,7 @@ func (c *ChangesListCall) IncludeItemsFromAllDrives(includeItemsFromAllDrives bo } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *ChangesListCall) IncludeLabels(includeLabels string) *ChangesListCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -3816,7 +3841,7 @@ func (c *ChangesListCall) IncludeRemoved(includeRemoved bool) *ChangesListCall { } // IncludeTeamDriveItems sets the optional parameter -// "includeTeamDriveItems": Deprecated use includeItemsFromAllDrives +// "includeTeamDriveItems": Deprecated: Use `includeItemsFromAllDrives` // instead. func (c *ChangesListCall) IncludeTeamDriveItems(includeTeamDriveItems bool) *ChangesListCall { c.urlParams_.Set("includeTeamDriveItems", fmt.Sprint(includeTeamDriveItems)) @@ -3857,14 +3882,14 @@ func (c *ChangesListCall) SupportsAllDrives(supportsAllDrives bool) *ChangesList } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *ChangesListCall) SupportsTeamDrives(supportsTeamDrives bool) *ChangesListCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c } -// TeamDriveId sets the optional parameter "teamDriveId": Deprecated use -// driveId instead. +// TeamDriveId sets the optional parameter "teamDriveId": Deprecated: +// Use `driveId` instead. func (c *ChangesListCall) TeamDriveId(teamDriveId string) *ChangesListCall { c.urlParams_.Set("teamDriveId", teamDriveId) return c @@ -3967,6 +3992,7 @@ func (c *ChangesListCall) Do(opts ...googleapi.CallOption) (*ChangeList, error) return ret, nil // { // "description": "Lists the changes for a user or shared drive.", + // "flatPath": "changes", // "httpMethod": "GET", // "id": "drive.changes.list", // "parameterOrder": [ @@ -3974,7 +4000,7 @@ func (c *ChangesListCall) Do(opts ...googleapi.CallOption) (*ChangeList, error) // ], // "parameters": { // "driveId": { - // "description": "The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", + // "description": "The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", // "location": "query", // "type": "string" // }, @@ -3991,7 +4017,7 @@ func (c *ChangesListCall) Do(opts ...googleapi.CallOption) (*ChangeList, error) // "type": "boolean" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, @@ -4008,7 +4034,7 @@ func (c *ChangesListCall) Do(opts ...googleapi.CallOption) (*ChangeList, error) // }, // "includeTeamDriveItems": { // "default": "false", - // "description": "Deprecated use includeItemsFromAllDrives instead.", + // "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -4047,12 +4073,12 @@ func (c *ChangesListCall) Do(opts ...googleapi.CallOption) (*ChangeList, error) // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "teamDriveId": { - // "description": "Deprecated use driveId instead.", + // "description": "Deprecated: Use `driveId` instead.", // "location": "query", // "type": "string" // } @@ -4085,8 +4111,7 @@ type ChangesWatchCall struct { header_ http.Header } -// Watch: Subscribes to changes for a user. To use this method, you must -// include the pageToken query parameter. +// Watch: Subscribes to changes for a user. // // - pageToken: The token for continuing a previous list request on the // next page. This should be set to the value of 'nextPageToken' from @@ -4100,7 +4125,7 @@ func (r *ChangesService) Watch(pageToken string, channel *Channel) *ChangesWatch } // DriveId sets the optional parameter "driveId": The shared drive from -// which changes are returned. If specified the change IDs will be +// which changes will be returned. If specified the change IDs will be // reflective of the shared drive; use the combined drive ID and change // ID as an identifier. func (c *ChangesWatchCall) DriveId(driveId string) *ChangesWatchCall { @@ -4127,7 +4152,7 @@ func (c *ChangesWatchCall) IncludeItemsFromAllDrives(includeItemsFromAllDrives b } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *ChangesWatchCall) IncludeLabels(includeLabels string) *ChangesWatchCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -4152,7 +4177,7 @@ func (c *ChangesWatchCall) IncludeRemoved(includeRemoved bool) *ChangesWatchCall } // IncludeTeamDriveItems sets the optional parameter -// "includeTeamDriveItems": Deprecated use includeItemsFromAllDrives +// "includeTeamDriveItems": Deprecated: Use `includeItemsFromAllDrives` // instead. func (c *ChangesWatchCall) IncludeTeamDriveItems(includeTeamDriveItems bool) *ChangesWatchCall { c.urlParams_.Set("includeTeamDriveItems", fmt.Sprint(includeTeamDriveItems)) @@ -4193,14 +4218,14 @@ func (c *ChangesWatchCall) SupportsAllDrives(supportsAllDrives bool) *ChangesWat } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *ChangesWatchCall) SupportsTeamDrives(supportsTeamDrives bool) *ChangesWatchCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c } -// TeamDriveId sets the optional parameter "teamDriveId": Deprecated use -// driveId instead. +// TeamDriveId sets the optional parameter "teamDriveId": Deprecated: +// Use `driveId` instead. func (c *ChangesWatchCall) TeamDriveId(teamDriveId string) *ChangesWatchCall { c.urlParams_.Set("teamDriveId", teamDriveId) return c @@ -4294,7 +4319,8 @@ func (c *ChangesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { } return ret, nil // { - // "description": "Subscribes to changes for a user. To use this method, you must include the pageToken query parameter.", + // "description": "Subscribes to changes for a user.", + // "flatPath": "changes/watch", // "httpMethod": "POST", // "id": "drive.changes.watch", // "parameterOrder": [ @@ -4302,7 +4328,7 @@ func (c *ChangesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // ], // "parameters": { // "driveId": { - // "description": "The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", + // "description": "The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.", // "location": "query", // "type": "string" // }, @@ -4319,7 +4345,7 @@ func (c *ChangesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // "type": "boolean" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, @@ -4336,7 +4362,7 @@ func (c *ChangesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // }, // "includeTeamDriveItems": { // "default": "false", - // "description": "Deprecated use includeItemsFromAllDrives instead.", + // "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -4375,12 +4401,12 @@ func (c *ChangesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "teamDriveId": { - // "description": "Deprecated use driveId instead.", + // "description": "Deprecated: Use `driveId` instead.", // "location": "query", // "type": "string" // } @@ -4417,7 +4443,7 @@ type ChannelsStopCall struct { header_ http.Header } -// Stop: Stop watching resources through this channel +// Stop: Stops watching resources through this channel. func (r *ChannelsService) Stop(channel *Channel) *ChannelsStopCall { c := &ChannelsStopCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.channel = channel @@ -4487,9 +4513,12 @@ func (c *ChannelsStopCall) Do(opts ...googleapi.CallOption) error { } return nil // { - // "description": "Stop watching resources through this channel", + // "description": "Stops watching resources through this channel.", + // "flatPath": "channels/stop", // "httpMethod": "POST", // "id": "drive.channels.stop", + // "parameterOrder": [], + // "parameters": {}, // "path": "channels/stop", // "request": { // "$ref": "Channel", @@ -4621,6 +4650,7 @@ func (c *CommentsCreateCall) Do(opts ...googleapi.CallOption) (*Comment, error) return ret, nil // { // "description": "Creates a comment on a file.", + // "flatPath": "files/{fileId}/comments", // "httpMethod": "POST", // "id": "drive.comments.create", // "parameterOrder": [ @@ -4734,6 +4764,7 @@ func (c *CommentsDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Deletes a comment.", + // "flatPath": "files/{fileId}/comments/{commentId}", // "httpMethod": "DELETE", // "id": "drive.comments.delete", // "parameterOrder": [ @@ -4895,6 +4926,7 @@ func (c *CommentsGetCall) Do(opts ...googleapi.CallOption) (*Comment, error) { return ret, nil // { // "description": "Gets a comment by ID.", + // "flatPath": "files/{fileId}/comments/{commentId}", // "httpMethod": "GET", // "id": "drive.comments.get", // "parameterOrder": [ @@ -5085,6 +5117,7 @@ func (c *CommentsListCall) Do(opts ...googleapi.CallOption) (*CommentList, error return ret, nil // { // "description": "Lists a file's comments.", + // "flatPath": "files/{fileId}/comments", // "httpMethod": "GET", // "id": "drive.comments.list", // "parameterOrder": [ @@ -5274,6 +5307,7 @@ func (c *CommentsUpdateCall) Do(opts ...googleapi.CallOption) (*Comment, error) return ret, nil // { // "description": "Updates a comment with patch semantics.", + // "flatPath": "files/{fileId}/comments/{commentId}", // "httpMethod": "PATCH", // "id": "drive.comments.update", // "parameterOrder": [ @@ -5423,6 +5457,7 @@ func (c *DrivesCreateCall) Do(opts ...googleapi.CallOption) (*Drive, error) { return ret, nil // { // "description": "Creates a shared drive.", + // "flatPath": "drives", // "httpMethod": "POST", // "id": "drive.drives.create", // "parameterOrder": [ @@ -5430,7 +5465,7 @@ func (c *DrivesCreateCall) Do(opts ...googleapi.CallOption) (*Drive, error) { // ], // "parameters": { // "requestId": { - // "description": "An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.", + // "description": "Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.", // "location": "query", // "required": true, // "type": "string" @@ -5472,8 +5507,8 @@ func (r *DrivesService) Delete(driveId string) *DrivesDeleteCall { // AllowItemDeletion sets the optional parameter "allowItemDeletion": // Whether any items inside the shared drive should also be deleted. -// This option is only supported when useDomainAdminAccess is also set -// to true. +// This option is only supported when `useDomainAdminAccess` is also set +// to `true`. func (c *DrivesDeleteCall) AllowItemDeletion(allowItemDeletion bool) *DrivesDeleteCall { c.urlParams_.Set("allowItemDeletion", fmt.Sprint(allowItemDeletion)) return c @@ -5550,6 +5585,7 @@ func (c *DrivesDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.", + // "flatPath": "drives/{driveId}", // "httpMethod": "DELETE", // "id": "drive.drives.delete", // "parameterOrder": [ @@ -5558,7 +5594,7 @@ func (c *DrivesDeleteCall) Do(opts ...googleapi.CallOption) error { // "parameters": { // "allowItemDeletion": { // "default": "false", - // "description": "Whether any items inside the shared drive should also be deleted. This option is only supported when useDomainAdminAccess is also set to true.", + // "description": "Whether any items inside the shared drive should also be deleted. This option is only supported when `useDomainAdminAccess` is also set to `true`.", // "location": "query", // "type": "boolean" // }, @@ -5712,6 +5748,7 @@ func (c *DrivesGetCall) Do(opts ...googleapi.CallOption) (*Drive, error) { return ret, nil // { // "description": "Gets a shared drive's metadata by ID.", + // "flatPath": "drives/{driveId}", // "httpMethod": "GET", // "id": "drive.drives.get", // "parameterOrder": [ @@ -5849,6 +5886,7 @@ func (c *DrivesHideCall) Do(opts ...googleapi.CallOption) (*Drive, error) { return ret, nil // { // "description": "Hides a shared drive from the default view.", + // "flatPath": "drives/{driveId}/hide", // "httpMethod": "POST", // "id": "drive.drives.hide", // "parameterOrder": [ @@ -5883,7 +5921,10 @@ type DrivesListCall struct { header_ http.Header } -// List: Lists the user's shared drives. +// List: Lists the user's shared drives. This method accepts the `q` +// parameter, which is a search query combining one or more search +// terms. For more information, see the Search for shared drives +// (/drive/api/guides/search-shareddrives) guide. func (r *DrivesService) List() *DrivesListCall { c := &DrivesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} return c @@ -6015,9 +6056,11 @@ func (c *DrivesListCall) Do(opts ...googleapi.CallOption) (*DriveList, error) { } return ret, nil // { - // "description": "Lists the user's shared drives.", + // "description": " Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/drive/api/guides/search-shareddrives) guide.", + // "flatPath": "drives", // "httpMethod": "GET", // "id": "drive.drives.list", + // "parameterOrder": [], // "parameters": { // "pageSize": { // "default": "10", @@ -6184,6 +6227,7 @@ func (c *DrivesUnhideCall) Do(opts ...googleapi.CallOption) (*Drive, error) { return ret, nil // { // "description": "Restores a shared drive to the default view.", + // "flatPath": "drives/{driveId}/unhide", // "httpMethod": "POST", // "id": "drive.drives.unhide", // "parameterOrder": [ @@ -6219,7 +6263,7 @@ type DrivesUpdateCall struct { header_ http.Header } -// Update: Updates the metadata for a shared drive. +// Update: Updates the metadate for a shared drive. // // - driveId: The ID of the shared drive. func (r *DrivesService) Update(driveId string, drive *Drive) *DrivesUpdateCall { @@ -6230,9 +6274,9 @@ func (r *DrivesService) Update(driveId string, drive *Drive) *DrivesUpdateCall { } // UseDomainAdminAccess sets the optional parameter -// "useDomainAdminAccess": Issue the request as a domain administrator. -// If set to true, then the requester is granted access if they're an -// administrator of the domain to which the shared drive belongs. +// "useDomainAdminAccess": Issue the request as a domain administrator; +// if set to true, then the requester will be granted access if they are +// an administrator of the domain to which the shared drive belongs. func (c *DrivesUpdateCall) UseDomainAdminAccess(useDomainAdminAccess bool) *DrivesUpdateCall { c.urlParams_.Set("useDomainAdminAccess", fmt.Sprint(useDomainAdminAccess)) return c @@ -6329,7 +6373,8 @@ func (c *DrivesUpdateCall) Do(opts ...googleapi.CallOption) (*Drive, error) { } return ret, nil // { - // "description": "Updates the metadata for a shared drive.", + // "description": "Updates the metadate for a shared drive.", + // "flatPath": "drives/{driveId}", // "httpMethod": "PATCH", // "id": "drive.drives.update", // "parameterOrder": [ @@ -6344,7 +6389,7 @@ func (c *DrivesUpdateCall) Do(opts ...googleapi.CallOption) (*Drive, error) { // }, // "useDomainAdminAccess": { // "default": "false", - // "description": "Issue the request as a domain administrator. If set to true, then the requester is granted access if they're an administrator of the domain to which the shared drive belongs.", + // "description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.", // "location": "query", // "type": "boolean" // } @@ -6375,7 +6420,7 @@ type FilesCopyCall struct { } // Copy: Creates a copy of a file and applies any requested updates with -// patch semantics. Folders cannot be copied. +// patch semantics. // // - fileId: The ID of the file. func (r *FilesService) Copy(fileId string, file *File) *FilesCopyCall { @@ -6405,7 +6450,7 @@ func (c *FilesCopyCall) IgnoreDefaultVisibility(ignoreDefaultVisibility bool) *F } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesCopyCall) IncludeLabels(includeLabels string) *FilesCopyCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -6447,7 +6492,7 @@ func (c *FilesCopyCall) SupportsAllDrives(supportsAllDrives bool) *FilesCopyCall } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesCopyCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesCopyCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -6544,7 +6589,8 @@ func (c *FilesCopyCall) Do(opts ...googleapi.CallOption) (*File, error) { } return ret, nil // { - // "description": "Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.", + // "description": "Creates a copy of a file and applies any requested updates with patch semantics.", + // "flatPath": "files/{fileId}/copy", // "httpMethod": "POST", // "id": "drive.files.copy", // "parameterOrder": [ @@ -6570,7 +6616,7 @@ func (c *FilesCopyCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "boolean" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, @@ -6598,7 +6644,7 @@ func (c *FilesCopyCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // } @@ -6631,7 +6677,25 @@ type FilesCreateCall struct { header_ http.Header } -// Create: Creates a file. +// Create: Creates a new file. This method supports an */upload* URI +// and accepts uploaded media with the following characteristics: - +// *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` +// Note: Specify a valid MIME type, rather than the literal `*/*` value. +// The literal `*/*` is only used to indicate that any valid MIME type +// can be uploaded. For more information on uploading files, see Upload +// file data (/drive/api/guides/manage-uploads). Apps creating shortcuts +// with `files.create` must specify the MIME type +// `application/vnd.google-apps.shortcut`. Apps should specify a file +// extension in the `name` property when inserting files with the API. +// For example, an operation to insert a JPEG file should specify +// something like "name": "cat.jpg" in the metadata. Subsequent `GET` +// requests include the read-only `fileExtension` property populated +// with the extension originally specified in the `title` property. When +// a Google Drive user requests to download a file, or when the file is +// downloaded through the sync client, Drive builds a full filename +// (with extension) based on the title. In cases where the extension is +// missing, Drive attempts to determine the extension based on the +// file's MIME type. func (r *FilesService) Create(file *File) *FilesCreateCall { c := &FilesCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.file = file @@ -6658,7 +6722,7 @@ func (c *FilesCreateCall) IgnoreDefaultVisibility(ignoreDefaultVisibility bool) } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesCreateCall) IncludeLabels(includeLabels string) *FilesCreateCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -6700,7 +6764,7 @@ func (c *FilesCreateCall) SupportsAllDrives(supportsAllDrives bool) *FilesCreate } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesCreateCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesCreateCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -6869,14 +6933,15 @@ func (c *FilesCreateCall) Do(opts ...googleapi.CallOption) (*File, error) { } return ret, nil // { - // "description": "Creates a file.", + // "description": " Creates a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"name\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.", + // "flatPath": "files", // "httpMethod": "POST", // "id": "drive.files.create", // "mediaUpload": { // "accept": [ // "*/*" // ], - // "maxSize": "5120GB", + // "maxSize": "5497558138880", // "protocols": { // "resumable": { // "multipart": true, @@ -6888,6 +6953,7 @@ func (c *FilesCreateCall) Do(opts ...googleapi.CallOption) (*File, error) { // } // } // }, + // "parameterOrder": [], // "parameters": { // "enforceSingleParent": { // "default": "false", @@ -6902,7 +6968,7 @@ func (c *FilesCreateCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "boolean" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, @@ -6930,7 +6996,7 @@ func (c *FilesCreateCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -6953,8 +7019,7 @@ func (c *FilesCreateCall) Do(opts ...googleapi.CallOption) (*File, error) { // "https://www.googleapis.com/auth/drive.appdata", // "https://www.googleapis.com/auth/drive.file" // ], - // "supportsMediaUpload": true, - // "supportsSubscription": true + // "supportsMediaUpload": true // } } @@ -6982,7 +7047,7 @@ func (r *FilesService) Delete(fileId string) *FilesDeleteCall { } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. If an item is not in a shared +// "enforceSingleParent": 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. func (c *FilesDeleteCall) EnforceSingleParent(enforceSingleParent bool) *FilesDeleteCall { @@ -6999,7 +7064,7 @@ func (c *FilesDeleteCall) SupportsAllDrives(supportsAllDrives bool) *FilesDelete } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesDeleteCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesDeleteCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -7067,6 +7132,7 @@ func (c *FilesDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted.", + // "flatPath": "files/{fileId}", // "httpMethod": "DELETE", // "id": "drive.files.delete", // "parameterOrder": [ @@ -7075,7 +7141,7 @@ func (c *FilesDeleteCall) Do(opts ...googleapi.CallOption) error { // "parameters": { // "enforceSingleParent": { // "default": "false", - // "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.", + // "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" // }, @@ -7093,7 +7159,7 @@ func (c *FilesDeleteCall) Do(opts ...googleapi.CallOption) error { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // } @@ -7117,8 +7183,7 @@ type FilesEmptyTrashCall struct { header_ http.Header } -// EmptyTrash: Permanently deletes all trashed files of a user or shared -// drive. +// EmptyTrash: Permanently deletes all of the user's trashed files. func (r *FilesService) EmptyTrash() *FilesEmptyTrashCall { c := &FilesEmptyTrashCall{s: r.s, urlParams_: make(gensupport.URLParams)} return c @@ -7132,7 +7197,7 @@ func (c *FilesEmptyTrashCall) DriveId(driveId string) *FilesEmptyTrashCall { } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. If an item is not in a shared +// "enforceSingleParent": 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. func (c *FilesEmptyTrashCall) EnforceSingleParent(enforceSingleParent bool) *FilesEmptyTrashCall { @@ -7198,9 +7263,11 @@ func (c *FilesEmptyTrashCall) Do(opts ...googleapi.CallOption) error { } return nil // { - // "description": "Permanently deletes all trashed files of a user or shared drive.", + // "description": "Permanently deletes all of the user's trashed files.", + // "flatPath": "files/trash", // "httpMethod": "DELETE", // "id": "drive.files.emptyTrash", + // "parameterOrder": [], // "parameters": { // "driveId": { // "description": "If set, empties the trash of the provided shared drive.", @@ -7209,7 +7276,7 @@ func (c *FilesEmptyTrashCall) Do(opts ...googleapi.CallOption) error { // }, // "enforceSingleParent": { // "default": "false", - // "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.", + // "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" // } @@ -7337,6 +7404,7 @@ func (c *FilesExportCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.", + // "flatPath": "files/{fileId}/export", // "httpMethod": "GET", // "id": "drive.files.export", // "parameterOrder": [ @@ -7351,7 +7419,7 @@ func (c *FilesExportCall) Do(opts ...googleapi.CallOption) error { // "type": "string" // }, // "mimeType": { - // "description": "The MIME type of the format requested for this export.", + // "description": "Required. The MIME type of the format requested for this export.", // "location": "query", // "required": true, // "type": "string" @@ -7363,7 +7431,8 @@ func (c *FilesExportCall) Do(opts ...googleapi.CallOption) error { // "https://www.googleapis.com/auth/drive.file", // "https://www.googleapis.com/auth/drive.readonly" // ], - // "supportsMediaDownload": true + // "supportsMediaDownload": true, + // "useMediaDownloadService": true // } } @@ -7402,7 +7471,7 @@ func (c *FilesGenerateIdsCall) Space(space string) *FilesGenerateIdsCall { // Type sets the optional parameter "type": The type of items which the // IDs can be used for. Supported values are 'files' and 'shortcuts'. -// Note that 'shortcuts' are only supported in the drive 'space'. +// Note that 'shortcuts' are only supported in the `drive` 'space'. // (Default: 'files') func (c *FilesGenerateIdsCall) Type(type_ string) *FilesGenerateIdsCall { c.urlParams_.Set("type", type_) @@ -7506,8 +7575,10 @@ func (c *FilesGenerateIdsCall) Do(opts ...googleapi.CallOption) (*GeneratedIds, return ret, nil // { // "description": "Generates a set of file IDs which can be provided in create or copy requests.", + // "flatPath": "files/generateIds", // "httpMethod": "GET", // "id": "drive.files.generateIds", + // "parameterOrder": [], // "parameters": { // "count": { // "default": "10", @@ -7526,7 +7597,7 @@ func (c *FilesGenerateIdsCall) Do(opts ...googleapi.CallOption) (*GeneratedIds, // }, // "type": { // "default": "files", - // "description": "The type of items which the IDs can be used for. Supported values are 'files' and 'shortcuts'. Note that 'shortcuts' are only supported in the drive 'space'. (Default: 'files')", + // "description": "The type of items which the IDs can be used for. Supported values are 'files' and 'shortcuts'. Note that 'shortcuts' are only supported in the `drive` 'space'. (Default: 'files')", // "location": "query", // "type": "string" // } @@ -7555,7 +7626,13 @@ type FilesGetCall struct { header_ http.Header } -// Get: Gets a file's metadata or content by ID. +// Get: Gets a file's metadata or content by ID. If you provide the URL +// parameter `alt=media`, then the response includes the file contents +// in the response body. Downloading content with `alt=media` only works +// if the file is stored in Drive. To download Google Docs, Sheets, and +// Slides use `files.export` (/drive/api/reference/rest/v3/files/export) +// instead. For more information, see Download & export files +// (/drive/api/guides/manage-downloads). // // - fileId: The ID of the file. func (r *FilesService) Get(fileId string) *FilesGetCall { @@ -7574,7 +7651,7 @@ func (c *FilesGetCall) AcknowledgeAbuse(acknowledgeAbuse bool) *FilesGetCall { } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesGetCall) IncludeLabels(includeLabels string) *FilesGetCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -7599,7 +7676,7 @@ func (c *FilesGetCall) SupportsAllDrives(supportsAllDrives bool) *FilesGetCall { } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesGetCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesGetCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -7720,7 +7797,8 @@ func (c *FilesGetCall) Do(opts ...googleapi.CallOption) (*File, error) { } return ret, nil // { - // "description": "Gets a file's metadata or content by ID.", + // "description": " Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download \u0026 export files](/drive/api/guides/manage-downloads).", + // "flatPath": "files/{fileId}", // "httpMethod": "GET", // "id": "drive.files.get", // "parameterOrder": [ @@ -7740,7 +7818,7 @@ func (c *FilesGetCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "string" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, @@ -7757,7 +7835,7 @@ func (c *FilesGetCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // } @@ -7792,35 +7870,36 @@ type FilesListCall struct { header_ http.Header } -// List: Lists or searches files. +// List: Lists the user's files. This method accepts the `q` parameter, +// which is a search query combining one or more search terms. For more +// information, see the Search for files & folders +// (/drive/api/guides/search-files) guide. *Note:* This method returns +// *all* files by default, including trashed files. If you don't want +// trashed files to appear in the list, use the `trashed=false` query +// parameter to remove trashed files from the results. func (r *FilesService) List() *FilesListCall { c := &FilesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} return c } -// Corpora sets the optional parameter "corpora": Groupings of files to -// which the query applies. Supported groupings are: 'user' (files -// created by, opened by, or shared directly with the user), 'drive' -// (files in the specified shared drive as indicated by the 'driveId'), -// 'domain' (files shared to the user's domain), and 'allDrives' (A -// combination of 'user' and 'drive' for all drives where the user is a -// member). When able, use 'user' or 'drive', instead of 'allDrives', -// for efficiency. +// Corpora sets the optional parameter "corpora": Bodies of items +// (files/documents) to which the query applies. Supported bodies are +// 'user', 'domain', 'drive', and 'allDrives'. Prefer 'user' or 'drive' +// to 'allDrives' for efficiency. By default, corpora is set to 'user'. +// However, this can change depending on the filter set through the 'q' +// parameter. func (c *FilesListCall) Corpora(corpora string) *FilesListCall { c.urlParams_.Set("corpora", corpora) return c } -// Corpus sets the optional parameter "corpus": The source of files to -// list. Deprecated: use 'corpora' instead. +// Corpus sets the optional parameter "corpus": Deprecated: The source +// of files to list. Use 'corpora' instead. // // Possible values: // // "domain" - Files shared to the user's domain. -// "user" - Files owned by or shared to the user. If a user has -// -// permissions on a Shared Drive, the files inside it won't be retrieved -// unless the user has created, opened, or shared the file. +// "user" - Files owned by or shared to the user. func (c *FilesListCall) Corpus(corpus string) *FilesListCall { c.urlParams_.Set("corpus", corpus) return c @@ -7842,7 +7921,7 @@ func (c *FilesListCall) IncludeItemsFromAllDrives(includeItemsFromAllDrives bool } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesListCall) IncludeLabels(includeLabels string) *FilesListCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -7859,7 +7938,7 @@ func (c *FilesListCall) IncludePermissionsForView(includePermissionsForView stri } // IncludeTeamDriveItems sets the optional parameter -// "includeTeamDriveItems": Deprecated use includeItemsFromAllDrives +// "includeTeamDriveItems": Deprecated: Use `includeItemsFromAllDrives` // instead. func (c *FilesListCall) IncludeTeamDriveItems(includeTeamDriveItems bool) *FilesListCall { c.urlParams_.Set("includeTeamDriveItems", fmt.Sprint(includeTeamDriveItems)) @@ -7870,11 +7949,9 @@ func (c *FilesListCall) IncludeTeamDriveItems(includeTeamDriveItems bool) *Files // of sort keys. Valid keys are 'createdTime', 'folder', // 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', // 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and -// 'viewedByMeTime'. Each key sorts ascending by default, but may be +// 'viewedByMeTime'. Each key sorts ascending by default, but can be // reversed with the 'desc' modifier. Example usage: -// ?orderBy=folder,modifiedTime desc,name. Please note that there is a -// current limitation for users with approximately one million files in -// which the requested sort order is ignored. +// ?orderBy=folder,modifiedTime desc,name. func (c *FilesListCall) OrderBy(orderBy string) *FilesListCall { c.urlParams_.Set("orderBy", orderBy) return c @@ -7897,7 +7974,8 @@ func (c *FilesListCall) PageToken(pageToken string) *FilesListCall { } // Q sets the optional parameter "q": A query for filtering the file -// results. See the "Search for Files" guide for supported syntax. +// results. See the "Search for files & folders" guide for supported +// syntax. func (c *FilesListCall) Q(q string) *FilesListCall { c.urlParams_.Set("q", q) return c @@ -7920,14 +7998,14 @@ func (c *FilesListCall) SupportsAllDrives(supportsAllDrives bool) *FilesListCall } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesListCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesListCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c } -// TeamDriveId sets the optional parameter "teamDriveId": Deprecated use -// driveId instead. +// TeamDriveId sets the optional parameter "teamDriveId": Deprecated: +// Use `driveId` instead. func (c *FilesListCall) TeamDriveId(teamDriveId string) *FilesListCall { c.urlParams_.Set("teamDriveId", teamDriveId) return c @@ -8029,24 +8107,26 @@ func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error) { } return ret, nil // { - // "description": "Lists or searches files.", + // "description": " Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files \u0026 folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", + // "flatPath": "files", // "httpMethod": "GET", // "id": "drive.files.list", + // "parameterOrder": [], // "parameters": { // "corpora": { - // "description": "Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency.", + // "description": "Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive', and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency. By default, corpora is set to 'user'. However, this can change depending on the filter set through the 'q' parameter.", // "location": "query", // "type": "string" // }, // "corpus": { - // "description": "The source of files to list. Deprecated: use 'corpora' instead.", + // "description": "Deprecated: The source of files to list. Use 'corpora' instead.", // "enum": [ // "domain", // "user" // ], // "enumDescriptions": [ // "Files shared to the user's domain.", - // "Files owned by or shared to the user. If a user has permissions on a Shared Drive, the files inside it won't be retrieved unless the user has created, opened, or shared the file." + // "Files owned by or shared to the user." // ], // "location": "query", // "type": "string" @@ -8063,7 +8143,7 @@ func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error) { // "type": "boolean" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, @@ -8074,12 +8154,12 @@ func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error) { // }, // "includeTeamDriveItems": { // "default": "false", - // "description": "Deprecated use includeItemsFromAllDrives instead.", + // "description": "Deprecated: Use `includeItemsFromAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "orderBy": { - // "description": "A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.", + // "description": "A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name.", // "location": "query", // "type": "string" // }, @@ -8098,7 +8178,7 @@ func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error) { // "type": "string" // }, // "q": { - // "description": "A query for filtering the file results. See the \"Search for Files\" guide for supported syntax.", + // "description": "A query for filtering the file results. See the \"Search for files \u0026 folders\" guide for supported syntax.", // "location": "query", // "type": "string" // }, @@ -8116,12 +8196,12 @@ func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "teamDriveId": { - // "description": "Deprecated use driveId instead.", + // "description": "Deprecated: Use `driveId` instead.", // "location": "query", // "type": "string" // } @@ -8177,7 +8257,7 @@ type FilesListLabelsCall struct { // ListLabels: Lists the labels on a file. // -// - fileId: The ID of the file. +// - fileId: The ID for the file or shared drive. func (r *FilesService) ListLabels(fileId string) *FilesListLabelsCall { c := &FilesListLabelsCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.fileId = fileId @@ -8185,8 +8265,7 @@ func (r *FilesService) ListLabels(fileId string) *FilesListLabelsCall { } // MaxResults sets the optional parameter "maxResults": The maximum -// number of labels to return per page. When not set, this defaults to -// 100. +// number of labels to return per page. When not set, defaults to 100. func (c *FilesListLabelsCall) MaxResults(maxResults int64) *FilesListLabelsCall { c.urlParams_.Set("maxResults", fmt.Sprint(maxResults)) return c @@ -8300,6 +8379,7 @@ func (c *FilesListLabelsCall) Do(opts ...googleapi.CallOption) (*LabelList, erro return ret, nil // { // "description": "Lists the labels on a file.", + // "flatPath": "files/{fileId}/listLabels", // "httpMethod": "GET", // "id": "drive.files.listLabels", // "parameterOrder": [ @@ -8307,14 +8387,14 @@ func (c *FilesListLabelsCall) Do(opts ...googleapi.CallOption) (*LabelList, erro // ], // "parameters": { // "fileId": { - // "description": "The ID of the file.", + // "description": "The ID for the file or shared drive.", // "location": "path", // "required": true, // "type": "string" // }, // "maxResults": { // "default": "100", - // "description": "The maximum number of labels to return per page. When not set, this defaults to 100.", + // "description": "The maximum number of labels to return per page. When not set, defaults to 100.", // "format": "int32", // "location": "query", // "maximum": "100", @@ -8374,9 +8454,10 @@ type FilesModifyLabelsCall struct { header_ http.Header } -// ModifyLabels: Modifies the set of labels on a file. +// ModifyLabels: Modifies the set of labels applied to a file. Returns a +// list of the labels that were added or modified. // -// - fileId: The ID of the file for which the labels are modified. +// - fileId: The ID of the file to which the labels belong. func (r *FilesService) ModifyLabels(fileId string, modifylabelsrequest *ModifyLabelsRequest) *FilesModifyLabelsCall { c := &FilesModifyLabelsCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.fileId = fileId @@ -8475,7 +8556,8 @@ func (c *FilesModifyLabelsCall) Do(opts ...googleapi.CallOption) (*ModifyLabelsR } return ret, nil // { - // "description": "Modifies the set of labels on a file.", + // "description": "Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.", + // "flatPath": "files/{fileId}/modifyLabels", // "httpMethod": "POST", // "id": "drive.files.modifyLabels", // "parameterOrder": [ @@ -8483,7 +8565,7 @@ func (c *FilesModifyLabelsCall) Do(opts ...googleapi.CallOption) (*ModifyLabelsR // ], // "parameters": { // "fileId": { - // "description": "The ID of the file for which the labels are modified.", + // "description": "The ID of the file to which the labels belong.", // "location": "path", // "required": true, // "type": "string" @@ -8517,10 +8599,17 @@ type FilesUpdateCall struct { header_ http.Header } -// Update: Updates a file's metadata and/or content. When calling this +// Update: Updates a file's metadata and/or content. When calling this // method, only populate fields in the request that you want to modify. -// When updating fields, some fields might change automatically, such as -// modifiedDate. This method supports patch semantics. +// When updating fields, some fields might be changed automatically, +// such as `modifiedDate`. This method supports patch semantics. This +// method supports an */upload* URI and accepts uploaded media with the +// following characteristics: - *Maximum file size:* 5,120 GB - +// *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, +// rather than the literal `*/*` value. The literal `*/*` is only used +// to indicate that any valid MIME type can be uploaded. For more +// information on uploading files, see Upload file data +// (/drive/api/guides/manage-uploads). // // - fileId: The ID of the file. func (r *FilesService) Update(fileId string, file *File) *FilesUpdateCall { @@ -8538,7 +8627,7 @@ func (c *FilesUpdateCall) AddParents(addParents string) *FilesUpdateCall { } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. Adding files to multiple folders +// "enforceSingleParent": Deprecated: Adding files to multiple folders // is no longer supported. Use shortcuts instead. func (c *FilesUpdateCall) EnforceSingleParent(enforceSingleParent bool) *FilesUpdateCall { c.urlParams_.Set("enforceSingleParent", fmt.Sprint(enforceSingleParent)) @@ -8546,7 +8635,7 @@ func (c *FilesUpdateCall) EnforceSingleParent(enforceSingleParent bool) *FilesUp } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesUpdateCall) IncludeLabels(includeLabels string) *FilesUpdateCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -8595,7 +8684,7 @@ func (c *FilesUpdateCall) SupportsAllDrives(supportsAllDrives bool) *FilesUpdate } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesUpdateCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesUpdateCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -8767,14 +8856,15 @@ func (c *FilesUpdateCall) Do(opts ...googleapi.CallOption) (*File, error) { } return ret, nil // { - // "description": "Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.", + // "description": " Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads).", + // "flatPath": "files/{fileId}", // "httpMethod": "PATCH", // "id": "drive.files.update", // "mediaUpload": { // "accept": [ // "*/*" // ], - // "maxSize": "5120GB", + // "maxSize": "5497558138880", // "protocols": { // "resumable": { // "multipart": true, @@ -8797,7 +8887,7 @@ func (c *FilesUpdateCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "enforceSingleParent": { // "default": "false", - // "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", + // "description": "Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.", // "location": "query", // "type": "boolean" // }, @@ -8808,7 +8898,7 @@ func (c *FilesUpdateCall) Do(opts ...googleapi.CallOption) (*File, error) { // "type": "string" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, @@ -8841,7 +8931,7 @@ func (c *FilesUpdateCall) Do(opts ...googleapi.CallOption) (*File, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -8882,7 +8972,7 @@ type FilesWatchCall struct { header_ http.Header } -// Watch: Subscribe to changes on a file. +// Watch: Subscribes to changes to a file. // // - fileId: The ID of the file. func (r *FilesService) Watch(fileId string, channel *Channel) *FilesWatchCall { @@ -8902,7 +8992,7 @@ func (c *FilesWatchCall) AcknowledgeAbuse(acknowledgeAbuse bool) *FilesWatchCall } // IncludeLabels sets the optional parameter "includeLabels": A -// comma-separated list of IDs of labels to include in the labelInfo +// comma-separated list of IDs of labels to include in the `labelInfo` // part of the response. func (c *FilesWatchCall) IncludeLabels(includeLabels string) *FilesWatchCall { c.urlParams_.Set("includeLabels", includeLabels) @@ -8927,7 +9017,7 @@ func (c *FilesWatchCall) SupportsAllDrives(supportsAllDrives bool) *FilesWatchCa } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *FilesWatchCall) SupportsTeamDrives(supportsTeamDrives bool) *FilesWatchCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -8941,9 +9031,9 @@ func (c *FilesWatchCall) Fields(s ...googleapi.Field) *FilesWatchCall { return c } -// Context sets the context to be used in this call's Do and Download -// methods. Any pending HTTP request will be aborted if the provided -// context is canceled. +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. func (c *FilesWatchCall) Context(ctx context.Context) *FilesWatchCall { c.ctx_ = ctx return c @@ -8986,22 +9076,6 @@ func (c *FilesWatchCall) doRequest(alt string) (*http.Response, error) { return gensupport.SendRequest(c.ctx_, c.s.client, req) } -// Download fetches the API endpoint's "media" value, instead of the normal -// API response value. If the returned error is nil, the Response is guaranteed to -// have a 2xx status code. Callers must close the Response.Body as usual. -func (c *FilesWatchCall) Download(opts ...googleapi.CallOption) (*http.Response, error) { - gensupport.SetOptions(c.urlParams_, opts...) - res, err := c.doRequest("media") - if err != nil { - return nil, err - } - if err := googleapi.CheckResponse(res); err != nil { - res.Body.Close() - return nil, gensupport.WrapError(err) - } - return res, nil -} - // Do executes the "drive.files.watch" call. // Exactly one of *Channel or error will be non-nil. Any non-2xx status // code is an error. Response headers are in either @@ -9040,7 +9114,8 @@ func (c *FilesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { } return ret, nil // { - // "description": "Subscribe to changes on a file.", + // "description": "Subscribes to changes to a file.", + // "flatPath": "files/{fileId}/watch", // "httpMethod": "POST", // "id": "drive.files.watch", // "parameterOrder": [ @@ -9060,7 +9135,7 @@ func (c *FilesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // "type": "string" // }, // "includeLabels": { - // "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + // "description": "A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.", // "location": "query", // "type": "string" // }, @@ -9077,7 +9152,7 @@ func (c *FilesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // } @@ -9099,9 +9174,7 @@ func (c *FilesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) { // "https://www.googleapis.com/auth/drive.photos.readonly", // "https://www.googleapis.com/auth/drive.readonly" // ], - // "supportsMediaDownload": true, - // "supportsSubscription": true, - // "useMediaDownloadService": true + // "supportsSubscription": true // } } @@ -9117,9 +9190,9 @@ type PermissionsCreateCall struct { header_ http.Header } -// Create: Creates a permission for a file or shared drive. For more -// information on creating permissions, see Share files, folders & -// drives. +// Create: Creates a permission for a file or shared drive. **Warning:** +// Concurrent permissions operations on the same file are not supported; +// only the last update is applied. // // - fileId: The ID of the file or shared drive. func (r *PermissionsService) Create(fileId string, permission *Permission) *PermissionsCreateCall { @@ -9137,7 +9210,7 @@ func (c *PermissionsCreateCall) EmailMessage(emailMessage string) *PermissionsCr } // EnforceSingleParent sets the optional parameter -// "enforceSingleParent": Deprecated. See moveToNewOwnersRoot for +// "enforceSingleParent": Deprecated: See `moveToNewOwnersRoot` for // details. func (c *PermissionsCreateCall) EnforceSingleParent(enforceSingleParent bool) *PermissionsCreateCall { c.urlParams_.Set("enforceSingleParent", fmt.Sprint(enforceSingleParent)) @@ -9147,9 +9220,9 @@ func (c *PermissionsCreateCall) EnforceSingleParent(enforceSingleParent bool) *P // MoveToNewOwnersRoot sets the optional parameter // "moveToNewOwnersRoot": 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. +// 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. func (c *PermissionsCreateCall) MoveToNewOwnersRoot(moveToNewOwnersRoot bool) *PermissionsCreateCall { c.urlParams_.Set("moveToNewOwnersRoot", fmt.Sprint(moveToNewOwnersRoot)) return c @@ -9174,7 +9247,7 @@ func (c *PermissionsCreateCall) SupportsAllDrives(supportsAllDrives bool) *Permi } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *PermissionsCreateCall) SupportsTeamDrives(supportsTeamDrives bool) *PermissionsCreateCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -9183,12 +9256,7 @@ func (c *PermissionsCreateCall) SupportsTeamDrives(supportsTeamDrives bool) *Per // TransferOwnership sets the optional parameter "transferOwnership": // Whether to transfer ownership to the specified user and downgrade the // current owner to a writer. This parameter is required as an -// acknowledgement of the side effect. File owners can only transfer -// ownership of files existing on My Drive. Files existing in a shared -// drive are owned by the organization that owns that shared drive. -// Ownership transfers are not supported for files and folders in shared -// drives. Organizers of a shared drive can move items from that shared -// drive into their My Drive which transfers the ownership to them. +// acknowledgement of the side effect. func (c *PermissionsCreateCall) TransferOwnership(transferOwnership bool) *PermissionsCreateCall { c.urlParams_.Set("transferOwnership", fmt.Sprint(transferOwnership)) return c @@ -9295,7 +9363,8 @@ func (c *PermissionsCreateCall) Do(opts ...googleapi.CallOption) (*Permission, e } return ret, nil // { - // "description": "Creates a permission for a file or shared drive. For more information on creating permissions, see Share files, folders \u0026 drives.", + // "description": "Creates a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + // "flatPath": "files/{fileId}/permissions", // "httpMethod": "POST", // "id": "drive.permissions.create", // "parameterOrder": [ @@ -9309,7 +9378,7 @@ func (c *PermissionsCreateCall) Do(opts ...googleapi.CallOption) (*Permission, e // }, // "enforceSingleParent": { // "default": "false", - // "description": "Deprecated. See moveToNewOwnersRoot for details.", + // "description": "Deprecated: See `moveToNewOwnersRoot` for details.", // "location": "query", // "type": "boolean" // }, @@ -9321,7 +9390,7 @@ func (c *PermissionsCreateCall) Do(opts ...googleapi.CallOption) (*Permission, e // }, // "moveToNewOwnersRoot": { // "default": "false", - // "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.", + // "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" // }, @@ -9338,13 +9407,13 @@ func (c *PermissionsCreateCall) Do(opts ...googleapi.CallOption) (*Permission, e // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "transferOwnership": { // "default": "false", - // "description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them.", + // "description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.", // "location": "query", // "type": "boolean" // }, @@ -9381,7 +9450,9 @@ type PermissionsDeleteCall struct { header_ http.Header } -// Delete: Deletes a permission. +// Delete: Deletes a permission. **Warning:** Concurrent permissions +// operations on the same file are not supported; only the last update +// is applied. // // - fileId: The ID of the file or shared drive. // - permissionId: The ID of the permission. @@ -9401,7 +9472,7 @@ func (c *PermissionsDeleteCall) SupportsAllDrives(supportsAllDrives bool) *Permi } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *PermissionsDeleteCall) SupportsTeamDrives(supportsTeamDrives bool) *PermissionsDeleteCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -9479,7 +9550,8 @@ func (c *PermissionsDeleteCall) Do(opts ...googleapi.CallOption) error { } return nil // { - // "description": "Deletes a permission.", + // "description": "Deletes a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + // "flatPath": "files/{fileId}/permissions/{permissionId}", // "httpMethod": "DELETE", // "id": "drive.permissions.delete", // "parameterOrder": [ @@ -9507,7 +9579,7 @@ func (c *PermissionsDeleteCall) Do(opts ...googleapi.CallOption) error { // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -9559,7 +9631,7 @@ func (c *PermissionsGetCall) SupportsAllDrives(supportsAllDrives bool) *Permissi } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *PermissionsGetCall) SupportsTeamDrives(supportsTeamDrives bool) *PermissionsGetCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -9676,6 +9748,7 @@ func (c *PermissionsGetCall) Do(opts ...googleapi.CallOption) (*Permission, erro return ret, nil // { // "description": "Gets a permission by ID.", + // "flatPath": "files/{fileId}/permissions/{permissionId}", // "httpMethod": "GET", // "id": "drive.permissions.get", // "parameterOrder": [ @@ -9703,7 +9776,7 @@ func (c *PermissionsGetCall) Do(opts ...googleapi.CallOption) (*Permission, erro // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -9785,7 +9858,7 @@ func (c *PermissionsListCall) SupportsAllDrives(supportsAllDrives bool) *Permiss } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *PermissionsListCall) SupportsTeamDrives(supportsTeamDrives bool) *PermissionsListCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -9901,6 +9974,7 @@ func (c *PermissionsListCall) Do(opts ...googleapi.CallOption) (*PermissionList, return ret, nil // { // "description": "Lists a file's or shared drive's permissions.", + // "flatPath": "files/{fileId}/permissions", // "httpMethod": "GET", // "id": "drive.permissions.list", // "parameterOrder": [ @@ -9939,7 +10013,7 @@ func (c *PermissionsListCall) Do(opts ...googleapi.CallOption) (*PermissionList, // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, @@ -9999,7 +10073,9 @@ type PermissionsUpdateCall struct { header_ http.Header } -// Update: Updates a permission with patch semantics. +// Update: Updates a permission with patch semantics. **Warning:** +// Concurrent permissions operations on the same file are not supported; +// only the last update is applied. // // - fileId: The ID of the file or shared drive. // - permissionId: The ID of the permission. @@ -10027,7 +10103,7 @@ func (c *PermissionsUpdateCall) SupportsAllDrives(supportsAllDrives bool) *Permi } // SupportsTeamDrives sets the optional parameter "supportsTeamDrives": -// Deprecated use supportsAllDrives instead. +// Deprecated: Use `supportsAllDrives` instead. func (c *PermissionsUpdateCall) SupportsTeamDrives(supportsTeamDrives bool) *PermissionsUpdateCall { c.urlParams_.Set("supportsTeamDrives", fmt.Sprint(supportsTeamDrives)) return c @@ -10036,12 +10112,7 @@ func (c *PermissionsUpdateCall) SupportsTeamDrives(supportsTeamDrives bool) *Per // TransferOwnership sets the optional parameter "transferOwnership": // Whether to transfer ownership to the specified user and downgrade the // current owner to a writer. This parameter is required as an -// acknowledgement of the side effect. File owners can only transfer -// ownership of files existing on My Drive. Files existing in a shared -// drive are owned by the organization that owns that shared drive. -// Ownership transfers are not supported for files and folders in shared -// drives. Organizers of a shared drive can move items from that shared -// drive into their My Drive which transfers the ownership to them. +// acknowledgement of the side effect. func (c *PermissionsUpdateCall) TransferOwnership(transferOwnership bool) *PermissionsUpdateCall { c.urlParams_.Set("transferOwnership", fmt.Sprint(transferOwnership)) return c @@ -10149,7 +10220,8 @@ func (c *PermissionsUpdateCall) Do(opts ...googleapi.CallOption) (*Permission, e } return ret, nil // { - // "description": "Updates a permission with patch semantics.", + // "description": "Updates a permission with patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.", + // "flatPath": "files/{fileId}/permissions/{permissionId}", // "httpMethod": "PATCH", // "id": "drive.permissions.update", // "parameterOrder": [ @@ -10183,13 +10255,13 @@ func (c *PermissionsUpdateCall) Do(opts ...googleapi.CallOption) (*Permission, e // }, // "supportsTeamDrives": { // "default": "false", - // "description": "Deprecated use supportsAllDrives instead.", + // "description": "Deprecated: Use `supportsAllDrives` instead.", // "location": "query", // "type": "boolean" // }, // "transferOwnership": { // "default": "false", - // "description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them.", + // "description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.", // "location": "query", // "type": "boolean" // }, @@ -10332,6 +10404,7 @@ func (c *RepliesCreateCall) Do(opts ...googleapi.CallOption) (*Reply, error) { return ret, nil // { // "description": "Creates a reply to a comment.", + // "flatPath": "files/{fileId}/comments/{commentId}/replies", // "httpMethod": "POST", // "id": "drive.replies.create", // "parameterOrder": [ @@ -10456,6 +10529,7 @@ func (c *RepliesDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Deletes a reply.", + // "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", // "httpMethod": "DELETE", // "id": "drive.replies.delete", // "parameterOrder": [ @@ -10628,6 +10702,7 @@ func (c *RepliesGetCall) Do(opts ...googleapi.CallOption) (*Reply, error) { return ret, nil // { // "description": "Gets a reply by ID.", + // "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", // "httpMethod": "GET", // "id": "drive.replies.get", // "parameterOrder": [ @@ -10821,6 +10896,7 @@ func (c *RepliesListCall) Do(opts ...googleapi.CallOption) (*ReplyList, error) { return ret, nil // { // "description": "Lists a comment's replies.", + // "flatPath": "files/{fileId}/comments/{commentId}/replies", // "httpMethod": "GET", // "id": "drive.replies.list", // "parameterOrder": [ @@ -11016,6 +11092,7 @@ func (c *RepliesUpdateCall) Do(opts ...googleapi.CallOption) (*Reply, error) { return ret, nil // { // "description": "Updates a reply with patch semantics.", + // "flatPath": "files/{fileId}/comments/{commentId}/replies/{replyId}", // "httpMethod": "PATCH", // "id": "drive.replies.update", // "parameterOrder": [ @@ -11146,6 +11223,7 @@ func (c *RevisionsDeleteCall) Do(opts ...googleapi.CallOption) error { return nil // { // "description": "Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.", + // "flatPath": "files/{fileId}/revisions/{revisionId}", // "httpMethod": "DELETE", // "id": "drive.revisions.delete", // "parameterOrder": [ @@ -11325,6 +11403,7 @@ func (c *RevisionsGetCall) Do(opts ...googleapi.CallOption) (*Revision, error) { return ret, nil // { // "description": "Gets a revision's metadata or content by ID.", + // "flatPath": "files/{fileId}/revisions/{revisionId}", // "httpMethod": "GET", // "id": "drive.revisions.get", // "parameterOrder": [ @@ -11505,6 +11584,7 @@ func (c *RevisionsListCall) Do(opts ...googleapi.CallOption) (*RevisionList, err return ret, nil // { // "description": "Lists a file's revisions.", + // "flatPath": "files/{fileId}/revisions", // "httpMethod": "GET", // "id": "drive.revisions.list", // "parameterOrder": [ @@ -11687,6 +11767,7 @@ func (c *RevisionsUpdateCall) Do(opts ...googleapi.CallOption) (*Revision, error return ret, nil // { // "description": "Updates a revision with patch semantics.", + // "flatPath": "files/{fileId}/revisions/{revisionId}", // "httpMethod": "PATCH", // "id": "drive.revisions.update", // "parameterOrder": [ @@ -11733,7 +11814,7 @@ type TeamdrivesCreateCall struct { header_ http.Header } -// Create: Deprecated use drives.create instead. +// Create: Deprecated: Use `drives.create` instead. // // - requestId: An ID, such as a random UUID, which uniquely identifies // this user's request for idempotent creation of a Team Drive. A @@ -11836,7 +11917,8 @@ func (c *TeamdrivesCreateCall) Do(opts ...googleapi.CallOption) (*TeamDrive, err } return ret, nil // { - // "description": "Deprecated use drives.create instead.", + // "description": "Deprecated: Use `drives.create` instead.", + // "flatPath": "teamdrives", // "httpMethod": "POST", // "id": "drive.teamdrives.create", // "parameterOrder": [ @@ -11844,7 +11926,7 @@ func (c *TeamdrivesCreateCall) Do(opts ...googleapi.CallOption) (*TeamDrive, err // ], // "parameters": { // "requestId": { - // "description": "An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.", + // "description": "Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.", // "location": "query", // "required": true, // "type": "string" @@ -11874,7 +11956,7 @@ type TeamdrivesDeleteCall struct { header_ http.Header } -// Delete: Deprecated use drives.delete instead. +// Delete: Deprecated: Use `drives.delete` instead. // // - teamDriveId: The ID of the Team Drive. func (r *TeamdrivesService) Delete(teamDriveId string) *TeamdrivesDeleteCall { @@ -11944,7 +12026,8 @@ func (c *TeamdrivesDeleteCall) Do(opts ...googleapi.CallOption) error { } return nil // { - // "description": "Deprecated use drives.delete instead.", + // "description": "Deprecated: Use `drives.delete` instead.", + // "flatPath": "teamdrives/{teamDriveId}", // "httpMethod": "DELETE", // "id": "drive.teamdrives.delete", // "parameterOrder": [ @@ -11977,7 +12060,7 @@ type TeamdrivesGetCall struct { header_ http.Header } -// Get: Deprecated use drives.get instead. +// Get: Deprecated: Use `drives.get` instead. // // - teamDriveId: The ID of the Team Drive. func (r *TeamdrivesService) Get(teamDriveId string) *TeamdrivesGetCall { @@ -12094,7 +12177,8 @@ func (c *TeamdrivesGetCall) Do(opts ...googleapi.CallOption) (*TeamDrive, error) } return ret, nil // { - // "description": "Deprecated use drives.get instead.", + // "description": "Deprecated: Use `drives.get` instead.", + // "flatPath": "teamdrives/{teamDriveId}", // "httpMethod": "GET", // "id": "drive.teamdrives.get", // "parameterOrder": [ @@ -12136,7 +12220,7 @@ type TeamdrivesListCall struct { header_ http.Header } -// List: Deprecated use drives.list instead. +// List: Deprecated: Use `drives.list` instead. func (r *TeamdrivesService) List() *TeamdrivesListCall { c := &TeamdrivesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} return c @@ -12268,9 +12352,11 @@ func (c *TeamdrivesListCall) Do(opts ...googleapi.CallOption) (*TeamDriveList, e } return ret, nil // { - // "description": "Deprecated use drives.list instead.", + // "description": "Deprecated: Use `drives.list` instead.", + // "flatPath": "teamdrives", // "httpMethod": "GET", // "id": "drive.teamdrives.list", + // "parameterOrder": [], // "parameters": { // "pageSize": { // "default": "10", @@ -12342,7 +12428,7 @@ type TeamdrivesUpdateCall struct { header_ http.Header } -// Update: Deprecated use drives.update instead +// Update: Deprecated: Use `drives.update` instead. // // - teamDriveId: The ID of the Team Drive. func (r *TeamdrivesService) Update(teamDriveId string, teamdrive *TeamDrive) *TeamdrivesUpdateCall { @@ -12452,7 +12538,8 @@ func (c *TeamdrivesUpdateCall) Do(opts ...googleapi.CallOption) (*TeamDrive, err } return ret, nil // { - // "description": "Deprecated use drives.update instead", + // "description": "Deprecated: Use `drives.update` instead.", + // "flatPath": "teamdrives/{teamDriveId}", // "httpMethod": "PATCH", // "id": "drive.teamdrives.update", // "parameterOrder": [ diff --git a/firebaseappcheck/v1/firebaseappcheck-api.json b/firebaseappcheck/v1/firebaseappcheck-api.json index 385e13a7023..b4076b81654 100644 --- a/firebaseappcheck/v1/firebaseappcheck-api.json +++ b/firebaseappcheck/v1/firebaseappcheck-api.json @@ -1107,6 +1107,7 @@ } }, "safetyNetConfig": { + "deprecated": true, "methods": { "batchGet": { "deprecated": true, @@ -1342,7 +1343,7 @@ } } }, - "revision": "20230425", + "revision": "20230522", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1AppAttestConfig": { diff --git a/firebaseappcheck/v1beta/firebaseappcheck-api.json b/firebaseappcheck/v1beta/firebaseappcheck-api.json index 9b8bd998231..c6e9cde3399 100644 --- a/firebaseappcheck/v1beta/firebaseappcheck-api.json +++ b/firebaseappcheck/v1beta/firebaseappcheck-api.json @@ -974,6 +974,7 @@ } }, "recaptchaConfig": { + "deprecated": true, "methods": { "batchGet": { "deprecated": true, @@ -1268,6 +1269,7 @@ } }, "safetyNetConfig": { + "deprecated": true, "methods": { "batchGet": { "deprecated": true, @@ -1503,7 +1505,7 @@ } } }, - "revision": "20230515", + "revision": "20230522", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1betaAppAttestConfig": { @@ -2129,7 +2131,7 @@ "ENFORCED" ], "enumDescriptions": [ - "Firebase App Check is not enforced for the service, nor are App Check metrics collected. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. An unconfigured service is in this mode by default.", + "Firebase App Check is not enforced for the service, nor are App Check metrics collected. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. An unconfigured service is in this mode by default. Note that resource policies behave slightly differently as an unconfigured resource policy means that the resource will inherit the EnforcementMode configured for the service it belongs to and will not be considered as being in OFF mode by default.", "Firebase App Check is not enforced for the service. App Check metrics are collected to help you decide when to turn on enforcement for the service. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced.", "Firebase App Check is enforced for the service. The service will reject any request that attempts to access your project's resources if it does not have valid App Check token attached, with some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check on a Firebase service. If your users have not updated to an App Check capable version of your app, their apps will no longer be able to use your Firebase services that are enforcing App Check. App Check metrics can help you decide whether to enforce App Check on your Firebase services. If your app has not launched yet, you should enable enforcement immediately, since there are no outdated clients in use." ], diff --git a/firebaseappcheck/v1beta/firebaseappcheck-gen.go b/firebaseappcheck/v1beta/firebaseappcheck-gen.go index fb1677c22e0..b089c662989 100644 --- a/firebaseappcheck/v1beta/firebaseappcheck-gen.go +++ b/firebaseappcheck/v1beta/firebaseappcheck-gen.go @@ -1735,7 +1735,11 @@ type GoogleFirebaseAppcheckV1betaService struct { // App Check metrics collected. Though the service is not protected by // App Check in this mode, other applicable protections, such as user // authorization, are still enforced. An unconfigured service is in this - // mode by default. + // mode by default. Note that resource policies behave slightly + // differently as an unconfigured resource policy means that the + // resource will inherit the EnforcementMode configured for the service + // it belongs to and will not be considered as being in OFF mode by + // default. // "UNENFORCED" - Firebase App Check is not enforced for the service. // App Check metrics are collected to help you decide when to turn on // enforcement for the service. Though the service is not protected by diff --git a/firebasehosting/v1beta1/firebasehosting-api.json b/firebasehosting/v1beta1/firebasehosting-api.json index 857359fbdd6..5957ac9b7f9 100644 --- a/firebasehosting/v1beta1/firebasehosting-api.json +++ b/firebasehosting/v1beta1/firebasehosting-api.json @@ -964,6 +964,7 @@ "type": "string" }, "versionId": { + "deprecated": true, "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" @@ -1863,6 +1864,7 @@ "type": "string" }, "versionId": { + "deprecated": true, "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" @@ -2107,7 +2109,7 @@ } } }, - "revision": "20230515", + "revision": "20230522", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "ActingUser": { diff --git a/firebasehosting/v1beta1/firebasehosting-gen.go b/firebasehosting/v1beta1/firebasehosting-gen.go index d0237afed20..abad36ced38 100644 --- a/firebasehosting/v1beta1/firebasehosting-gen.go +++ b/firebasehosting/v1beta1/firebasehosting-gen.go @@ -5973,6 +5973,7 @@ func (c *ProjectsSitesVersionsCreateCall) Do(opts ...googleapi.CallOption) (*Ver // "type": "string" // }, // "versionId": { + // "deprecated": true, // "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" @@ -10256,6 +10257,7 @@ func (c *SitesVersionsCreateCall) Do(opts ...googleapi.CallOption) (*Version, er // "type": "string" // }, // "versionId": { + // "deprecated": true, // "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" diff --git a/gkehub/v1/gkehub-api.json b/gkehub/v1/gkehub-api.json index 7781c1973fa..e73dc307989 100644 --- a/gkehub/v1/gkehub-api.json +++ b/gkehub/v1/gkehub-api.json @@ -876,6 +876,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Lists MembershipBindings that match the filter expression, following the syntax outlined in https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.", "format": "int32", @@ -1149,6 +1154,37 @@ "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:getIamPolicy", + "httpMethod": "GET", + "id": "gkehub.projects.locations.scopes.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists Scopes.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/scopes", @@ -1184,6 +1220,62 @@ "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:setIamPolicy", + "httpMethod": "POST", + "id": "gkehub.projects.locations.scopes.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:testIamPermissions", + "httpMethod": "POST", + "id": "gkehub.projects.locations.scopes.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -1192,7 +1284,7 @@ } } }, - "revision": "20230430", + "revision": "20230515", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2346,7 +2438,7 @@ "type": "object" }, "FleetObservabilityFeatureState": { - "description": "**FleetObservability**: An empty state left as an example Hub-wide Feature state.", + "description": "**FleetObservability**: Hub-wide Feature for FleetObservability feature. state.", "id": "FleetObservabilityFeatureState", "properties": {}, "type": "object" @@ -2358,7 +2450,7 @@ "type": "object" }, "FleetObservabilityMembershipState": { - "description": "**FleetObservability**: An empty state left as an example membership-specific Feature state.", + "description": "**FleetObservability**: Membership-specific Feature state for fleetobservability.", "id": "FleetObservabilityMembershipState", "properties": {}, "type": "object" @@ -2919,7 +3011,7 @@ "type": "string" }, "scope": { - "description": "A Workspace resource name in the format `projects/*/locations/*/scopes/*`.", + "description": "A Scope resource name in the format `projects/*/locations/*/scopes/*`.", "type": "string" }, "state": { diff --git a/gkehub/v1/gkehub-gen.go b/gkehub/v1/gkehub-gen.go index 6b8be478c79..8fbea0c408a 100644 --- a/gkehub/v1/gkehub-gen.go +++ b/gkehub/v1/gkehub-gen.go @@ -2064,8 +2064,8 @@ func (s *FeatureState) MarshalJSON() ([]byte, error) { type FleetObservabilityFeatureSpec struct { } -// FleetObservabilityFeatureState: **FleetObservability**: An empty -// state left as an example Hub-wide Feature state. +// FleetObservabilityFeatureState: **FleetObservability**: Hub-wide +// Feature for FleetObservability feature. state. type FleetObservabilityFeatureState struct { } @@ -2074,8 +2074,8 @@ type FleetObservabilityFeatureState struct { type FleetObservabilityMembershipSpec struct { } -// FleetObservabilityMembershipState: **FleetObservability**: An empty -// state left as an example membership-specific Feature state. +// FleetObservabilityMembershipState: **FleetObservability**: +// Membership-specific Feature state for fleetobservability. type FleetObservabilityMembershipState struct { } @@ -2965,7 +2965,7 @@ type MembershipBinding struct { // ings/{membershipbinding}` Name string `json:"name,omitempty"` - // Scope: A Workspace resource name in the format + // Scope: A Scope resource name in the format // `projects/*/locations/*/scopes/*`. Scope string `json:"scope,omitempty"` @@ -8028,6 +8028,14 @@ func (r *ProjectsLocationsMembershipsBindingsService) List(parent string) *Proje return c } +// Filter sets the optional parameter "filter": Lists MembershipBindings +// that match the filter expression, following the syntax outlined in +// https://google.aip.dev/160. +func (c *ProjectsLocationsMembershipsBindingsListCall) Filter(filter string) *ProjectsLocationsMembershipsBindingsListCall { + c.urlParams_.Set("filter", filter) + return c +} + // PageSize sets the optional parameter "pageSize": When requesting a // 'page' of resources, `page_size` specifies number of resources to // return. If unspecified or set to 0, all resources will be returned. @@ -8151,6 +8159,11 @@ func (c *ProjectsLocationsMembershipsBindingsListCall) Do(opts ...googleapi.Call // "parent" // ], // "parameters": { + // "filter": { + // "description": "Optional. Lists MembershipBindings that match the filter expression, following the syntax outlined in https://google.aip.dev/160.", + // "location": "query", + // "type": "string" + // }, // "pageSize": { // "description": "Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.", // "format": "int32", @@ -9434,6 +9447,181 @@ func (c *ProjectsLocationsScopesGetCall) Do(opts ...googleapi.CallOption) (*Scop } +// method id "gkehub.projects.locations.scopes.getIamPolicy": + +type ProjectsLocationsScopesGetIamPolicyCall struct { + s *Service + resource string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// GetIamPolicy: Gets the access control policy for a resource. Returns +// an empty policy if the resource exists and does not have a policy +// set. +// +// - resource: REQUIRED: The resource for which the policy is being +// requested. See Resource names +// (https://cloud.google.com/apis/design/resource_names) for the +// appropriate value for this field. +func (r *ProjectsLocationsScopesService) GetIamPolicy(resource string) *ProjectsLocationsScopesGetIamPolicyCall { + c := &ProjectsLocationsScopesGetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.resource = resource + return c +} + +// OptionsRequestedPolicyVersion sets the optional parameter +// "options.requestedPolicyVersion": The maximum policy version that +// will be used to format the policy. Valid values are 0, 1, and 3. +// Requests specifying an invalid value will be rejected. Requests for +// policies with any conditional role bindings must specify version 3. +// Policies with no conditional role bindings may specify any valid +// value or leave the field unset. The policy in the response might use +// the policy version that you specified, or it might use a lower policy +// version. For example, if you specify version 3, but the policy has no +// conditional role bindings, the response uses version 1. To learn +// which resources support conditions in their IAM policies, see the IAM +// documentation +// (https://cloud.google.com/iam/help/conditions/resource-policies). +func (c *ProjectsLocationsScopesGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsScopesGetIamPolicyCall { + c.urlParams_.Set("options.requestedPolicyVersion", fmt.Sprint(optionsRequestedPolicyVersion)) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsScopesGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsScopesGetIamPolicyCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsScopesGetIamPolicyCall) IfNoneMatch(entityTag string) *ProjectsLocationsScopesGetIamPolicyCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsScopesGetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsScopesGetIamPolicyCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsScopesGetIamPolicyCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsScopesGetIamPolicyCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+resource}:getIamPolicy") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "resource": c.resource, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "gkehub.projects.locations.scopes.getIamPolicy" call. +// Exactly one of *Policy or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Policy.ServerResponse.Header or (if a response was returned at all) +// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified +// was returned. +func (c *ProjectsLocationsScopesGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Policy{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:getIamPolicy", + // "httpMethod": "GET", + // "id": "gkehub.projects.locations.scopes.getIamPolicy", + // "parameterOrder": [ + // "resource" + // ], + // "parameters": { + // "options.requestedPolicyVersion": { + // "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "resource": { + // "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+resource}:getIamPolicy", + // "response": { + // "$ref": "Policy" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "gkehub.projects.locations.scopes.list": type ProjectsLocationsScopesListCall struct { @@ -9628,3 +9816,300 @@ func (c *ProjectsLocationsScopesListCall) Pages(ctx context.Context, f func(*Lis c.PageToken(x.NextPageToken) } } + +// method id "gkehub.projects.locations.scopes.setIamPolicy": + +type ProjectsLocationsScopesSetIamPolicyCall struct { + s *Service + resource string + setiampolicyrequest *SetIamPolicyRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// SetIamPolicy: Sets the access control policy on the specified +// resource. Replaces any existing policy. Can return `NOT_FOUND`, +// `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. +// +// - resource: REQUIRED: The resource for which the policy is being +// specified. See Resource names +// (https://cloud.google.com/apis/design/resource_names) for the +// appropriate value for this field. +func (r *ProjectsLocationsScopesService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsScopesSetIamPolicyCall { + c := &ProjectsLocationsScopesSetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.resource = resource + c.setiampolicyrequest = setiampolicyrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsScopesSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsScopesSetIamPolicyCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsScopesSetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsScopesSetIamPolicyCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsScopesSetIamPolicyCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsScopesSetIamPolicyCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.setiampolicyrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+resource}:setIamPolicy") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "resource": c.resource, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "gkehub.projects.locations.scopes.setIamPolicy" call. +// Exactly one of *Policy or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Policy.ServerResponse.Header or (if a response was returned at all) +// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified +// was returned. +func (c *ProjectsLocationsScopesSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Policy{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:setIamPolicy", + // "httpMethod": "POST", + // "id": "gkehub.projects.locations.scopes.setIamPolicy", + // "parameterOrder": [ + // "resource" + // ], + // "parameters": { + // "resource": { + // "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+resource}:setIamPolicy", + // "request": { + // "$ref": "SetIamPolicyRequest" + // }, + // "response": { + // "$ref": "Policy" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "gkehub.projects.locations.scopes.testIamPermissions": + +type ProjectsLocationsScopesTestIamPermissionsCall struct { + s *Service + resource string + testiampermissionsrequest *TestIamPermissionsRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// TestIamPermissions: 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. +// +// - resource: REQUIRED: The resource for which the policy detail is +// being requested. See Resource names +// (https://cloud.google.com/apis/design/resource_names) for the +// appropriate value for this field. +func (r *ProjectsLocationsScopesService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsScopesTestIamPermissionsCall { + c := &ProjectsLocationsScopesTestIamPermissionsCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.resource = resource + c.testiampermissionsrequest = testiampermissionsrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsScopesTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsLocationsScopesTestIamPermissionsCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsScopesTestIamPermissionsCall) Context(ctx context.Context) *ProjectsLocationsScopesTestIamPermissionsCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsScopesTestIamPermissionsCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsScopesTestIamPermissionsCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.testiampermissionsrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+resource}:testIamPermissions") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "resource": c.resource, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "gkehub.projects.locations.scopes.testIamPermissions" call. +// Exactly one of *TestIamPermissionsResponse or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *TestIamPermissionsResponse.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsScopesTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &TestIamPermissionsResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "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.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:testIamPermissions", + // "httpMethod": "POST", + // "id": "gkehub.projects.locations.scopes.testIamPermissions", + // "parameterOrder": [ + // "resource" + // ], + // "parameters": { + // "resource": { + // "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+resource}:testIamPermissions", + // "request": { + // "$ref": "TestIamPermissionsRequest" + // }, + // "response": { + // "$ref": "TestIamPermissionsResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} diff --git a/gkehub/v1alpha/gkehub-api.json b/gkehub/v1alpha/gkehub-api.json index 680ac860509..143f76ec79b 100644 --- a/gkehub/v1alpha/gkehub-api.json +++ b/gkehub/v1alpha/gkehub-api.json @@ -1150,6 +1150,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Lists MembershipBindings that match the filter expression, following the syntax outlined in https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.", "format": "int32", @@ -1739,6 +1744,37 @@ "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.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:getIamPolicy", + "httpMethod": "GET", + "id": "gkehub.projects.locations.scopes.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists Scopes.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/scopes", @@ -1808,6 +1844,62 @@ "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.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:setIamPolicy", + "httpMethod": "POST", + "id": "gkehub.projects.locations.scopes.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+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.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:testIamPermissions", + "httpMethod": "POST", + "id": "gkehub.projects.locations.scopes.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -1816,7 +1908,7 @@ } } }, - "revision": "20230430", + "revision": "20230515", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -3217,7 +3309,7 @@ "type": "object" }, "FleetObservabilityFeatureState": { - "description": "**FleetObservability**: An empty state left as an example Hub-wide Feature state.", + "description": "**FleetObservability**: Hub-wide Feature for FleetObservability feature. state.", "id": "FleetObservabilityFeatureState", "properties": {}, "type": "object" @@ -3244,7 +3336,7 @@ "type": "object" }, "FleetObservabilityMembershipState": { - "description": "**FleetObservability**: An empty state left as an example membership-specific Feature state.", + "description": "**FleetObservability**: Membership-specific Feature state for fleetobservability.", "id": "FleetObservabilityMembershipState", "properties": {}, "type": "object" @@ -3905,7 +3997,7 @@ "type": "string" }, "scope": { - "description": "A Workspace resource name in the format `projects/*/locations/*/scopes/*`.", + "description": "A Scope resource name in the format `projects/*/locations/*/scopes/*`.", "type": "string" }, "state": { @@ -5411,8 +5503,8 @@ ], "enumDescriptions": [ "UNSPECIFIED validator.", - "MEMBERSHIP_ID validator validates the membership_id is still available.", - "CROSS_PROJECT_PERMISSION validator validates the cross-project P4SA binding is in place." + "MEMBERSHIP_ID validator validates that the membership_id is still available.", + "CROSS_PROJECT_PERMISSION validator validates that the cross-project role binding for the service agent is in place." ], "type": "string" } diff --git a/gkehub/v1alpha/gkehub-gen.go b/gkehub/v1alpha/gkehub-gen.go index 4c44f422402..42e4eb1d60d 100644 --- a/gkehub/v1alpha/gkehub-gen.go +++ b/gkehub/v1alpha/gkehub-gen.go @@ -2581,8 +2581,8 @@ func (s *FleetObservabilityFeatureSpec) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// FleetObservabilityFeatureState: **FleetObservability**: An empty -// state left as an example Hub-wide Feature state. +// FleetObservabilityFeatureState: **FleetObservability**: Hub-wide +// Feature for FleetObservability feature. state. type FleetObservabilityFeatureState struct { } @@ -2625,8 +2625,8 @@ func (s *FleetObservabilityLoggingConfig) MarshalJSON() ([]byte, error) { type FleetObservabilityMembershipSpec struct { } -// FleetObservabilityMembershipState: **FleetObservability**: An empty -// state left as an example membership-specific Feature state. +// FleetObservabilityMembershipState: **FleetObservability**: +// Membership-specific Feature state for fleetobservability. type FleetObservabilityMembershipState struct { } @@ -3708,7 +3708,7 @@ type MembershipBinding struct { // ings/{membershipbinding}` Name string `json:"name,omitempty"` - // Scope: A Workspace resource name in the format + // Scope: A Scope resource name in the format // `projects/*/locations/*/scopes/*`. Scope string `json:"scope,omitempty"` @@ -6174,10 +6174,11 @@ type ValidationResult struct { // // Possible values: // "VALIDATOR_TYPE_UNSPECIFIED" - UNSPECIFIED validator. - // "MEMBERSHIP_ID" - MEMBERSHIP_ID validator validates the + // "MEMBERSHIP_ID" - MEMBERSHIP_ID validator validates that the // membership_id is still available. // "CROSS_PROJECT_PERMISSION" - CROSS_PROJECT_PERMISSION validator - // validates the cross-project P4SA binding is in place. + // validates that the cross-project role binding for the service agent + // is in place. Validator string `json:"validator,omitempty"` // ForceSendFields is a list of field names (e.g. "Result") to @@ -11348,6 +11349,14 @@ func (r *ProjectsLocationsMembershipsBindingsService) List(parent string) *Proje return c } +// Filter sets the optional parameter "filter": Lists MembershipBindings +// that match the filter expression, following the syntax outlined in +// https://google.aip.dev/160. +func (c *ProjectsLocationsMembershipsBindingsListCall) Filter(filter string) *ProjectsLocationsMembershipsBindingsListCall { + c.urlParams_.Set("filter", filter) + return c +} + // PageSize sets the optional parameter "pageSize": When requesting a // 'page' of resources, `page_size` specifies number of resources to // return. If unspecified or set to 0, all resources will be returned. @@ -11471,6 +11480,11 @@ func (c *ProjectsLocationsMembershipsBindingsListCall) Do(opts ...googleapi.Call // "parent" // ], // "parameters": { + // "filter": { + // "description": "Optional. Lists MembershipBindings that match the filter expression, following the syntax outlined in https://google.aip.dev/160.", + // "location": "query", + // "type": "string" + // }, // "pageSize": { // "description": "Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.", // "format": "int32", @@ -14342,6 +14356,181 @@ func (c *ProjectsLocationsScopesGetCall) Do(opts ...googleapi.CallOption) (*Scop } +// method id "gkehub.projects.locations.scopes.getIamPolicy": + +type ProjectsLocationsScopesGetIamPolicyCall struct { + s *Service + resource string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// GetIamPolicy: Gets the access control policy for a resource. Returns +// an empty policy if the resource exists and does not have a policy +// set. +// +// - resource: REQUIRED: The resource for which the policy is being +// requested. See Resource names +// (https://cloud.google.com/apis/design/resource_names) for the +// appropriate value for this field. +func (r *ProjectsLocationsScopesService) GetIamPolicy(resource string) *ProjectsLocationsScopesGetIamPolicyCall { + c := &ProjectsLocationsScopesGetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.resource = resource + return c +} + +// OptionsRequestedPolicyVersion sets the optional parameter +// "options.requestedPolicyVersion": The maximum policy version that +// will be used to format the policy. Valid values are 0, 1, and 3. +// Requests specifying an invalid value will be rejected. Requests for +// policies with any conditional role bindings must specify version 3. +// Policies with no conditional role bindings may specify any valid +// value or leave the field unset. The policy in the response might use +// the policy version that you specified, or it might use a lower policy +// version. For example, if you specify version 3, but the policy has no +// conditional role bindings, the response uses version 1. To learn +// which resources support conditions in their IAM policies, see the IAM +// documentation +// (https://cloud.google.com/iam/help/conditions/resource-policies). +func (c *ProjectsLocationsScopesGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsScopesGetIamPolicyCall { + c.urlParams_.Set("options.requestedPolicyVersion", fmt.Sprint(optionsRequestedPolicyVersion)) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsScopesGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsScopesGetIamPolicyCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsScopesGetIamPolicyCall) IfNoneMatch(entityTag string) *ProjectsLocationsScopesGetIamPolicyCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsScopesGetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsScopesGetIamPolicyCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsScopesGetIamPolicyCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsScopesGetIamPolicyCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+resource}:getIamPolicy") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "resource": c.resource, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "gkehub.projects.locations.scopes.getIamPolicy" call. +// Exactly one of *Policy or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Policy.ServerResponse.Header or (if a response was returned at all) +// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified +// was returned. +func (c *ProjectsLocationsScopesGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Policy{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + // "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:getIamPolicy", + // "httpMethod": "GET", + // "id": "gkehub.projects.locations.scopes.getIamPolicy", + // "parameterOrder": [ + // "resource" + // ], + // "parameters": { + // "options.requestedPolicyVersion": { + // "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "resource": { + // "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1alpha/{+resource}:getIamPolicy", + // "response": { + // "$ref": "Policy" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "gkehub.projects.locations.scopes.list": type ProjectsLocationsScopesListCall struct { @@ -14692,3 +14881,300 @@ func (c *ProjectsLocationsScopesPatchCall) Do(opts ...googleapi.CallOption) (*Op // } } + +// method id "gkehub.projects.locations.scopes.setIamPolicy": + +type ProjectsLocationsScopesSetIamPolicyCall struct { + s *Service + resource string + setiampolicyrequest *SetIamPolicyRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// SetIamPolicy: Sets the access control policy on the specified +// resource. Replaces any existing policy. Can return `NOT_FOUND`, +// `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. +// +// - resource: REQUIRED: The resource for which the policy is being +// specified. See Resource names +// (https://cloud.google.com/apis/design/resource_names) for the +// appropriate value for this field. +func (r *ProjectsLocationsScopesService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsScopesSetIamPolicyCall { + c := &ProjectsLocationsScopesSetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.resource = resource + c.setiampolicyrequest = setiampolicyrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsScopesSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsScopesSetIamPolicyCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsScopesSetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsScopesSetIamPolicyCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsScopesSetIamPolicyCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsScopesSetIamPolicyCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.setiampolicyrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+resource}:setIamPolicy") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "resource": c.resource, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "gkehub.projects.locations.scopes.setIamPolicy" call. +// Exactly one of *Policy or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Policy.ServerResponse.Header or (if a response was returned at all) +// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified +// was returned. +func (c *ProjectsLocationsScopesSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Policy{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + // "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:setIamPolicy", + // "httpMethod": "POST", + // "id": "gkehub.projects.locations.scopes.setIamPolicy", + // "parameterOrder": [ + // "resource" + // ], + // "parameters": { + // "resource": { + // "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1alpha/{+resource}:setIamPolicy", + // "request": { + // "$ref": "SetIamPolicyRequest" + // }, + // "response": { + // "$ref": "Policy" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "gkehub.projects.locations.scopes.testIamPermissions": + +type ProjectsLocationsScopesTestIamPermissionsCall struct { + s *Service + resource string + testiampermissionsrequest *TestIamPermissionsRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// TestIamPermissions: 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. +// +// - resource: REQUIRED: The resource for which the policy detail is +// being requested. See Resource names +// (https://cloud.google.com/apis/design/resource_names) for the +// appropriate value for this field. +func (r *ProjectsLocationsScopesService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsScopesTestIamPermissionsCall { + c := &ProjectsLocationsScopesTestIamPermissionsCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.resource = resource + c.testiampermissionsrequest = testiampermissionsrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsScopesTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsLocationsScopesTestIamPermissionsCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsScopesTestIamPermissionsCall) Context(ctx context.Context) *ProjectsLocationsScopesTestIamPermissionsCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsScopesTestIamPermissionsCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsScopesTestIamPermissionsCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.testiampermissionsrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+resource}:testIamPermissions") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "resource": c.resource, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "gkehub.projects.locations.scopes.testIamPermissions" call. +// Exactly one of *TestIamPermissionsResponse or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *TestIamPermissionsResponse.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsScopesTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &TestIamPermissionsResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "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.", + // "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:testIamPermissions", + // "httpMethod": "POST", + // "id": "gkehub.projects.locations.scopes.testIamPermissions", + // "parameterOrder": [ + // "resource" + // ], + // "parameters": { + // "resource": { + // "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1alpha/{+resource}:testIamPermissions", + // "request": { + // "$ref": "TestIamPermissionsRequest" + // }, + // "response": { + // "$ref": "TestIamPermissionsResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} diff --git a/gkehub/v1beta/gkehub-api.json b/gkehub/v1beta/gkehub-api.json index 7f936b855b5..2db77bf1593 100644 --- a/gkehub/v1beta/gkehub-api.json +++ b/gkehub/v1beta/gkehub-api.json @@ -836,6 +836,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Lists MembershipBindings that match the filter expression, following the syntax outlined in https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.", "format": "int32", @@ -1425,6 +1430,37 @@ "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.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:getIamPolicy", + "httpMethod": "GET", + "id": "gkehub.projects.locations.scopes.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists Scopes.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/scopes", @@ -1494,6 +1530,62 @@ "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.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:setIamPolicy", + "httpMethod": "POST", + "id": "gkehub.projects.locations.scopes.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + "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.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:testIamPermissions", + "httpMethod": "POST", + "id": "gkehub.projects.locations.scopes.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -1502,7 +1594,7 @@ } } }, - "revision": "20230430", + "revision": "20230515", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2764,7 +2856,7 @@ "type": "object" }, "FleetObservabilityFeatureState": { - "description": "**FleetObservability**: An empty state left as an example Hub-wide Feature state.", + "description": "**FleetObservability**: Hub-wide Feature for FleetObservability feature. state.", "id": "FleetObservabilityFeatureState", "properties": {}, "type": "object" @@ -2791,7 +2883,7 @@ "type": "object" }, "FleetObservabilityMembershipState": { - "description": "**FleetObservability**: An empty state left as an example membership-specific Feature state.", + "description": "**FleetObservability**: Membership-specific Feature state for fleetobservability.", "id": "FleetObservabilityMembershipState", "properties": {}, "type": "object" @@ -3226,7 +3318,7 @@ "type": "string" }, "scope": { - "description": "A Workspace resource name in the format `projects/*/locations/*/scopes/*`.", + "description": "A Scope resource name in the format `projects/*/locations/*/scopes/*`.", "type": "string" }, "state": { diff --git a/gkehub/v1beta/gkehub-gen.go b/gkehub/v1beta/gkehub-gen.go index 1e8b81d7b02..d81cd380c7b 100644 --- a/gkehub/v1beta/gkehub-gen.go +++ b/gkehub/v1beta/gkehub-gen.go @@ -2304,8 +2304,8 @@ func (s *FleetObservabilityFeatureSpec) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// FleetObservabilityFeatureState: **FleetObservability**: An empty -// state left as an example Hub-wide Feature state. +// FleetObservabilityFeatureState: **FleetObservability**: Hub-wide +// Feature for FleetObservability feature. state. type FleetObservabilityFeatureState struct { } @@ -2348,8 +2348,8 @@ func (s *FleetObservabilityLoggingConfig) MarshalJSON() ([]byte, error) { type FleetObservabilityMembershipSpec struct { } -// FleetObservabilityMembershipState: **FleetObservability**: An empty -// state left as an example membership-specific Feature state. +// FleetObservabilityMembershipState: **FleetObservability**: +// Membership-specific Feature state for fleetobservability. type FleetObservabilityMembershipState struct { } @@ -3065,7 +3065,7 @@ type MembershipBinding struct { // ings/{membershipbinding}` Name string `json:"name,omitempty"` - // Scope: A Workspace resource name in the format + // Scope: A Scope resource name in the format // `projects/*/locations/*/scopes/*`. Scope string `json:"scope,omitempty"` @@ -8541,6 +8541,14 @@ func (r *ProjectsLocationsMembershipsBindingsService) List(parent string) *Proje return c } +// Filter sets the optional parameter "filter": Lists MembershipBindings +// that match the filter expression, following the syntax outlined in +// https://google.aip.dev/160. +func (c *ProjectsLocationsMembershipsBindingsListCall) Filter(filter string) *ProjectsLocationsMembershipsBindingsListCall { + c.urlParams_.Set("filter", filter) + return c +} + // PageSize sets the optional parameter "pageSize": When requesting a // 'page' of resources, `page_size` specifies number of resources to // return. If unspecified or set to 0, all resources will be returned. @@ -8664,6 +8672,11 @@ func (c *ProjectsLocationsMembershipsBindingsListCall) Do(opts ...googleapi.Call // "parent" // ], // "parameters": { + // "filter": { + // "description": "Optional. Lists MembershipBindings that match the filter expression, following the syntax outlined in https://google.aip.dev/160.", + // "location": "query", + // "type": "string" + // }, // "pageSize": { // "description": "Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.", // "format": "int32", @@ -11535,6 +11548,181 @@ func (c *ProjectsLocationsScopesGetCall) Do(opts ...googleapi.CallOption) (*Scop } +// method id "gkehub.projects.locations.scopes.getIamPolicy": + +type ProjectsLocationsScopesGetIamPolicyCall struct { + s *Service + resource string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// GetIamPolicy: Gets the access control policy for a resource. Returns +// an empty policy if the resource exists and does not have a policy +// set. +// +// - resource: REQUIRED: The resource for which the policy is being +// requested. See Resource names +// (https://cloud.google.com/apis/design/resource_names) for the +// appropriate value for this field. +func (r *ProjectsLocationsScopesService) GetIamPolicy(resource string) *ProjectsLocationsScopesGetIamPolicyCall { + c := &ProjectsLocationsScopesGetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.resource = resource + return c +} + +// OptionsRequestedPolicyVersion sets the optional parameter +// "options.requestedPolicyVersion": The maximum policy version that +// will be used to format the policy. Valid values are 0, 1, and 3. +// Requests specifying an invalid value will be rejected. Requests for +// policies with any conditional role bindings must specify version 3. +// Policies with no conditional role bindings may specify any valid +// value or leave the field unset. The policy in the response might use +// the policy version that you specified, or it might use a lower policy +// version. For example, if you specify version 3, but the policy has no +// conditional role bindings, the response uses version 1. To learn +// which resources support conditions in their IAM policies, see the IAM +// documentation +// (https://cloud.google.com/iam/help/conditions/resource-policies). +func (c *ProjectsLocationsScopesGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsScopesGetIamPolicyCall { + c.urlParams_.Set("options.requestedPolicyVersion", fmt.Sprint(optionsRequestedPolicyVersion)) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsScopesGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsScopesGetIamPolicyCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsScopesGetIamPolicyCall) IfNoneMatch(entityTag string) *ProjectsLocationsScopesGetIamPolicyCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsScopesGetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsScopesGetIamPolicyCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsScopesGetIamPolicyCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsScopesGetIamPolicyCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+resource}:getIamPolicy") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "resource": c.resource, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "gkehub.projects.locations.scopes.getIamPolicy" call. +// Exactly one of *Policy or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Policy.ServerResponse.Header or (if a response was returned at all) +// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified +// was returned. +func (c *ProjectsLocationsScopesGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Policy{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + // "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:getIamPolicy", + // "httpMethod": "GET", + // "id": "gkehub.projects.locations.scopes.getIamPolicy", + // "parameterOrder": [ + // "resource" + // ], + // "parameters": { + // "options.requestedPolicyVersion": { + // "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "resource": { + // "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1beta/{+resource}:getIamPolicy", + // "response": { + // "$ref": "Policy" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "gkehub.projects.locations.scopes.list": type ProjectsLocationsScopesListCall struct { @@ -11885,3 +12073,300 @@ func (c *ProjectsLocationsScopesPatchCall) Do(opts ...googleapi.CallOption) (*Op // } } + +// method id "gkehub.projects.locations.scopes.setIamPolicy": + +type ProjectsLocationsScopesSetIamPolicyCall struct { + s *Service + resource string + setiampolicyrequest *SetIamPolicyRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// SetIamPolicy: Sets the access control policy on the specified +// resource. Replaces any existing policy. Can return `NOT_FOUND`, +// `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. +// +// - resource: REQUIRED: The resource for which the policy is being +// specified. See Resource names +// (https://cloud.google.com/apis/design/resource_names) for the +// appropriate value for this field. +func (r *ProjectsLocationsScopesService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsScopesSetIamPolicyCall { + c := &ProjectsLocationsScopesSetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.resource = resource + c.setiampolicyrequest = setiampolicyrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsScopesSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsScopesSetIamPolicyCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsScopesSetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsScopesSetIamPolicyCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsScopesSetIamPolicyCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsScopesSetIamPolicyCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.setiampolicyrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+resource}:setIamPolicy") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "resource": c.resource, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "gkehub.projects.locations.scopes.setIamPolicy" call. +// Exactly one of *Policy or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Policy.ServerResponse.Header or (if a response was returned at all) +// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified +// was returned. +func (c *ProjectsLocationsScopesSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Policy{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + // "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:setIamPolicy", + // "httpMethod": "POST", + // "id": "gkehub.projects.locations.scopes.setIamPolicy", + // "parameterOrder": [ + // "resource" + // ], + // "parameters": { + // "resource": { + // "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1beta/{+resource}:setIamPolicy", + // "request": { + // "$ref": "SetIamPolicyRequest" + // }, + // "response": { + // "$ref": "Policy" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "gkehub.projects.locations.scopes.testIamPermissions": + +type ProjectsLocationsScopesTestIamPermissionsCall struct { + s *Service + resource string + testiampermissionsrequest *TestIamPermissionsRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// TestIamPermissions: 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. +// +// - resource: REQUIRED: The resource for which the policy detail is +// being requested. See Resource names +// (https://cloud.google.com/apis/design/resource_names) for the +// appropriate value for this field. +func (r *ProjectsLocationsScopesService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsScopesTestIamPermissionsCall { + c := &ProjectsLocationsScopesTestIamPermissionsCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.resource = resource + c.testiampermissionsrequest = testiampermissionsrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsScopesTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsLocationsScopesTestIamPermissionsCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsScopesTestIamPermissionsCall) Context(ctx context.Context) *ProjectsLocationsScopesTestIamPermissionsCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsScopesTestIamPermissionsCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsScopesTestIamPermissionsCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.testiampermissionsrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+resource}:testIamPermissions") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "resource": c.resource, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "gkehub.projects.locations.scopes.testIamPermissions" call. +// Exactly one of *TestIamPermissionsResponse or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *TestIamPermissionsResponse.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsScopesTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &TestIamPermissionsResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "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.", + // "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:testIamPermissions", + // "httpMethod": "POST", + // "id": "gkehub.projects.locations.scopes.testIamPermissions", + // "parameterOrder": [ + // "resource" + // ], + // "parameters": { + // "resource": { + // "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1beta/{+resource}:testIamPermissions", + // "request": { + // "$ref": "TestIamPermissionsRequest" + // }, + // "response": { + // "$ref": "TestIamPermissionsResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} diff --git a/gkehub/v1beta1/gkehub-api.json b/gkehub/v1beta1/gkehub-api.json index cce750d7969..5734d232cf9 100644 --- a/gkehub/v1beta1/gkehub-api.json +++ b/gkehub/v1beta1/gkehub-api.json @@ -262,6 +262,7 @@ ], "parameters": { "connectAgent.name": { + "deprecated": true, "description": "Do not set.", "location": "query", "type": "string" @@ -711,7 +712,7 @@ } } }, - "revision": "20230430", + "revision": "20230515", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "ApplianceCluster": { diff --git a/gkehub/v1beta1/gkehub-gen.go b/gkehub/v1beta1/gkehub-gen.go index 6ccbfd1c3de..d0baf268ae4 100644 --- a/gkehub/v1beta1/gkehub-gen.go +++ b/gkehub/v1beta1/gkehub-gen.go @@ -2757,6 +2757,7 @@ func (c *ProjectsLocationsMembershipsGenerateConnectManifestCall) Do(opts ...goo // ], // "parameters": { // "connectAgent.name": { + // "deprecated": true, // "description": "Do not set.", // "location": "query", // "type": "string" diff --git a/gkeonprem/v1/gkeonprem-api.json b/gkeonprem/v1/gkeonprem-api.json index 09cc65a2987..f42800da3d9 100644 --- a/gkeonprem/v1/gkeonprem-api.json +++ b/gkeonprem/v1/gkeonprem-api.json @@ -1166,6 +1166,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "View for bare metal node pool. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.", + "enum": [ + "NODE_POOL_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "If the value is not set, the default `FULL` view is used.", + "Includes basic information of a node pool resource including node pool resource name.", + "Includes the complete configuration for bare metal node pool resource. This is the default value for GetBareMetalNodePoolRequest method." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+name}", @@ -1233,6 +1248,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "View for bare metal node pools. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.", + "enum": [ + "NODE_POOL_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "If the value is not set, the default `FULL` view is used.", + "Includes basic information of a node pool resource including node pool resource name.", + "Includes the complete configuration for bare metal node pool resource. This is the default value for ListBareMetalNodePoolsRequest method." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+parent}/bareMetalNodePools", @@ -1252,6 +1282,11 @@ "name" ], "parameters": { + "allowMissing": { + "description": "If set to true, and the bare metal node pool is not found, the request will create a new bare metal node pool with the provided configuration. The user must have both create and update permission to call Update with allow_missing set to true.", + "location": "query", + "type": "boolean" + }, "name": { "description": "Immutable. The bare metal node pool resource name.", "location": "path", @@ -1524,6 +1559,42 @@ } } }, + "bareMetalStandaloneClusters": { + "resources": { + "bareMetalStandaloneNodePools": { + "methods": { + "enroll": { + "description": "Enrolls an existing bare metal standalone node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing standalone node pool will become Anthos On-Prem API managed. The corresponding GCP resources will be created.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalStandaloneClusters/{bareMetalStandaloneClustersId}/bareMetalStandaloneNodePools:enroll", + "httpMethod": "POST", + "id": "gkeonprem.projects.locations.bareMetalStandaloneClusters.bareMetalStandaloneNodePools.enroll", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where this node pool will be created. projects/{project}/locations/{location}/bareMetalStandaloneClusters/{cluster}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalStandaloneClusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/bareMetalStandaloneNodePools:enroll", + "request": { + "$ref": "EnrollBareMetalStandaloneNodePoolRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "operations": { "methods": { "cancel": { @@ -1692,6 +1763,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "View for VMware admin cluster. When `BASIC` is specified, only the cluster resource name and membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.", + "enum": [ + "CLUSTER_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "If the value is not set, the default `FULL` view is used.", + "Includes basic information of a cluster resource including cluster resource name and membership.", + "Includes the complete configuration for VMware admin cluster resource. This is the default value for GetVmwareAdminClusterRequest method." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+name}", @@ -1996,7 +2082,7 @@ "vmwareClusters": { "methods": { "create": { - "description": "Creates a new VMware cluster in a given project and location.", + "description": "Creates a new VMware user cluster in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters", "httpMethod": "POST", "id": "gkeonprem.projects.locations.vmwareClusters.create", @@ -2618,6 +2704,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "View for VMware node pool. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.", + "enum": [ + "NODE_POOL_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "If the value is not set, the default `FULL` view is used.", + "Includes basic information of a node pool resource including node pool resource name.", + "Includes the complete configuration for VMware node pool resource. This is the default value for GetVmwareNodePoolRequest method." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+name}", @@ -2685,6 +2786,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "View for VMware node pools. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.", + "enum": [ + "NODE_POOL_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "If the value is not set, the default `FULL` view is used.", + "Includes basic information of a node pool resource including node pool resource name.", + "Includes the complete configuration for VMware node pool resource. This is the default value for ListVmwareNodePoolsRequest method." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+parent}/vmwareNodePools", @@ -2799,6 +2915,11 @@ "name" ], "parameters": { + "allowMissing": { + "description": "If set to true, and the VMware node pool is not found, the request will succeed but no action will be taken on the server and return a completed LRO.", + "location": "query", + "type": "boolean" + }, "etag": { "description": "The current etag of the VMware node pool. If an etag is provided and does not match the current etag of node pool, deletion will be blocked and an ABORTED error will be returned.", "location": "query", @@ -2906,7 +3027,7 @@ } } }, - "revision": "20230507", + "revision": "20230517", "rootUrl": "https://gkeonprem.googleapis.com/", "schemas": { "Authorization": { @@ -2914,7 +3035,7 @@ "id": "Authorization", "properties": { "adminUsers": { - "description": "Required. For VMware user, bare metal user and standalone clusters, users that will be granted the cluster-admin role on the cluster, providing full access to the cluster. For bare metal Admin cluster, users will be granted the view role, which is a view only access.", + "description": "Required. For VMware and bare metal user clusters, users will be granted the cluster-admin role on the cluster, which provides full administrative access to the cluster. For bare metal admin clusters, users will be granted the cluster-view role, which limits users to read-only access.", "items": { "$ref": "ClusterUser" }, @@ -3691,7 +3812,7 @@ "type": "object" }, "BareMetalKubeletConfig": { - "description": "KubeletConfig defines the modifiable kubelet configurations for baremetal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options).", + "description": "KubeletConfig defines the modifiable kubelet configurations for bare metal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options).", "id": "BareMetalKubeletConfig", "properties": { "registryBurst": { @@ -4036,7 +4157,7 @@ "properties": { "kubeletConfig": { "$ref": "BareMetalKubeletConfig", - "description": "The modifiable kubelet configurations for the baremetal machines." + "description": "The modifiable kubelet configurations for the bare metal machines." }, "labels": { "additionalProperties": { @@ -4300,14 +4421,25 @@ }, "type": "object" }, + "EnrollBareMetalStandaloneNodePoolRequest": { + "description": "Message for enrolling an existing bare metal standalone node pool to the GKE on-prem API.", + "id": "EnrollBareMetalStandaloneNodePoolRequest", + "properties": { + "bareMetalStandaloneNodePoolId": { + "description": "User provided OnePlatform identifier that is used as part of the resource name. This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/rfc1123) format.", + "type": "string" + }, + "validateOnly": { + "description": "If set, only validate the request, but do not actually enroll the node pool.", + "type": "boolean" + } + }, + "type": "object" + }, "EnrollVmwareAdminClusterRequest": { "description": "Message for enrolling an existing VMware admin cluster to the GKE on-prem API.", "id": "EnrollVmwareAdminClusterRequest", "properties": { - "localName": { - "description": "The object name of the VMware OnPremAdminCluster custom resource on the associated admin cluster. This field is used to support conflicting resource names when enrolling existing clusters to the API. When not provided, this field will resolve to the vmware_admin_cluster_id. Otherwise, it must match the object name of the VMware OnPremAdminCluster custom resource. It is not modifiable outside / beyond the enrollment operation.", - "type": "string" - }, "membership": { "description": "Required. This is the full resource name of this admin cluster's fleet membership.", "type": "string" @@ -4683,6 +4815,11 @@ "readOnly": true, "type": "string" }, + "controlPlaneDisconnected": { + "description": "Output only. Denotes if the local managing cluster's control plane is currently disconnected. This is expected to occur temporarily during self-managed cluster upgrades.", + "readOnly": true, + "type": "boolean" + }, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", @@ -5523,7 +5660,7 @@ "description": "The VMware user cluster network configuration." }, "onPremVersion": { - "description": "The Anthos clusters on the VMware version for your user cluster. Defaults to the admin cluster version.", + "description": "Required. The Anthos clusters on the VMware version for your user cluster.", "type": "string" }, "reconciling": { diff --git a/gkeonprem/v1/gkeonprem-gen.go b/gkeonprem/v1/gkeonprem-gen.go index 13287c481fd..25df138c56b 100644 --- a/gkeonprem/v1/gkeonprem-gen.go +++ b/gkeonprem/v1/gkeonprem-gen.go @@ -154,6 +154,7 @@ func NewProjectsLocationsService(s *Service) *ProjectsLocationsService { rs := &ProjectsLocationsService{s: s} rs.BareMetalAdminClusters = NewProjectsLocationsBareMetalAdminClustersService(s) rs.BareMetalClusters = NewProjectsLocationsBareMetalClustersService(s) + rs.BareMetalStandaloneClusters = NewProjectsLocationsBareMetalStandaloneClustersService(s) rs.Operations = NewProjectsLocationsOperationsService(s) rs.VmwareAdminClusters = NewProjectsLocationsVmwareAdminClustersService(s) rs.VmwareClusters = NewProjectsLocationsVmwareClustersService(s) @@ -167,6 +168,8 @@ type ProjectsLocationsService struct { BareMetalClusters *ProjectsLocationsBareMetalClustersService + BareMetalStandaloneClusters *ProjectsLocationsBareMetalStandaloneClustersService + Operations *ProjectsLocationsOperationsService VmwareAdminClusters *ProjectsLocationsVmwareAdminClustersService @@ -240,6 +243,27 @@ type ProjectsLocationsBareMetalClustersOperationsService struct { s *Service } +func NewProjectsLocationsBareMetalStandaloneClustersService(s *Service) *ProjectsLocationsBareMetalStandaloneClustersService { + rs := &ProjectsLocationsBareMetalStandaloneClustersService{s: s} + rs.BareMetalStandaloneNodePools = NewProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsService(s) + return rs +} + +type ProjectsLocationsBareMetalStandaloneClustersService struct { + s *Service + + BareMetalStandaloneNodePools *ProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsService +} + +func NewProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsService(s *Service) *ProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsService { + rs := &ProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsService{s: s} + return rs +} + +type ProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsService struct { + s *Service +} + func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService { rs := &ProjectsLocationsOperationsService{s: s} return rs @@ -318,11 +342,11 @@ type ProjectsLocationsVmwareClustersVmwareNodePoolsOperationsService struct { // Authorization: Authorization defines the On-Prem cluster // authorization configuration to bootstrap onto the admin cluster. type Authorization struct { - // AdminUsers: Required. For VMware user, bare metal user and standalone - // clusters, users that will be granted the cluster-admin role on the - // cluster, providing full access to the cluster. For bare metal Admin - // cluster, users will be granted the view role, which is a view only - // access. + // AdminUsers: Required. For VMware and bare metal user clusters, users + // will be granted the cluster-admin role on the cluster, which provides + // full administrative access to the cluster. For bare metal admin + // clusters, users will be granted the cluster-view role, which limits + // users to read-only access. AdminUsers []*ClusterUser `json:"adminUsers,omitempty"` // ForceSendFields is a list of field names (e.g. "AdminUsers") to @@ -1703,7 +1727,7 @@ func (s *BareMetalIslandModeCidrConfig) MarshalJSON() ([]byte, error) { } // BareMetalKubeletConfig: KubeletConfig defines the modifiable kubelet -// configurations for baremetal machines. Note: this list includes +// configurations for bare metal machines. Note: this list includes // fields supported in GKE (see // https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options). type BareMetalKubeletConfig struct { @@ -2344,8 +2368,8 @@ func (s *BareMetalNodePool) MarshalJSON() ([]byte, error) { // BareMetalNodePoolConfig: BareMetalNodePoolConfig describes the // configuration of all nodes within a given bare metal node pool. type BareMetalNodePoolConfig struct { - // KubeletConfig: The modifiable kubelet configurations for the - // baremetal machines. + // KubeletConfig: The modifiable kubelet configurations for the bare + // metal machines. KubeletConfig *BareMetalKubeletConfig `json:"kubeletConfig,omitempty"` // Labels: The labels assigned to nodes of this node pool. An object @@ -2947,18 +2971,47 @@ func (s *EnrollBareMetalNodePoolRequest) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// EnrollBareMetalStandaloneNodePoolRequest: Message for enrolling an +// existing bare metal standalone node pool to the GKE on-prem API. +type EnrollBareMetalStandaloneNodePoolRequest struct { + // BareMetalStandaloneNodePoolId: User provided OnePlatform identifier + // that is used as part of the resource name. This value must be up to + // 40 characters and follow RFC-1123 + // (https://tools.ietf.org/html/rfc1123) format. + BareMetalStandaloneNodePoolId string `json:"bareMetalStandaloneNodePoolId,omitempty"` + + // ValidateOnly: If set, only validate the request, but do not actually + // enroll the node pool. + ValidateOnly bool `json:"validateOnly,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "BareMetalStandaloneNodePoolId") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. + // "BareMetalStandaloneNodePoolId") to include in API requests with the + // JSON null value. By default, fields with empty values are omitted + // from API requests. However, any field with an empty value appearing + // in NullFields will be sent to the server as null. It is an error if a + // field in this list has a non-empty value. This may be used to include + // null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *EnrollBareMetalStandaloneNodePoolRequest) MarshalJSON() ([]byte, error) { + type NoMethod EnrollBareMetalStandaloneNodePoolRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // EnrollVmwareAdminClusterRequest: Message for enrolling an existing // VMware admin cluster to the GKE on-prem API. type EnrollVmwareAdminClusterRequest struct { - // LocalName: The object name of the VMware OnPremAdminCluster custom - // resource on the associated admin cluster. This field is used to - // support conflicting resource names when enrolling existing clusters - // to the API. When not provided, this field will resolve to the - // vmware_admin_cluster_id. Otherwise, it must match the object name of - // the VMware OnPremAdminCluster custom resource. It is not modifiable - // outside / beyond the enrollment operation. - LocalName string `json:"localName,omitempty"` - // Membership: Required. This is the full resource name of this admin // cluster's fleet membership. Membership string `json:"membership,omitempty"` @@ -2970,7 +3023,7 @@ type EnrollVmwareAdminClusterRequest struct { // and follow RFC-1123 (https://tools.ietf.org/html/rfc1123) format. VmwareAdminClusterId string `json:"vmwareAdminClusterId,omitempty"` - // ForceSendFields is a list of field names (e.g. "LocalName") to + // ForceSendFields is a list of field names (e.g. "Membership") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -2978,7 +3031,7 @@ type EnrollVmwareAdminClusterRequest struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "LocalName") to include in + // NullFields is a list of field names (e.g. "Membership") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as @@ -3670,6 +3723,11 @@ type OperationMetadata struct { // ApiVersion: Output only. API version used to start the operation. ApiVersion string `json:"apiVersion,omitempty"` + // ControlPlaneDisconnected: Output only. Denotes if the local managing + // cluster's control plane is currently disconnected. This is expected + // to occur temporarily during self-managed cluster upgrades. + ControlPlaneDisconnected bool `json:"controlPlaneDisconnected,omitempty"` + // CreateTime: Output only. The time the operation was created. CreateTime string `json:"createTime,omitempty"` @@ -5017,8 +5075,8 @@ type VmwareCluster struct { // NetworkConfig: The VMware user cluster network configuration. NetworkConfig *VmwareNetworkConfig `json:"networkConfig,omitempty"` - // OnPremVersion: The Anthos clusters on the VMware version for your - // user cluster. Defaults to the admin cluster version. + // OnPremVersion: Required. The Anthos clusters on the VMware version + // for your user cluster. OnPremVersion string `json:"onPremVersion,omitempty"` // Reconciling: Output only. If set, there are currently changes in @@ -11041,6 +11099,31 @@ func (r *ProjectsLocationsBareMetalClustersBareMetalNodePoolsService) Get(name s return c } +// View sets the optional parameter "view": View for bare metal node +// pool. When `BASIC` is specified, only the node pool resource name is +// returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the +// same as `FULL', which returns the complete node pool configuration +// details. +// +// Possible values: +// +// "NODE_POOL_VIEW_UNSPECIFIED" - If the value is not set, the default +// +// `FULL` view is used. +// +// "BASIC" - Includes basic information of a node pool resource +// +// including node pool resource name. +// +// "FULL" - Includes the complete configuration for bare metal node +// +// pool resource. This is the default value for +// GetBareMetalNodePoolRequest method. +func (c *ProjectsLocationsBareMetalClustersBareMetalNodePoolsGetCall) View(view string) *ProjectsLocationsBareMetalClustersBareMetalNodePoolsGetCall { + c.urlParams_.Set("view", view) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse // for more information. @@ -11154,6 +11237,21 @@ func (c *ProjectsLocationsBareMetalClustersBareMetalNodePoolsGetCall) Do(opts .. // "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+/bareMetalNodePools/[^/]+$", // "required": true, // "type": "string" + // }, + // "view": { + // "description": "View for bare metal node pool. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.", + // "enum": [ + // "NODE_POOL_VIEW_UNSPECIFIED", + // "BASIC", + // "FULL" + // ], + // "enumDescriptions": [ + // "If the value is not set, the default `FULL` view is used.", + // "Includes basic information of a node pool resource including node pool resource name.", + // "Includes the complete configuration for bare metal node pool resource. This is the default value for GetBareMetalNodePoolRequest method." + // ], + // "location": "query", + // "type": "string" // } // }, // "path": "v1/{+name}", @@ -11385,6 +11483,31 @@ func (c *ProjectsLocationsBareMetalClustersBareMetalNodePoolsListCall) PageToken return c } +// View sets the optional parameter "view": View for bare metal node +// pools. When `BASIC` is specified, only the node pool resource name is +// returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the +// same as `FULL', which returns the complete node pool configuration +// details. +// +// Possible values: +// +// "NODE_POOL_VIEW_UNSPECIFIED" - If the value is not set, the default +// +// `FULL` view is used. +// +// "BASIC" - Includes basic information of a node pool resource +// +// including node pool resource name. +// +// "FULL" - Includes the complete configuration for bare metal node +// +// pool resource. This is the default value for +// ListBareMetalNodePoolsRequest method. +func (c *ProjectsLocationsBareMetalClustersBareMetalNodePoolsListCall) View(view string) *ProjectsLocationsBareMetalClustersBareMetalNodePoolsListCall { + c.urlParams_.Set("view", view) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse // for more information. @@ -11509,6 +11632,21 @@ func (c *ProjectsLocationsBareMetalClustersBareMetalNodePoolsListCall) Do(opts . // "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalClusters/[^/]+$", // "required": true, // "type": "string" + // }, + // "view": { + // "description": "View for bare metal node pools. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.", + // "enum": [ + // "NODE_POOL_VIEW_UNSPECIFIED", + // "BASIC", + // "FULL" + // ], + // "enumDescriptions": [ + // "If the value is not set, the default `FULL` view is used.", + // "Includes basic information of a node pool resource including node pool resource name.", + // "Includes the complete configuration for bare metal node pool resource. This is the default value for ListBareMetalNodePoolsRequest method." + // ], + // "location": "query", + // "type": "string" // } // }, // "path": "v1/{+parent}/bareMetalNodePools", @@ -11564,6 +11702,16 @@ func (r *ProjectsLocationsBareMetalClustersBareMetalNodePoolsService) Patch(name return c } +// AllowMissing sets the optional parameter "allowMissing": If set to +// true, and the bare metal node pool is not found, the request will +// create a new bare metal node pool with the provided configuration. +// The user must have both create and update permission to call Update +// with allow_missing set to true. +func (c *ProjectsLocationsBareMetalClustersBareMetalNodePoolsPatchCall) AllowMissing(allowMissing bool) *ProjectsLocationsBareMetalClustersBareMetalNodePoolsPatchCall { + c.urlParams_.Set("allowMissing", fmt.Sprint(allowMissing)) + return c +} + // UpdateMask sets the optional parameter "updateMask": Required. Field // mask is used to specify the fields to be overwritten in the // BareMetalNodePool resource by the update. The fields specified in the @@ -11683,6 +11831,11 @@ func (c *ProjectsLocationsBareMetalClustersBareMetalNodePoolsPatchCall) Do(opts // "name" // ], // "parameters": { + // "allowMissing": { + // "description": "If set to true, and the bare metal node pool is not found, the request will create a new bare metal node pool with the provided configuration. The user must have both create and update permission to call Update with allow_missing set to true.", + // "location": "query", + // "type": "boolean" + // }, // "name": { // "description": "Immutable. The bare metal node pool resource name.", // "location": "path", @@ -12895,6 +13048,153 @@ func (c *ProjectsLocationsBareMetalClustersOperationsListCall) Pages(ctx context } } +// method id "gkeonprem.projects.locations.bareMetalStandaloneClusters.bareMetalStandaloneNodePools.enroll": + +type ProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsEnrollCall struct { + s *Service + parent string + enrollbaremetalstandalonenodepoolrequest *EnrollBareMetalStandaloneNodePoolRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Enroll: Enrolls an existing bare metal standalone node pool to the +// Anthos On-Prem API within a given project and location. Through +// enrollment, an existing standalone node pool will become Anthos +// On-Prem API managed. The corresponding GCP resources will be created. +// +// - parent: The parent resource where this node pool will be created. +// projects/{project}/locations/{location}/bareMetalStandaloneClusters/ +// {cluster}. +func (r *ProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsService) Enroll(parent string, enrollbaremetalstandalonenodepoolrequest *EnrollBareMetalStandaloneNodePoolRequest) *ProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsEnrollCall { + c := &ProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsEnrollCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.enrollbaremetalstandalonenodepoolrequest = enrollbaremetalstandalonenodepoolrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsEnrollCall) Fields(s ...googleapi.Field) *ProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsEnrollCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsEnrollCall) Context(ctx context.Context) *ProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsEnrollCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsEnrollCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsEnrollCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.enrollbaremetalstandalonenodepoolrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/bareMetalStandaloneNodePools:enroll") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "gkeonprem.projects.locations.bareMetalStandaloneClusters.bareMetalStandaloneNodePools.enroll" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsBareMetalStandaloneClustersBareMetalStandaloneNodePoolsEnrollCall) Do(opts ...googleapi.CallOption) (*Operation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Operation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Enrolls an existing bare metal standalone node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing standalone node pool will become Anthos On-Prem API managed. The corresponding GCP resources will be created.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bareMetalStandaloneClusters/{bareMetalStandaloneClustersId}/bareMetalStandaloneNodePools:enroll", + // "httpMethod": "POST", + // "id": "gkeonprem.projects.locations.bareMetalStandaloneClusters.bareMetalStandaloneNodePools.enroll", + // "parameterOrder": [ + // "parent" + // ], + // "parameters": { + // "parent": { + // "description": "Required. The parent resource where this node pool will be created. projects/{project}/locations/{location}/bareMetalStandaloneClusters/{cluster}", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/bareMetalStandaloneClusters/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+parent}/bareMetalStandaloneNodePools:enroll", + // "request": { + // "$ref": "EnrollBareMetalStandaloneNodePoolRequest" + // }, + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "gkeonprem.projects.locations.operations.cancel": type ProjectsLocationsOperationsCancelCall struct { @@ -13705,6 +14005,31 @@ func (r *ProjectsLocationsVmwareAdminClustersService) Get(name string) *Projects return c } +// View sets the optional parameter "view": View for VMware admin +// cluster. When `BASIC` is specified, only the cluster resource name +// and membership are returned. The default/unset value +// `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the +// complete cluster configuration details. +// +// Possible values: +// +// "CLUSTER_VIEW_UNSPECIFIED" - If the value is not set, the default +// +// `FULL` view is used. +// +// "BASIC" - Includes basic information of a cluster resource +// +// including cluster resource name and membership. +// +// "FULL" - Includes the complete configuration for VMware admin +// +// cluster resource. This is the default value for +// GetVmwareAdminClusterRequest method. +func (c *ProjectsLocationsVmwareAdminClustersGetCall) View(view string) *ProjectsLocationsVmwareAdminClustersGetCall { + c.urlParams_.Set("view", view) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse // for more information. @@ -13818,6 +14143,21 @@ func (c *ProjectsLocationsVmwareAdminClustersGetCall) Do(opts ...googleapi.CallO // "pattern": "^projects/[^/]+/locations/[^/]+/vmwareAdminClusters/[^/]+$", // "required": true, // "type": "string" + // }, + // "view": { + // "description": "View for VMware admin cluster. When `BASIC` is specified, only the cluster resource name and membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.", + // "enum": [ + // "CLUSTER_VIEW_UNSPECIFIED", + // "BASIC", + // "FULL" + // ], + // "enumDescriptions": [ + // "If the value is not set, the default `FULL` view is used.", + // "Includes basic information of a cluster resource including cluster resource name and membership.", + // "Includes the complete configuration for VMware admin cluster resource. This is the default value for GetVmwareAdminClusterRequest method." + // ], + // "location": "query", + // "type": "string" // } // }, // "path": "v1/{+name}", @@ -15255,7 +15595,8 @@ type ProjectsLocationsVmwareClustersCreateCall struct { header_ http.Header } -// Create: Creates a new VMware cluster in a given project and location. +// Create: Creates a new VMware user cluster in a given project and +// location. // // - parent: The parent of the project and location where this cluster // is created in. Format: "projects/{project}/locations/{location}". @@ -15373,7 +15714,7 @@ func (c *ProjectsLocationsVmwareClustersCreateCall) Do(opts ...googleapi.CallOpt } return ret, nil // { - // "description": "Creates a new VMware cluster in a given project and location.", + // "description": "Creates a new VMware user cluster in a given project and location.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters", // "httpMethod": "POST", // "id": "gkeonprem.projects.locations.vmwareClusters.create", @@ -18094,6 +18435,31 @@ func (r *ProjectsLocationsVmwareClustersVmwareNodePoolsService) Get(name string) return c } +// View sets the optional parameter "view": View for VMware node pool. +// When `BASIC` is specified, only the node pool resource name is +// returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the +// same as `FULL', which returns the complete node pool configuration +// details. +// +// Possible values: +// +// "NODE_POOL_VIEW_UNSPECIFIED" - If the value is not set, the default +// +// `FULL` view is used. +// +// "BASIC" - Includes basic information of a node pool resource +// +// including node pool resource name. +// +// "FULL" - Includes the complete configuration for VMware node pool +// +// resource. This is the default value for GetVmwareNodePoolRequest +// method. +func (c *ProjectsLocationsVmwareClustersVmwareNodePoolsGetCall) View(view string) *ProjectsLocationsVmwareClustersVmwareNodePoolsGetCall { + c.urlParams_.Set("view", view) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse // for more information. @@ -18207,6 +18573,21 @@ func (c *ProjectsLocationsVmwareClustersVmwareNodePoolsGetCall) Do(opts ...googl // "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+/vmwareNodePools/[^/]+$", // "required": true, // "type": "string" + // }, + // "view": { + // "description": "View for VMware node pool. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.", + // "enum": [ + // "NODE_POOL_VIEW_UNSPECIFIED", + // "BASIC", + // "FULL" + // ], + // "enumDescriptions": [ + // "If the value is not set, the default `FULL` view is used.", + // "Includes basic information of a node pool resource including node pool resource name.", + // "Includes the complete configuration for VMware node pool resource. This is the default value for GetVmwareNodePoolRequest method." + // ], + // "location": "query", + // "type": "string" // } // }, // "path": "v1/{+name}", @@ -18438,6 +18819,31 @@ func (c *ProjectsLocationsVmwareClustersVmwareNodePoolsListCall) PageToken(pageT return c } +// View sets the optional parameter "view": View for VMware node pools. +// When `BASIC` is specified, only the node pool resource name is +// returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the +// same as `FULL', which returns the complete node pool configuration +// details. +// +// Possible values: +// +// "NODE_POOL_VIEW_UNSPECIFIED" - If the value is not set, the default +// +// `FULL` view is used. +// +// "BASIC" - Includes basic information of a node pool resource +// +// including node pool resource name. +// +// "FULL" - Includes the complete configuration for VMware node pool +// +// resource. This is the default value for ListVmwareNodePoolsRequest +// method. +func (c *ProjectsLocationsVmwareClustersVmwareNodePoolsListCall) View(view string) *ProjectsLocationsVmwareClustersVmwareNodePoolsListCall { + c.urlParams_.Set("view", view) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse // for more information. @@ -18562,6 +18968,21 @@ func (c *ProjectsLocationsVmwareClustersVmwareNodePoolsListCall) Do(opts ...goog // "pattern": "^projects/[^/]+/locations/[^/]+/vmwareClusters/[^/]+$", // "required": true, // "type": "string" + // }, + // "view": { + // "description": "View for VMware node pools. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.", + // "enum": [ + // "NODE_POOL_VIEW_UNSPECIFIED", + // "BASIC", + // "FULL" + // ], + // "enumDescriptions": [ + // "If the value is not set, the default `FULL` view is used.", + // "Includes basic information of a node pool resource including node pool resource name.", + // "Includes the complete configuration for VMware node pool resource. This is the default value for ListVmwareNodePoolsRequest method." + // ], + // "location": "query", + // "type": "string" // } // }, // "path": "v1/{+parent}/vmwareNodePools", @@ -19087,6 +19508,14 @@ func (r *ProjectsLocationsVmwareClustersVmwareNodePoolsService) Unenroll(name st return c } +// AllowMissing sets the optional parameter "allowMissing": If set to +// true, and the VMware node pool is not found, the request will succeed +// but no action will be taken on the server and return a completed LRO. +func (c *ProjectsLocationsVmwareClustersVmwareNodePoolsUnenrollCall) AllowMissing(allowMissing bool) *ProjectsLocationsVmwareClustersVmwareNodePoolsUnenrollCall { + c.urlParams_.Set("allowMissing", fmt.Sprint(allowMissing)) + return c +} + // Etag sets the optional parameter "etag": The current etag of the // VMware node pool. If an etag is provided and does not match the // current etag of node pool, deletion will be blocked and an ABORTED @@ -19197,6 +19626,11 @@ func (c *ProjectsLocationsVmwareClustersVmwareNodePoolsUnenrollCall) Do(opts ... // "name" // ], // "parameters": { + // "allowMissing": { + // "description": "If set to true, and the VMware node pool is not found, the request will succeed but no action will be taken on the server and return a completed LRO.", + // "location": "query", + // "type": "boolean" + // }, // "etag": { // "description": "The current etag of the VMware node pool. If an etag is provided and does not match the current etag of node pool, deletion will be blocked and an ABORTED error will be returned.", // "location": "query", diff --git a/migrationcenter/v1alpha1/migrationcenter-api.json b/migrationcenter/v1alpha1/migrationcenter-api.json index 0832da11c21..80f1b34eee0 100644 --- a/migrationcenter/v1alpha1/migrationcenter-api.json +++ b/migrationcenter/v1alpha1/migrationcenter-api.json @@ -2102,7 +2102,7 @@ } } }, - "revision": "20230505", + "revision": "20230519", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2491,7 +2491,7 @@ "type": "boolean" }, "names": { - "description": "Required. The IDs of the assets to delete. A maximum of 1000 assets can be deleted in a batch. format: projects/{project}/locations/{location}/asset/{name}.", + "description": "Required. The IDs of the assets to delete. A maximum of 1000 assets can be deleted in a batch. Format: projects/{project}/locations/{location}/assets/{name}.", "items": { "type": "string" }, diff --git a/migrationcenter/v1alpha1/migrationcenter-gen.go b/migrationcenter/v1alpha1/migrationcenter-gen.go index 599a1d777dd..e5133df08d2 100644 --- a/migrationcenter/v1alpha1/migrationcenter-gen.go +++ b/migrationcenter/v1alpha1/migrationcenter-gen.go @@ -965,8 +965,8 @@ type BatchDeleteAssetsRequest struct { AllowMissing bool `json:"allowMissing,omitempty"` // Names: Required. The IDs of the assets to delete. A maximum of 1000 - // assets can be deleted in a batch. format: - // projects/{project}/locations/{location}/asset/{name}. + // assets can be deleted in a batch. Format: + // projects/{project}/locations/{location}/assets/{name}. Names []string `json:"names,omitempty"` // ForceSendFields is a list of field names (e.g. "AllowMissing") to diff --git a/networkmanagement/v1beta1/networkmanagement-api.json b/networkmanagement/v1beta1/networkmanagement-api.json index ec7c4a04aa5..29d5d7463db 100644 --- a/networkmanagement/v1beta1/networkmanagement-api.json +++ b/networkmanagement/v1beta1/networkmanagement-api.json @@ -591,7 +591,7 @@ } } }, - "revision": "20230426", + "revision": "20230517", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1008,6 +1008,7 @@ "DROPPED_INSIDE_GKE_SERVICE", "DROPPED_INSIDE_CLOUD_SQL_SERVICE", "GOOGLE_MANAGED_SERVICE_NO_PEERING", + "GOOGLE_MANAGED_SERVICE_NO_PSC_ENDPOINT", "GKE_PSC_ENDPOINT_MISSING", "CLOUD_SQL_INSTANCE_NO_IP_ADDRESS", "GKE_CONTROL_PLANE_REGION_MISMATCH", @@ -1048,6 +1049,7 @@ "Packet was dropped inside Google Kubernetes Engine Service.", "Packet was dropped inside Cloud SQL Service.", "Packet was dropped because there is no peering between the originating network and the Google Managed Services Network.", + "Packet was dropped because the Google-managed service uses Private Service Connect (PSC), but the PSC endpoint is not found in the project.", "Packet was dropped because the GKE cluster uses Private Service Connect (PSC), but the PSC endpoint is not found in the project.", "Packet was dropped because the Cloud SQL instance has neither a private nor a public IP address.", "Packet was dropped because a GKE cluster private endpoint is unreachable from a region different from the cluster's region.", diff --git a/networkmanagement/v1beta1/networkmanagement-gen.go b/networkmanagement/v1beta1/networkmanagement-gen.go index b63b2c81edd..b8878c07373 100644 --- a/networkmanagement/v1beta1/networkmanagement-gen.go +++ b/networkmanagement/v1beta1/networkmanagement-gen.go @@ -939,6 +939,9 @@ type DropInfo struct { // "GOOGLE_MANAGED_SERVICE_NO_PEERING" - Packet was dropped because // there is no peering between the originating network and the Google // Managed Services Network. + // "GOOGLE_MANAGED_SERVICE_NO_PSC_ENDPOINT" - Packet was dropped + // because the Google-managed service uses Private Service Connect + // (PSC), but the PSC endpoint is not found in the project. // "GKE_PSC_ENDPOINT_MISSING" - Packet was dropped because the GKE // cluster uses Private Service Connect (PSC), but the PSC endpoint is // not found in the project. diff --git a/networkservices/v1/networkservices-api.json b/networkservices/v1/networkservices-api.json index 651694a9065..94a63a5788e 100644 --- a/networkservices/v1/networkservices-api.json +++ b/networkservices/v1/networkservices-api.json @@ -2148,7 +2148,7 @@ } } }, - "revision": "20230424", + "revision": "20230519", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -3282,6 +3282,13 @@ "nextPageToken": { "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -3479,7 +3486,7 @@ "type": "string" }, "interceptionPort": { - "description": "Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the specified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to be redirected to this port regardless of its actual ip:port destination. If unset, a port '15001' is used as the interception port. This will is applicable only for sidecar proxy deployments.", + "description": "Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the specified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to be redirected to this port regardless of its actual ip:port destination. If unset, a port '15001' is used as the interception port. This is applicable only for sidecar proxy deployments.", "format": "int32", "type": "integer" }, diff --git a/networkservices/v1/networkservices-gen.go b/networkservices/v1/networkservices-gen.go index 7add72c7e8a..6592b52c213 100644 --- a/networkservices/v1/networkservices-gen.go +++ b/networkservices/v1/networkservices-gen.go @@ -2267,6 +2267,9 @@ type ListGatewaysResponse struct { // `next_page_token` as `page_token`. NextPageToken string `json:"nextPageToken,omitempty"` + // Unreachable: Locations that could not be reached. + Unreachable []string `json:"unreachable,omitempty"` + // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` @@ -2666,7 +2669,7 @@ type Mesh struct { // localhost (127.0.0.1) address. The SIDECAR proxy will expect all // traffic to be redirected to this port regardless of its actual // ip:port destination. If unset, a port '15001' is used as the - // interception port. This will is applicable only for sidecar proxy + // interception port. This is applicable only for sidecar proxy // deployments. InterceptionPort int64 `json:"interceptionPort,omitempty"` diff --git a/networkservices/v1beta1/networkservices-api.json b/networkservices/v1beta1/networkservices-api.json index 200c0de4e98..8d4d0088425 100644 --- a/networkservices/v1beta1/networkservices-api.json +++ b/networkservices/v1beta1/networkservices-api.json @@ -1875,7 +1875,7 @@ } } }, - "revision": "20230424", + "revision": "20230510", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -2966,6 +2966,13 @@ "nextPageToken": { "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -3163,7 +3170,7 @@ "type": "string" }, "interceptionPort": { - "description": "Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the specified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to be redirected to this port regardless of its actual ip:port destination. If unset, a port '15001' is used as the interception port. This will is applicable only for sidecar proxy deployments.", + "description": "Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the specified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to be redirected to this port regardless of its actual ip:port destination. If unset, a port '15001' is used as the interception port. This is applicable only for sidecar proxy deployments.", "format": "int32", "type": "integer" }, diff --git a/networkservices/v1beta1/networkservices-gen.go b/networkservices/v1beta1/networkservices-gen.go index a0eb4071a69..a919a37fd11 100644 --- a/networkservices/v1beta1/networkservices-gen.go +++ b/networkservices/v1beta1/networkservices-gen.go @@ -2139,6 +2139,9 @@ type ListGatewaysResponse struct { // `next_page_token` as `page_token`. NextPageToken string `json:"nextPageToken,omitempty"` + // Unreachable: Locations that could not be reached. + Unreachable []string `json:"unreachable,omitempty"` + // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` @@ -2538,7 +2541,7 @@ type Mesh struct { // localhost (127.0.0.1) address. The SIDECAR proxy will expect all // traffic to be redirected to this port regardless of its actual // ip:port destination. If unset, a port '15001' is used as the - // interception port. This will is applicable only for sidecar proxy + // interception port. This is applicable only for sidecar proxy // deployments. InterceptionPort int64 `json:"interceptionPort,omitempty"` diff --git a/osconfig/v1alpha/osconfig-api.json b/osconfig/v1alpha/osconfig-api.json index 0260e0eaf10..a57239cdf2e 100644 --- a/osconfig/v1alpha/osconfig-api.json +++ b/osconfig/v1alpha/osconfig-api.json @@ -110,6 +110,7 @@ "locations": { "resources": { "instanceOSPoliciesCompliances": { + "deprecated": true, "methods": { "get": { "deprecated": true, @@ -686,7 +687,7 @@ } } }, - "revision": "20230416", + "revision": "20230521", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CVSSv3": { diff --git a/pubsub/v1/pubsub-api.json b/pubsub/v1/pubsub-api.json index bc9be42a9a1..1591ef4dfe0 100644 --- a/pubsub/v1/pubsub-api.json +++ b/pubsub/v1/pubsub-api.json @@ -1565,7 +1565,7 @@ } } }, - "revision": "20230425", + "revision": "20230516", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -1974,7 +1974,7 @@ "type": "object" }, "OidcToken": { - "description": "Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). [Service account email](https://cloud.google.com/iam/docs/service-accounts) used for generating the OIDC token. For more information on setting up authentication, see [Push subscriptions](https://cloud.google.com/pubsub/docs/push).", + "description": "Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect).", "id": "OidcToken", "properties": { "audience": { @@ -1982,6 +1982,7 @@ "type": "string" }, "serviceAccountEmail": { + "description": "[Service account email](https://cloud.google.com/iam/docs/service-accounts) used for generating the OIDC token. For more information on setting up authentication, see [Push subscriptions](https://cloud.google.com/pubsub/docs/push).", "type": "string" } }, diff --git a/pubsub/v1/pubsub-gen.go b/pubsub/v1/pubsub-gen.go index c9b38561407..5acce98117f 100644 --- a/pubsub/v1/pubsub-gen.go +++ b/pubsub/v1/pubsub-gen.go @@ -1115,11 +1115,6 @@ func (s *ModifyPushConfigRequest) MarshalJSON() ([]byte, error) { // OidcToken: Contains information needed for generating an OpenID // Connect token // (https://developers.google.com/identity/protocols/OpenIDConnect). -// Service account email -// (https://cloud.google.com/iam/docs/service-accounts) used for -// generating the OIDC token. For more information on setting up -// authentication, see Push subscriptions -// (https://cloud.google.com/pubsub/docs/push). type OidcToken struct { // Audience: Audience to be used when generating OIDC token. The // audience claim identifies the recipients that the JWT is intended @@ -1130,6 +1125,11 @@ type OidcToken struct { // specified, the Push endpoint URL will be used. Audience string `json:"audience,omitempty"` + // ServiceAccountEmail: Service account email + // (https://cloud.google.com/iam/docs/service-accounts) used for + // generating the OIDC token. For more information on setting up + // authentication, see Push subscriptions + // (https://cloud.google.com/pubsub/docs/push). ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"` // ForceSendFields is a list of field names (e.g. "Audience") to diff --git a/retail/v2/retail-api.json b/retail/v2/retail-api.json index cfeedc3f049..2ff69f9dc0c 100644 --- a/retail/v2/retail-api.json +++ b/retail/v2/retail-api.json @@ -2031,7 +2031,7 @@ } } }, - "revision": "20230516", + "revision": "20230518", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5475,6 +5475,10 @@ "readOnly": true, "type": "string" }, + "source": { + "description": "Optional. An optional arbitrary string that could be used as a tag for tracking link source.", + "type": "string" + }, "state": { "description": "Output only. Represents the state of the link.", "enum": [ @@ -6247,6 +6251,10 @@ "readOnly": true, "type": "string" }, + "source": { + "description": "Optional. An optional arbitrary string that could be used as a tag for tracking link source.", + "type": "string" + }, "state": { "description": "Output only. Represents the state of the link.", "enum": [ diff --git a/retail/v2/retail-gen.go b/retail/v2/retail-gen.go index e8bbf32d8ff..b889f5504f0 100644 --- a/retail/v2/retail-gen.go +++ b/retail/v2/retail-gen.go @@ -6990,6 +6990,10 @@ type GoogleCloudRetailV2alphaMerchantCenterAccountLink struct { // ProjectId: Output only. Google Cloud project ID. ProjectId string `json:"projectId,omitempty"` + // Source: Optional. An optional arbitrary string that could be used as + // a tag for tracking link source. + Source string `json:"source,omitempty"` + // State: Output only. Represents the state of the link. // // Possible values: @@ -8395,6 +8399,10 @@ type GoogleCloudRetailV2betaMerchantCenterAccountLink struct { // ProjectId: Output only. Google Cloud project ID. ProjectId string `json:"projectId,omitempty"` + // Source: Optional. An optional arbitrary string that could be used as + // a tag for tracking link source. + Source string `json:"source,omitempty"` + // State: Output only. Represents the state of the link. // // Possible values: diff --git a/retail/v2alpha/retail-api.json b/retail/v2alpha/retail-api.json index 4bb1a08996b..224bc9b1328 100644 --- a/retail/v2alpha/retail-api.json +++ b/retail/v2alpha/retail-api.json @@ -2217,7 +2217,7 @@ } } }, - "revision": "20230516", + "revision": "20230518", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4117,6 +4117,10 @@ "readOnly": true, "type": "string" }, + "source": { + "description": "Optional. An optional arbitrary string that could be used as a tag for tracking link source.", + "type": "string" + }, "state": { "description": "Output only. Represents the state of the link.", "enum": [ @@ -6647,6 +6651,10 @@ "readOnly": true, "type": "string" }, + "source": { + "description": "Optional. An optional arbitrary string that could be used as a tag for tracking link source.", + "type": "string" + }, "state": { "description": "Output only. Represents the state of the link.", "enum": [ diff --git a/retail/v2alpha/retail-gen.go b/retail/v2alpha/retail-gen.go index c7ad7a42bd8..3b7caffb9fa 100644 --- a/retail/v2alpha/retail-gen.go +++ b/retail/v2alpha/retail-gen.go @@ -3939,6 +3939,10 @@ type GoogleCloudRetailV2alphaMerchantCenterAccountLink struct { // ProjectId: Output only. Google Cloud project ID. ProjectId string `json:"projectId,omitempty"` + // Source: Optional. An optional arbitrary string that could be used as + // a tag for tracking link source. + Source string `json:"source,omitempty"` + // State: Output only. Represents the state of the link. // // Possible values: @@ -8838,6 +8842,10 @@ type GoogleCloudRetailV2betaMerchantCenterAccountLink struct { // ProjectId: Output only. Google Cloud project ID. ProjectId string `json:"projectId,omitempty"` + // Source: Optional. An optional arbitrary string that could be used as + // a tag for tracking link source. + Source string `json:"source,omitempty"` + // State: Output only. Represents the state of the link. // // Possible values: diff --git a/retail/v2beta/retail-api.json b/retail/v2beta/retail-api.json index 9acb0020b73..a4204983ae3 100644 --- a/retail/v2beta/retail-api.json +++ b/retail/v2beta/retail-api.json @@ -2059,7 +2059,7 @@ } } }, - "revision": "20230516", + "revision": "20230518", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2930,6 +2930,10 @@ "readOnly": true, "type": "string" }, + "source": { + "description": "Optional. An optional arbitrary string that could be used as a tag for tracking link source.", + "type": "string" + }, "state": { "description": "Output only. Represents the state of the link.", "enum": [ @@ -4675,6 +4679,10 @@ "readOnly": true, "type": "string" }, + "source": { + "description": "Optional. An optional arbitrary string that could be used as a tag for tracking link source.", + "type": "string" + }, "state": { "description": "Output only. Represents the state of the link.", "enum": [ diff --git a/retail/v2beta/retail-gen.go b/retail/v2beta/retail-gen.go index aeea577f69b..25e89460591 100644 --- a/retail/v2beta/retail-gen.go +++ b/retail/v2beta/retail-gen.go @@ -1886,6 +1886,10 @@ type GoogleCloudRetailV2alphaMerchantCenterAccountLink struct { // ProjectId: Output only. Google Cloud project ID. ProjectId string `json:"projectId,omitempty"` + // Source: Optional. An optional arbitrary string that could be used as + // a tag for tracking link source. + Source string `json:"source,omitempty"` + // State: Output only. Represents the state of the link. // // Possible values: @@ -5209,6 +5213,10 @@ type GoogleCloudRetailV2betaMerchantCenterAccountLink struct { // ProjectId: Output only. Google Cloud project ID. ProjectId string `json:"projectId,omitempty"` + // Source: Optional. An optional arbitrary string that could be used as + // a tag for tracking link source. + Source string `json:"source,omitempty"` + // State: Output only. Represents the state of the link. // // Possible values: diff --git a/servicedirectory/v1/servicedirectory-api.json b/servicedirectory/v1/servicedirectory-api.json index 7455eb0ee78..8861e72ed98 100644 --- a/servicedirectory/v1/servicedirectory-api.json +++ b/servicedirectory/v1/servicedirectory-api.json @@ -883,7 +883,7 @@ } } }, - "revision": "20230209", + "revision": "20230516", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { @@ -1069,7 +1069,7 @@ "type": "object" }, "Location": { - "description": "A resource that represents Google Cloud Platform location.", + "description": "A resource that represents a Google Cloud location.", "id": "Location", "properties": { "displayName": { diff --git a/servicedirectory/v1/servicedirectory-gen.go b/servicedirectory/v1/servicedirectory-gen.go index 82e2e5c53bd..27a559acde6 100644 --- a/servicedirectory/v1/servicedirectory-gen.go +++ b/servicedirectory/v1/servicedirectory-gen.go @@ -634,7 +634,7 @@ func (s *ListServicesResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Location: A resource that represents Google Cloud Platform location. +// Location: A resource that represents a Google Cloud location. type Location struct { // DisplayName: The friendly name for this location, typically a nearby // city name. For example, "Tokyo". diff --git a/servicedirectory/v1beta1/servicedirectory-api.json b/servicedirectory/v1beta1/servicedirectory-api.json index 208f2caebc8..ce5f20fc944 100644 --- a/servicedirectory/v1beta1/servicedirectory-api.json +++ b/servicedirectory/v1beta1/servicedirectory-api.json @@ -1147,7 +1147,7 @@ } } }, - "revision": "20230316", + "revision": "20230516", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { @@ -1345,7 +1345,7 @@ "type": "object" }, "Location": { - "description": "A resource that represents Google Cloud Platform location.", + "description": "A resource that represents a Google Cloud location.", "id": "Location", "properties": { "displayName": { diff --git a/servicedirectory/v1beta1/servicedirectory-gen.go b/servicedirectory/v1beta1/servicedirectory-gen.go index 2cdd8a88014..90d11887de9 100644 --- a/servicedirectory/v1beta1/servicedirectory-gen.go +++ b/servicedirectory/v1beta1/servicedirectory-gen.go @@ -677,7 +677,7 @@ func (s *ListServicesResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Location: A resource that represents Google Cloud Platform location. +// Location: A resource that represents a Google Cloud location. type Location struct { // DisplayName: The friendly name for this location, typically a nearby // city name. For example, "Tokyo". diff --git a/streetviewpublish/v1/streetviewpublish-api.json b/streetviewpublish/v1/streetviewpublish-api.json index 180f878c196..7c1880a1443 100644 --- a/streetviewpublish/v1/streetviewpublish-api.json +++ b/streetviewpublish/v1/streetviewpublish-api.json @@ -325,6 +325,7 @@ "type": "string" }, "view": { + "deprecated": true, "description": "Specifies if a download URL for the photo sequence should be returned in `download_url` of individual photos in the PhotoSequence response. \u003e Note: Currently not implemented.", "enum": [ "BASIC", @@ -488,7 +489,7 @@ "parameterOrder": [], "parameters": { "filter": { - "description": "Optional. The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The filters supported are: `placeId`, `min_latitude`, `max_latitude`, `min_longitude`, and `max_longitude`. See https://google.aip.dev/160 for more information.", + "description": "Optional. The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The filters supported are: `placeId`, `min_latitude`, `max_latitude`, `min_longitude`, `max_longitude`, 'min_capture_time_seconds', and 'max_capture_time_seconds'. See https://google.aip.dev/160 for more information.", "location": "query", "type": "string" }, @@ -533,7 +534,7 @@ } } }, - "revision": "20230307", + "revision": "20230522", "rootUrl": "https://streetviewpublish.googleapis.com/", "schemas": { "BatchDeletePhotosRequest": { diff --git a/streetviewpublish/v1/streetviewpublish-gen.go b/streetviewpublish/v1/streetviewpublish-gen.go index 316ccc4824a..4848f6f257e 100644 --- a/streetviewpublish/v1/streetviewpublish-gen.go +++ b/streetviewpublish/v1/streetviewpublish-gen.go @@ -2806,6 +2806,7 @@ func (c *PhotoSequenceGetCall) Do(opts ...googleapi.CallOption) (*Operation, err // "type": "string" // }, // "view": { + // "deprecated": true, // "description": "Specifies if a download URL for the photo sequence should be returned in `download_url` of individual photos in the PhotoSequence response. \u003e Note: Currently not implemented.", // "enum": [ // "BASIC", @@ -3643,8 +3644,9 @@ func (r *PhotosService) List() *PhotosListCall { // Filter sets the optional parameter "filter": The filter expression. // For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The filters // supported are: `placeId`, `min_latitude`, `max_latitude`, -// `min_longitude`, and `max_longitude`. See https://google.aip.dev/160 -// for more information. +// `min_longitude`, `max_longitude`, 'min_capture_time_seconds', and +// 'max_capture_time_seconds'. See https://google.aip.dev/160 for more +// information. func (c *PhotosListCall) Filter(filter string) *PhotosListCall { c.urlParams_.Set("filter", filter) return c @@ -3799,7 +3801,7 @@ func (c *PhotosListCall) Do(opts ...googleapi.CallOption) (*ListPhotosResponse, // "parameterOrder": [], // "parameters": { // "filter": { - // "description": "Optional. The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The filters supported are: `placeId`, `min_latitude`, `max_latitude`, `min_longitude`, and `max_longitude`. See https://google.aip.dev/160 for more information.", + // "description": "Optional. The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The filters supported are: `placeId`, `min_latitude`, `max_latitude`, `min_longitude`, `max_longitude`, 'min_capture_time_seconds', and 'max_capture_time_seconds'. See https://google.aip.dev/160 for more information.", // "location": "query", // "type": "string" // }, diff --git a/testing/v1/testing-api.json b/testing/v1/testing-api.json index a1152aefd80..ab35746e889 100644 --- a/testing/v1/testing-api.json +++ b/testing/v1/testing-api.json @@ -282,7 +282,7 @@ } } }, - "revision": "20230512", + "revision": "20230519", "rootUrl": "https://testing.googleapis.com/", "schemas": { "Account": { @@ -1721,19 +1721,28 @@ "description": "Output only. Details about the shard.", "id": "Shard", "properties": { + "estimatedShardDuration": { + "description": "Output only. The estimated shard duration based on previous test case timing records, if available.", + "format": "google-duration", + "readOnly": true, + "type": "string" + }, "numShards": { "description": "Output only. The total number of shards.", "format": "int32", + "readOnly": true, "type": "integer" }, "shardIndex": { "description": "Output only. The index of the shard among all the shards.", "format": "int32", + "readOnly": true, "type": "integer" }, "testTargetsForShard": { "$ref": "TestTargetsForShard", - "description": "Output only. Test targets for each shard. Only set for manual sharding." + "description": "Output only. Test targets for each shard. Only set for manual sharding.", + "readOnly": true } }, "type": "object" diff --git a/testing/v1/testing-gen.go b/testing/v1/testing-gen.go index bbf77e482b9..f9d45bd4b8e 100644 --- a/testing/v1/testing-gen.go +++ b/testing/v1/testing-gen.go @@ -2552,6 +2552,10 @@ func (s *Service) MarshalJSON() ([]byte, error) { // Shard: Output only. Details about the shard. type Shard struct { + // EstimatedShardDuration: Output only. The estimated shard duration + // based on previous test case timing records, if available. + EstimatedShardDuration string `json:"estimatedShardDuration,omitempty"` + // NumShards: Output only. The total number of shards. NumShards int64 `json:"numShards,omitempty"` @@ -2562,20 +2566,22 @@ type Shard struct { // set for manual sharding. TestTargetsForShard *TestTargetsForShard `json:"testTargetsForShard,omitempty"` - // ForceSendFields is a list of field names (e.g. "NumShards") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. + // ForceSendFields is a list of field names (e.g. + // "EstimatedShardDuration") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "NumShards") to include in - // API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. + // NullFields is a list of field names (e.g. "EstimatedShardDuration") + // to include in API requests with the JSON null value. By default, + // fields with empty values are omitted from API requests. However, any + // field with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. NullFields []string `json:"-"` } diff --git a/vmmigration/v1/vmmigration-api.json b/vmmigration/v1/vmmigration-api.json index 4dd773e3f6d..f60e39a2161 100644 --- a/vmmigration/v1/vmmigration-api.json +++ b/vmmigration/v1/vmmigration-api.json @@ -1972,7 +1972,7 @@ } } }, - "revision": "20230504", + "revision": "20230518", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2076,6 +2076,27 @@ }, "type": "object" }, + "AwsDiskDetails": { + "description": "The details of an AWS instance disk.", + "id": "AwsDiskDetails", + "properties": { + "diskNumber": { + "description": "The ordinal number of the disk.", + "format": "int32", + "type": "integer" + }, + "sizeGb": { + "description": "Size in GB.", + "format": "int64", + "type": "string" + }, + "volumeId": { + "description": "AWS volume ID.", + "type": "string" + } + }, + "type": "object" + }, "AwsSecurityGroup": { "description": "AwsSecurityGroup describes a security group of an AWS VM.", "id": "AwsSecurityGroup", @@ -2163,6 +2184,13 @@ "format": "int64", "type": "string" }, + "disks": { + "description": "The disks attached to the source VM.", + "items": { + "$ref": "AwsDiskDetails" + }, + "type": "array" + }, "firmware": { "description": "The firmware type of the source VM.", "enum": [ diff --git a/vmmigration/v1/vmmigration-gen.go b/vmmigration/v1/vmmigration-gen.go index 88595a2e26c..cead2d31491 100644 --- a/vmmigration/v1/vmmigration-gen.go +++ b/vmmigration/v1/vmmigration-gen.go @@ -462,6 +462,40 @@ func (s *AvailableUpdates) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// AwsDiskDetails: The details of an AWS instance disk. +type AwsDiskDetails struct { + // DiskNumber: The ordinal number of the disk. + DiskNumber int64 `json:"diskNumber,omitempty"` + + // SizeGb: Size in GB. + SizeGb int64 `json:"sizeGb,omitempty,string"` + + // VolumeId: AWS volume ID. + VolumeId string `json:"volumeId,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DiskNumber") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DiskNumber") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *AwsDiskDetails) MarshalJSON() ([]byte, error) { + type NoMethod AwsDiskDetails + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // AwsSecurityGroup: AwsSecurityGroup describes a security group of an // AWS VM. type AwsSecurityGroup struct { @@ -569,6 +603,9 @@ type AwsSourceVmDetails struct { // bytes. CommittedStorageBytes int64 `json:"committedStorageBytes,omitempty,string"` + // Disks: The disks attached to the source VM. + Disks []*AwsDiskDetails `json:"disks,omitempty"` + // Firmware: The firmware type of the source VM. // // Possible values: diff --git a/vmmigration/v1alpha1/vmmigration-api.json b/vmmigration/v1alpha1/vmmigration-api.json index 9559770e069..66ea9115f10 100644 --- a/vmmigration/v1alpha1/vmmigration-api.json +++ b/vmmigration/v1alpha1/vmmigration-api.json @@ -1972,7 +1972,7 @@ } } }, - "revision": "20230504", + "revision": "20230518", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2076,6 +2076,27 @@ }, "type": "object" }, + "AwsDiskDetails": { + "description": "The details of an AWS instance disk.", + "id": "AwsDiskDetails", + "properties": { + "diskNumber": { + "description": "The ordinal number of the disk.", + "format": "int32", + "type": "integer" + }, + "sizeGb": { + "description": "Size in GB.", + "format": "int64", + "type": "string" + }, + "volumeId": { + "description": "AWS volume ID.", + "type": "string" + } + }, + "type": "object" + }, "AwsSecurityGroup": { "description": "AwsSecurityGroup describes a security group of an AWS VM.", "id": "AwsSecurityGroup", @@ -2163,6 +2184,13 @@ "format": "int64", "type": "string" }, + "disks": { + "description": "The disks attached to the source VM.", + "items": { + "$ref": "AwsDiskDetails" + }, + "type": "array" + }, "firmware": { "description": "The firmware type of the source VM.", "enum": [ diff --git a/vmmigration/v1alpha1/vmmigration-gen.go b/vmmigration/v1alpha1/vmmigration-gen.go index ba4209c3387..7e98714b1c3 100644 --- a/vmmigration/v1alpha1/vmmigration-gen.go +++ b/vmmigration/v1alpha1/vmmigration-gen.go @@ -462,6 +462,40 @@ func (s *AvailableUpdates) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// AwsDiskDetails: The details of an AWS instance disk. +type AwsDiskDetails struct { + // DiskNumber: The ordinal number of the disk. + DiskNumber int64 `json:"diskNumber,omitempty"` + + // SizeGb: Size in GB. + SizeGb int64 `json:"sizeGb,omitempty,string"` + + // VolumeId: AWS volume ID. + VolumeId string `json:"volumeId,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DiskNumber") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DiskNumber") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *AwsDiskDetails) MarshalJSON() ([]byte, error) { + type NoMethod AwsDiskDetails + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // AwsSecurityGroup: AwsSecurityGroup describes a security group of an // AWS VM. type AwsSecurityGroup struct { @@ -569,6 +603,9 @@ type AwsSourceVmDetails struct { // bytes. CommittedStorageBytes int64 `json:"committedStorageBytes,omitempty,string"` + // Disks: The disks attached to the source VM. + Disks []*AwsDiskDetails `json:"disks,omitempty"` + // Firmware: The firmware type of the source VM. // // Possible values: diff --git a/workflowexecutions/v1/workflowexecutions-api.json b/workflowexecutions/v1/workflowexecutions-api.json index 65d507938ae..3d1e4b325f7 100644 --- a/workflowexecutions/v1/workflowexecutions-api.json +++ b/workflowexecutions/v1/workflowexecutions-api.json @@ -309,7 +309,7 @@ } } }, - "revision": "20230328", + "revision": "20230516", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "CancelExecutionRequest": { @@ -424,7 +424,7 @@ }, "stateError": { "$ref": "StateError", - "description": "Output only. Error regarding the state of the Execution resource. For example, this field will have error details if the Execution data is unavailable due to revoked KMS key permissions.", + "description": "Output only. Error regarding the state of the Execution resource. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions.", "readOnly": true }, "status": { diff --git a/workflowexecutions/v1/workflowexecutions-gen.go b/workflowexecutions/v1/workflowexecutions-gen.go index 510d422c517..9335196d7e5 100644 --- a/workflowexecutions/v1/workflowexecutions-gen.go +++ b/workflowexecutions/v1/workflowexecutions-gen.go @@ -291,7 +291,7 @@ type Execution struct { // StateError: Output only. Error regarding the state of the Execution // resource. For example, this field will have error details if the - // Execution data is unavailable due to revoked KMS key permissions. + // execution data is unavailable due to revoked KMS key permissions. StateError *StateError `json:"stateError,omitempty"` // Status: Output only. Status tracks the current steps and progress diff --git a/youtube/v3/youtube-api.json b/youtube/v3/youtube-api.json index 1855a54d3ab..3c7f632b1e9 100644 --- a/youtube/v3/youtube-api.json +++ b/youtube/v3/youtube-api.json @@ -624,6 +624,7 @@ "type": "string" }, "hl": { + "deprecated": true, "description": "Return content in specified language", "location": "query", "type": "string" @@ -3539,6 +3540,7 @@ "type": "string" }, "locale": { + "deprecated": true, "location": "query", "type": "string" }, @@ -3831,7 +3833,7 @@ } } }, - "revision": "20230505", + "revision": "20230522", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { diff --git a/youtube/v3/youtube-gen.go b/youtube/v3/youtube-gen.go index fb0a1f80a9a..d75de3b0dcf 100644 --- a/youtube/v3/youtube-gen.go +++ b/youtube/v3/youtube-gen.go @@ -12668,6 +12668,7 @@ func (c *ChannelSectionsListCall) Do(opts ...googleapi.CallOption) (*ChannelSect // "type": "string" // }, // "hl": { + // "deprecated": true, // "description": "Return content in specified language", // "location": "query", // "type": "string" @@ -24327,6 +24328,7 @@ func (c *VideosListCall) Do(opts ...googleapi.CallOption) (*VideoListResponse, e // "type": "string" // }, // "locale": { + // "deprecated": true, // "location": "query", // "type": "string" // },