From 2d578ca2e3e6778d31a29902a46f8d399289e089 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Thu, 6 Aug 2020 17:17:54 -0700 Subject: [PATCH] feat: run the generator (#2319) * feat(bigquerydatatransfer): update the API #### bigquerydatatransfer:v1 The following keys were added: - resources.projects.resources.locations.resources.transferConfigs.resources.runs.methods.list.parameters.runAttempt.enumDescriptions - resources.projects.resources.locations.resources.transferConfigs.resources.runs.methods.list.parameters.states.enumDescriptions - resources.projects.resources.locations.resources.transferConfigs.resources.runs.resources.transferLogs.methods.list.parameters.messageTypes.enumDescriptions - resources.projects.resources.transferConfigs.resources.runs.methods.list.parameters.runAttempt.enumDescriptions - resources.projects.resources.transferConfigs.resources.runs.methods.list.parameters.states.enumDescriptions - resources.projects.resources.transferConfigs.resources.runs.resources.transferLogs.methods.list.parameters.messageTypes.enumDescriptions - schemas.DataSource.properties.name.readOnly - schemas.ListDataSourcesResponse.properties.nextPageToken.readOnly - schemas.ListTransferConfigsResponse.properties.nextPageToken.readOnly - schemas.ListTransferConfigsResponse.properties.transferConfigs.readOnly - schemas.ListTransferLogsResponse.properties.nextPageToken.readOnly - schemas.ListTransferLogsResponse.properties.transferMessages.readOnly - schemas.ListTransferRunsResponse.properties.nextPageToken.readOnly - schemas.ListTransferRunsResponse.properties.transferRuns.readOnly - schemas.TransferConfig.properties.datasetRegion.readOnly - schemas.TransferConfig.properties.nextRunTime.readOnly - schemas.TransferConfig.properties.state.readOnly - schemas.TransferConfig.properties.updateTime.readOnly - schemas.TransferRun.properties.dataSourceId.readOnly - schemas.TransferRun.properties.destinationDatasetId.readOnly - schemas.TransferRun.properties.emailPreferences.readOnly - schemas.TransferRun.properties.endTime.readOnly - schemas.TransferRun.properties.notificationPubsubTopic.readOnly - schemas.TransferRun.properties.params.readOnly - schemas.TransferRun.properties.schedule.readOnly - schemas.TransferRun.properties.startTime.readOnly - schemas.TransferRun.properties.updateTime.readOnly The following keys were changed: - resources.projects.resources.dataSources.methods.checkValidCreds.description - resources.projects.resources.dataSources.methods.checkValidCreds.parameters.name.description - resources.projects.resources.dataSources.methods.get.description - resources.projects.resources.dataSources.methods.get.parameters.name.description - resources.projects.resources.dataSources.methods.list.description - resources.projects.resources.dataSources.methods.list.parameters.pageToken.description - resources.projects.resources.dataSources.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.dataSources.methods.checkValidCreds.description - resources.projects.resources.locations.resources.dataSources.methods.checkValidCreds.parameters.name.description - resources.projects.resources.locations.resources.dataSources.methods.get.description - resources.projects.resources.locations.resources.dataSources.methods.get.parameters.name.description - resources.projects.resources.locations.resources.dataSources.methods.list.description - resources.projects.resources.locations.resources.dataSources.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.dataSources.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.transferConfigs.methods.create.parameters.authorizationCode.description - resources.projects.resources.locations.resources.transferConfigs.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.transferConfigs.methods.create.parameters.serviceAccountName.description - resources.projects.resources.locations.resources.transferConfigs.methods.create.parameters.versionInfo.description - resources.projects.resources.locations.resources.transferConfigs.methods.delete.description - resources.projects.resources.locations.resources.transferConfigs.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.transferConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.transferConfigs.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.transferConfigs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.transferConfigs.methods.patch.description - resources.projects.resources.locations.resources.transferConfigs.methods.patch.parameters.authorizationCode.description - resources.projects.resources.locations.resources.transferConfigs.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.transferConfigs.methods.patch.parameters.serviceAccountName.description - resources.projects.resources.locations.resources.transferConfigs.methods.patch.parameters.versionInfo.description - resources.projects.resources.locations.resources.transferConfigs.methods.scheduleRuns.description - resources.projects.resources.locations.resources.transferConfigs.methods.scheduleRuns.parameters.parent.description - resources.projects.resources.locations.resources.transferConfigs.methods.startManualRuns.description - resources.projects.resources.locations.resources.transferConfigs.methods.startManualRuns.parameters.parent.description - resources.projects.resources.locations.resources.transferConfigs.resources.runs.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.transferConfigs.resources.runs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.transferConfigs.resources.runs.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.transferConfigs.resources.runs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.transferConfigs.resources.runs.resources.transferLogs.methods.list.parameters.messageTypes.description - resources.projects.resources.locations.resources.transferConfigs.resources.runs.resources.transferLogs.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.transferConfigs.resources.runs.resources.transferLogs.methods.list.parameters.parent.description - resources.projects.resources.transferConfigs.methods.create.parameters.authorizationCode.description - resources.projects.resources.transferConfigs.methods.create.parameters.parent.description - resources.projects.resources.transferConfigs.methods.create.parameters.serviceAccountName.description - resources.projects.resources.transferConfigs.methods.create.parameters.versionInfo.description - resources.projects.resources.transferConfigs.methods.delete.description - resources.projects.resources.transferConfigs.methods.delete.parameters.name.description - resources.projects.resources.transferConfigs.methods.get.parameters.name.description - resources.projects.resources.transferConfigs.methods.list.parameters.pageToken.description - resources.projects.resources.transferConfigs.methods.list.parameters.parent.description - resources.projects.resources.transferConfigs.methods.patch.description - resources.projects.resources.transferConfigs.methods.patch.parameters.authorizationCode.description - resources.projects.resources.transferConfigs.methods.patch.parameters.name.description - resources.projects.resources.transferConfigs.methods.patch.parameters.serviceAccountName.description - resources.projects.resources.transferConfigs.methods.patch.parameters.versionInfo.description - resources.projects.resources.transferConfigs.methods.scheduleRuns.description - resources.projects.resources.transferConfigs.methods.scheduleRuns.parameters.parent.description - resources.projects.resources.transferConfigs.methods.startManualRuns.description - resources.projects.resources.transferConfigs.methods.startManualRuns.parameters.parent.description - resources.projects.resources.transferConfigs.resources.runs.methods.delete.parameters.name.description - resources.projects.resources.transferConfigs.resources.runs.methods.get.parameters.name.description - resources.projects.resources.transferConfigs.resources.runs.methods.list.parameters.pageToken.description - resources.projects.resources.transferConfigs.resources.runs.methods.list.parameters.parent.description - resources.projects.resources.transferConfigs.resources.runs.resources.transferLogs.methods.list.parameters.messageTypes.description - resources.projects.resources.transferConfigs.resources.runs.resources.transferLogs.methods.list.parameters.pageToken.description - resources.projects.resources.transferConfigs.resources.runs.resources.transferLogs.methods.list.parameters.parent.description - schemas.CheckValidCredsRequest.description - schemas.DataSource.description - schemas.DataSource.properties.authorizationType.enumDescriptions - schemas.DataSource.properties.dataRefreshType.description - schemas.DataSource.properties.dataRefreshType.enumDescriptions - schemas.DataSource.properties.defaultDataRefreshWindowDays.description - schemas.DataSource.properties.defaultSchedule.description - schemas.DataSource.properties.manualRunsDisabled.description - schemas.DataSource.properties.scopes.description - schemas.DataSource.properties.supportsCustomSchedule.description - schemas.DataSource.properties.transferType.enumDescriptions - schemas.DataSource.properties.updateDeadlineSeconds.description - schemas.DataSourceParameter.description - schemas.DataSourceParameter.properties.deprecated.description - schemas.DataSourceParameter.properties.type.enumDescriptions - schemas.DataSourceParameter.properties.validationDescription.description - schemas.EmailPreferences.description - schemas.Empty.description - schemas.ListDataSourcesResponse.properties.nextPageToken.description - schemas.ListTransferConfigsResponse.properties.nextPageToken.description - schemas.ListTransferLogsResponse.properties.nextPageToken.description - schemas.ListTransferRunsResponse.properties.nextPageToken.description - schemas.Location.properties.displayName.description - schemas.Location.properties.labels.description - schemas.Location.properties.metadata.description - schemas.Location.properties.name.description - schemas.ScheduleOptions.properties.disableAutoScheduling.description - schemas.ScheduleOptions.properties.endTime.description - schemas.ScheduleOptions.properties.startTime.description - schemas.ScheduleTransferRunsRequest.properties.endTime.description - schemas.ScheduleTransferRunsRequest.properties.startTime.description - schemas.StartManualTransferRunsRequest.properties.requestedRunTime.description - schemas.Status.description - schemas.Status.properties.details.description - schemas.Status.properties.message.description - schemas.TimeRange.description - schemas.TimeRange.properties.endTime.description - schemas.TimeRange.properties.startTime.description - schemas.TransferConfig.description - schemas.TransferConfig.properties.dataRefreshWindowDays.description - schemas.TransferConfig.properties.disabled.description - schemas.TransferConfig.properties.emailPreferences.description - schemas.TransferConfig.properties.name.description - schemas.TransferConfig.properties.notificationPubsubTopic.description - schemas.TransferConfig.properties.schedule.description - schemas.TransferConfig.properties.state.enumDescriptions - schemas.TransferRun.properties.emailPreferences.description - schemas.TransferRun.properties.endTime.description - schemas.TransferRun.properties.name.description - schemas.TransferRun.properties.notificationPubsubTopic.description - schemas.TransferRun.properties.runTime.description - schemas.TransferRun.properties.schedule.description - schemas.TransferRun.properties.startTime.description - schemas.TransferRun.properties.state.enumDescriptions * fix(cloudasset): update the API #### cloudasset:v1p4beta1 The following keys were changed: - schemas.GoogleCloudAssetV1p4beta1AnalysisState.properties.code.enumDescriptions #### cloudasset:v1p5beta1 The following keys were changed: - schemas.GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices.properties.allowedServices.description #### cloudasset:v1 The following keys were changed: - schemas.ExportAssetsRequest.properties.contentType.enumDescriptions - schemas.Feed.properties.condition.description - schemas.Feed.properties.contentType.enumDescriptions - schemas.GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices.properties.allowedServices.description #### cloudasset:v1beta1 The following keys were changed: - schemas.GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices.properties.allowedServices.description * feat(cloudbuild): update the API #### cloudbuild:v1alpha1 The following keys were added: - schemas.Build.properties.buildTriggerId.readOnly - schemas.Build.properties.createTime.readOnly - schemas.Build.properties.finishTime.readOnly - schemas.Build.properties.id.readOnly - schemas.Build.properties.logUrl.readOnly - schemas.Build.properties.projectId.readOnly - schemas.Build.properties.results.readOnly - schemas.Build.properties.startTime.readOnly - schemas.Build.properties.timing.readOnly - schemas.BuildOptions.properties.sourceProvenanceHash.items.enumDescriptions - schemas.BuildStep.properties.pullTiming.readOnly - schemas.BuildStep.properties.timing.readOnly - schemas.BuiltImage.properties.pushTiming.readOnly - schemas.SourceProvenance.properties.fileHashes.readOnly - schemas.WorkerPool.properties.regions.items.enumDescriptions The following keys were changed: - resources.projects.resources.locations.resources.operations.methods.cancel.description - resources.projects.resources.locations.resources.operations.methods.get.description - resources.projects.resources.workerPools.methods.delete.parameters.name.description - resources.projects.resources.workerPools.methods.get.parameters.name.description - resources.projects.resources.workerPools.methods.patch.parameters.name.description - schemas.ArtifactObjects.description - schemas.ArtifactObjects.properties.location.description - schemas.ArtifactResult.description - schemas.ArtifactResult.properties.location.description - schemas.Artifacts.description - schemas.Artifacts.properties.images.description - schemas.Artifacts.properties.objects.description - schemas.Build.description - schemas.Build.properties.artifacts.description - schemas.Build.properties.buildTriggerId.description - schemas.Build.properties.finishTime.description - schemas.Build.properties.images.description - schemas.Build.properties.logsBucket.description - schemas.Build.properties.queueTtl.description - schemas.Build.properties.timeout.description - schemas.Build.properties.timing.description - schemas.BuildOptions.properties.diskSizeGb.description - schemas.BuildOptions.properties.dynamicSubstitutions.description - schemas.BuildOptions.properties.env.description - schemas.BuildOptions.properties.logStreamingOption.description - schemas.BuildOptions.properties.logStreamingOption.enumDescriptions - schemas.BuildOptions.properties.logging.description - schemas.BuildOptions.properties.logging.enumDescriptions - schemas.BuildOptions.properties.secretEnv.description - schemas.BuildOptions.properties.substitutionOption.description - schemas.BuildOptions.properties.substitutionOption.enumDescriptions - schemas.BuildOptions.properties.volumes.description - schemas.BuildOptions.properties.workerPool.description - schemas.BuildStep.properties.args.description - schemas.BuildStep.properties.dir.description - schemas.BuildStep.properties.entrypoint.description - schemas.BuildStep.properties.env.description - schemas.BuildStep.properties.id.description - schemas.BuildStep.properties.name.description - schemas.BuildStep.properties.pullTiming.description - schemas.BuildStep.properties.secretEnv.description - schemas.BuildStep.properties.status.description - schemas.BuildStep.properties.timeout.description - schemas.BuildStep.properties.volumes.description - schemas.BuildStep.properties.waitFor.description - schemas.BuiltImage.properties.name.description - schemas.Empty.description - schemas.FileHashes.description - schemas.Network.properties.network.description - schemas.Network.properties.projectId.description - schemas.Network.properties.subnetwork.description - schemas.Notification.description - schemas.Notification.properties.filter.description - schemas.NotifierMetadata.description - schemas.NotifierMetadata.properties.name.description - schemas.NotifierMetadata.properties.notifier.description - schemas.NotifierSecret.description - schemas.NotifierSecret.properties.name.description - schemas.NotifierSecret.properties.value.description - schemas.NotifierSecretRef.description - schemas.NotifierSecretRef.properties.secretRef.description - schemas.Operation.description - schemas.Operation.properties.done.description - schemas.Operation.properties.metadata.description - schemas.Operation.properties.name.description - schemas.Operation.properties.response.description - schemas.RepoSource.properties.branchName.description - schemas.RepoSource.properties.dir.description - schemas.RepoSource.properties.invertRegex.description - schemas.RepoSource.properties.projectId.description - schemas.RepoSource.properties.substitutions.description - schemas.RepoSource.properties.tagName.description - schemas.Results.properties.buildStepImages.description - schemas.Results.properties.buildStepOutputs.description - schemas.SMTPDelivery.properties.fromAddress.description - schemas.SMTPDelivery.properties.recipientAddresses.description - schemas.Secret.description - schemas.Secret.properties.secretEnv.description - schemas.SlackDelivery.description - schemas.SlackDelivery.properties.webhookUri.description - schemas.Source.properties.repoSource.description - schemas.SourceProvenance.description - schemas.SourceProvenance.properties.fileHashes.description - schemas.SourceProvenance.properties.resolvedRepoSource.description - schemas.SourceProvenance.properties.resolvedStorageSource.description - schemas.Status.description - schemas.Status.properties.details.description - schemas.Status.properties.message.description - schemas.StorageSource.properties.bucket.description - schemas.StorageSource.properties.generation.description - schemas.StorageSource.properties.object.description - schemas.Volume.description - schemas.Volume.properties.name.description - schemas.Volume.properties.path.description - schemas.WorkerConfig.description - schemas.WorkerConfig.properties.diskSizeGb.description - schemas.WorkerConfig.properties.machineType.description - schemas.WorkerConfig.properties.network.description - schemas.WorkerConfig.properties.tag.description - schemas.WorkerPool.description - schemas.WorkerPool.properties.createTime.description - schemas.WorkerPool.properties.deleteTime.description - schemas.WorkerPool.properties.regions.description - schemas.WorkerPool.properties.serviceAccountEmail.description - schemas.WorkerPool.properties.updateTime.description #### cloudbuild:v1alpha2 The following keys were added: - schemas.Build.properties.buildTriggerId.readOnly - schemas.Build.properties.createTime.readOnly - schemas.Build.properties.finishTime.readOnly - schemas.Build.properties.id.readOnly - schemas.Build.properties.logUrl.readOnly - schemas.Build.properties.projectId.readOnly - schemas.Build.properties.results.readOnly - schemas.Build.properties.startTime.readOnly - schemas.Build.properties.timing.readOnly - schemas.BuildOptions.properties.sourceProvenanceHash.items.enumDescriptions - schemas.BuildStep.properties.pullTiming.readOnly - schemas.BuildStep.properties.timing.readOnly - schemas.BuiltImage.properties.pushTiming.readOnly - schemas.SourceProvenance.properties.fileHashes.readOnly - schemas.WorkerPool.properties.createTime.readOnly - schemas.WorkerPool.properties.deleteTime.readOnly - schemas.WorkerPool.properties.name.readOnly - schemas.WorkerPool.properties.state.readOnly - schemas.WorkerPool.properties.updateTime.readOnly The following keys were changed: - resources.projects.resources.locations.resources.operations.methods.cancel.description - resources.projects.resources.locations.resources.operations.methods.get.description - resources.projects.resources.workerPools.methods.create.parameters.parent.description - resources.projects.resources.workerPools.methods.create.parameters.workerPoolId.description - resources.projects.resources.workerPools.methods.delete.parameters.name.description - resources.projects.resources.workerPools.methods.get.parameters.name.description - resources.projects.resources.workerPools.methods.list.parameters.parent.description - resources.projects.resources.workerPools.methods.patch.parameters.name.description - schemas.ArtifactObjects.description - schemas.ArtifactObjects.properties.location.description - schemas.ArtifactResult.description - schemas.ArtifactResult.properties.location.description - schemas.Artifacts.description - schemas.Artifacts.properties.images.description - schemas.Artifacts.properties.objects.description - schemas.Build.description - schemas.Build.properties.artifacts.description - schemas.Build.properties.buildTriggerId.description - schemas.Build.properties.finishTime.description - schemas.Build.properties.images.description - schemas.Build.properties.logsBucket.description - schemas.Build.properties.queueTtl.description - schemas.Build.properties.timeout.description - schemas.Build.properties.timing.description - schemas.BuildOptions.properties.diskSizeGb.description - schemas.BuildOptions.properties.dynamicSubstitutions.description - schemas.BuildOptions.properties.env.description - schemas.BuildOptions.properties.logStreamingOption.description - schemas.BuildOptions.properties.logStreamingOption.enumDescriptions - schemas.BuildOptions.properties.logging.description - schemas.BuildOptions.properties.logging.enumDescriptions - schemas.BuildOptions.properties.secretEnv.description - schemas.BuildOptions.properties.substitutionOption.description - schemas.BuildOptions.properties.substitutionOption.enumDescriptions - schemas.BuildOptions.properties.volumes.description - schemas.BuildOptions.properties.workerPool.description - schemas.BuildStep.properties.args.description - schemas.BuildStep.properties.dir.description - schemas.BuildStep.properties.entrypoint.description - schemas.BuildStep.properties.env.description - schemas.BuildStep.properties.id.description - schemas.BuildStep.properties.name.description - schemas.BuildStep.properties.pullTiming.description - schemas.BuildStep.properties.secretEnv.description - schemas.BuildStep.properties.status.description - schemas.BuildStep.properties.timeout.description - schemas.BuildStep.properties.volumes.description - schemas.BuildStep.properties.waitFor.description - schemas.BuiltImage.properties.name.description - schemas.Empty.description - schemas.FileHashes.description - schemas.NetworkConfig.properties.peeredNetwork.description - schemas.Notification.description - schemas.Notification.properties.filter.description - schemas.NotifierMetadata.description - schemas.NotifierMetadata.properties.name.description - schemas.NotifierMetadata.properties.notifier.description - schemas.NotifierSecret.description - schemas.NotifierSecret.properties.name.description - schemas.NotifierSecret.properties.value.description - schemas.NotifierSecretRef.description - schemas.NotifierSecretRef.properties.secretRef.description - schemas.Operation.description - schemas.Operation.properties.done.description - schemas.Operation.properties.metadata.description - schemas.Operation.properties.name.description - schemas.Operation.properties.response.description - schemas.RepoSource.properties.branchName.description - schemas.RepoSource.properties.dir.description - schemas.RepoSource.properties.invertRegex.description - schemas.RepoSource.properties.projectId.description - schemas.RepoSource.properties.substitutions.description - schemas.RepoSource.properties.tagName.description - schemas.Results.properties.buildStepImages.description - schemas.Results.properties.buildStepOutputs.description - schemas.SMTPDelivery.properties.fromAddress.description - schemas.SMTPDelivery.properties.recipientAddresses.description - schemas.Secret.description - schemas.Secret.properties.secretEnv.description - schemas.SlackDelivery.description - schemas.SlackDelivery.properties.webhookUri.description - schemas.Source.properties.repoSource.description - schemas.SourceProvenance.description - schemas.SourceProvenance.properties.fileHashes.description - schemas.SourceProvenance.properties.resolvedRepoSource.description - schemas.SourceProvenance.properties.resolvedStorageSource.description - schemas.Status.description - schemas.Status.properties.details.description - schemas.Status.properties.message.description - schemas.StorageSource.properties.bucket.description - schemas.StorageSource.properties.generation.description - schemas.StorageSource.properties.object.description - schemas.Volume.description - schemas.Volume.properties.name.description - schemas.Volume.properties.path.description - schemas.WorkerConfig.description - schemas.WorkerConfig.properties.diskSizeGb.description - schemas.WorkerConfig.properties.machineType.description - schemas.WorkerPool.description - schemas.WorkerPool.properties.createTime.description - schemas.WorkerPool.properties.deleteTime.description - schemas.WorkerPool.properties.name.description - schemas.WorkerPool.properties.region.description - schemas.WorkerPool.properties.updateTime.description #### cloudbuild:v1 The following keys were added: - schemas.Build.properties.buildTriggerId.readOnly - schemas.Build.properties.createTime.readOnly - schemas.Build.properties.finishTime.readOnly - schemas.Build.properties.id.readOnly - schemas.Build.properties.logUrl.readOnly - schemas.Build.properties.projectId.readOnly - schemas.Build.properties.results.readOnly - schemas.Build.properties.startTime.readOnly - schemas.Build.properties.timing.readOnly - schemas.BuildOptions.properties.sourceProvenanceHash.items.enumDescriptions - schemas.BuildStep.properties.pullTiming.readOnly - schemas.BuildStep.properties.timing.readOnly - schemas.BuildTrigger.properties.createTime.readOnly - schemas.BuildTrigger.properties.id.readOnly - schemas.BuiltImage.properties.pushTiming.readOnly - schemas.SourceProvenance.properties.fileHashes.readOnly The following keys were changed: - resources.operations.methods.cancel.description - resources.operations.methods.get.description - resources.projects.resources.builds.methods.create.description - resources.projects.resources.builds.methods.get.description - resources.projects.resources.builds.methods.list.description - resources.projects.resources.builds.methods.retry.description - resources.projects.resources.locations.resources.operations.methods.cancel.description - resources.projects.resources.locations.resources.operations.methods.get.description - resources.projects.resources.triggers.methods.create.description - resources.projects.resources.triggers.methods.delete.description - resources.projects.resources.triggers.methods.get.description - resources.projects.resources.triggers.methods.list.description - resources.projects.resources.triggers.methods.patch.description - schemas.ArtifactObjects.description - schemas.ArtifactObjects.properties.location.description - schemas.ArtifactResult.description - schemas.ArtifactResult.properties.location.description - schemas.Artifacts.description - schemas.Artifacts.properties.images.description - schemas.Artifacts.properties.objects.description - schemas.Build.description - schemas.Build.properties.artifacts.description - schemas.Build.properties.buildTriggerId.description - schemas.Build.properties.finishTime.description - schemas.Build.properties.images.description - schemas.Build.properties.logsBucket.description - schemas.Build.properties.queueTtl.description - schemas.Build.properties.timeout.description - schemas.Build.properties.timing.description - schemas.BuildOptions.properties.diskSizeGb.description - schemas.BuildOptions.properties.dynamicSubstitutions.description - schemas.BuildOptions.properties.env.description - schemas.BuildOptions.properties.logStreamingOption.description - schemas.BuildOptions.properties.logStreamingOption.enumDescriptions - schemas.BuildOptions.properties.logging.description - schemas.BuildOptions.properties.logging.enumDescriptions - schemas.BuildOptions.properties.secretEnv.description - schemas.BuildOptions.properties.substitutionOption.description - schemas.BuildOptions.properties.substitutionOption.enumDescriptions - schemas.BuildOptions.properties.volumes.description - schemas.BuildOptions.properties.workerPool.description - schemas.BuildStep.properties.args.description - schemas.BuildStep.properties.dir.description - schemas.BuildStep.properties.entrypoint.description - schemas.BuildStep.properties.env.description - schemas.BuildStep.properties.id.description - schemas.BuildStep.properties.name.description - schemas.BuildStep.properties.pullTiming.description - schemas.BuildStep.properties.secretEnv.description - schemas.BuildStep.properties.status.description - schemas.BuildStep.properties.timeout.description - schemas.BuildStep.properties.volumes.description - schemas.BuildStep.properties.waitFor.description - schemas.BuildTrigger.description - schemas.BuildTrigger.properties.filename.description - schemas.BuildTrigger.properties.github.description - schemas.BuildTrigger.properties.ignoredFiles.description - schemas.BuildTrigger.properties.includedFiles.description - schemas.BuildTrigger.properties.name.description - schemas.BuildTrigger.properties.substitutions.description - schemas.BuildTrigger.properties.triggerTemplate.description - schemas.BuiltImage.properties.name.description - schemas.Empty.description - schemas.FileHashes.description - schemas.GitHubEventsConfig.description - schemas.GitHubEventsConfig.properties.name.description - schemas.GitHubEventsConfig.properties.owner.description - schemas.Notification.description - schemas.Notification.properties.filter.description - schemas.NotifierMetadata.description - schemas.NotifierMetadata.properties.name.description - schemas.NotifierMetadata.properties.notifier.description - schemas.NotifierSecret.description - schemas.NotifierSecret.properties.name.description - schemas.NotifierSecret.properties.value.description - schemas.NotifierSecretRef.description - schemas.NotifierSecretRef.properties.secretRef.description - schemas.Operation.description - schemas.Operation.properties.done.description - schemas.Operation.properties.metadata.description - schemas.Operation.properties.name.description - schemas.Operation.properties.response.description - schemas.PullRequestFilter.description - schemas.PullRequestFilter.properties.branch.description - schemas.PullRequestFilter.properties.commentControl.description - schemas.PullRequestFilter.properties.commentControl.enumDescriptions - schemas.PushFilter.properties.branch.description - schemas.PushFilter.properties.invertRegex.description - schemas.PushFilter.properties.tag.description - schemas.RepoSource.properties.branchName.description - schemas.RepoSource.properties.dir.description - schemas.RepoSource.properties.invertRegex.description - schemas.RepoSource.properties.projectId.description - schemas.RepoSource.properties.substitutions.description - schemas.RepoSource.properties.tagName.description - schemas.Results.properties.buildStepImages.description - schemas.Results.properties.buildStepOutputs.description - schemas.SMTPDelivery.properties.fromAddress.description - schemas.SMTPDelivery.properties.recipientAddresses.description - schemas.Secret.description - schemas.Secret.properties.secretEnv.description - schemas.SlackDelivery.description - schemas.SlackDelivery.properties.webhookUri.description - schemas.Source.properties.repoSource.description - schemas.SourceProvenance.description - schemas.SourceProvenance.properties.fileHashes.description - schemas.SourceProvenance.properties.resolvedRepoSource.description - schemas.SourceProvenance.properties.resolvedStorageSource.description - schemas.Status.description - schemas.Status.properties.details.description - schemas.Status.properties.message.description - schemas.StorageSource.properties.bucket.description - schemas.StorageSource.properties.generation.description - schemas.StorageSource.properties.object.description - schemas.Volume.description - schemas.Volume.properties.name.description - schemas.Volume.properties.path.description * fix(cloudfunctions): update the API * feat(cloudshell)!: update the API BREAKING CHANGE: This release has breaking changes. #### cloudshell:v1alpha1 The following keys were changed: - description - resources.users.resources.environments.methods.authorize.description - resources.users.resources.environments.methods.authorize.parameters.name.description - resources.users.resources.environments.methods.get.parameters.name.description - resources.users.resources.environments.methods.patch.parameters.name.description - resources.users.resources.environments.methods.start.description - resources.users.resources.environments.methods.start.parameters.name.description - resources.users.resources.environments.resources.publicKeys.methods.create.description - resources.users.resources.environments.resources.publicKeys.methods.delete.description - resources.users.resources.environments.resources.publicKeys.methods.delete.parameters.name.description - schemas.AuthorizeEnvironmentRequest.description - schemas.AuthorizeEnvironmentRequest.properties.expireTime.description - schemas.CreatePublicKeyRequest.description - schemas.Empty.description - schemas.Environment.description - schemas.Environment.properties.dockerImage.description - schemas.Environment.properties.id.description - schemas.Environment.properties.name.description - schemas.Environment.properties.publicKeys.description - schemas.Environment.properties.size.description - schemas.Environment.properties.sshHost.description - schemas.Environment.properties.sshPort.description - schemas.Environment.properties.sshUsername.description - schemas.Environment.properties.state.enumDescriptions - schemas.Environment.properties.vmSizeExpireTime.description - schemas.Environment.properties.webHost.description - schemas.Environment.properties.webPorts.description - schemas.Operation.description - schemas.Operation.properties.done.description - schemas.Operation.properties.metadata.description - schemas.Operation.properties.name.description - schemas.Operation.properties.response.description - schemas.PublicKey.properties.name.description - schemas.StartEnvironmentMetadata.description - schemas.StartEnvironmentMetadata.properties.state.enumDescriptions - schemas.StartEnvironmentRequest.description - schemas.StartEnvironmentRequest.properties.accessToken.description - schemas.StartEnvironmentResponse.description - schemas.Status.description - schemas.Status.properties.details.description - schemas.Status.properties.message.description #### cloudshell:v1 The following keys were deleted: - schemas.Environment.description - schemas.Environment.id - schemas.Environment.properties.dockerImage.description - schemas.Environment.properties.dockerImage.type - schemas.Environment.properties.id.description - schemas.Environment.properties.id.type - schemas.Environment.properties.name.description - schemas.Environment.properties.name.type - schemas.Environment.properties.publicKeys.description - schemas.Environment.properties.publicKeys.items.$ref - schemas.Environment.properties.publicKeys.type - schemas.Environment.properties.size.description - schemas.Environment.properties.size.enum - schemas.Environment.properties.size.enumDescriptions - schemas.Environment.properties.size.type - schemas.Environment.properties.sshHost.description - schemas.Environment.properties.sshHost.type - schemas.Environment.properties.sshPort.description - schemas.Environment.properties.sshPort.format - schemas.Environment.properties.sshPort.type - schemas.Environment.properties.sshUsername.description - schemas.Environment.properties.sshUsername.type - schemas.Environment.properties.state.description - schemas.Environment.properties.state.enum - schemas.Environment.properties.state.enumDescriptions - schemas.Environment.properties.state.type - schemas.Environment.properties.vmSizeExpireTime.description - schemas.Environment.properties.vmSizeExpireTime.format - schemas.Environment.properties.vmSizeExpireTime.type - schemas.Environment.properties.webHost.description - schemas.Environment.properties.webHost.type - schemas.Environment.properties.webPorts.description - schemas.Environment.properties.webPorts.items.format - schemas.Environment.properties.webPorts.items.type - schemas.Environment.properties.webPorts.type - schemas.Environment.type - schemas.PublicKey.description - schemas.PublicKey.id - schemas.PublicKey.properties.format.description - schemas.PublicKey.properties.format.enum - schemas.PublicKey.properties.format.enumDescriptions - schemas.PublicKey.properties.format.type - schemas.PublicKey.properties.key.description - schemas.PublicKey.properties.key.format - schemas.PublicKey.properties.key.type - schemas.PublicKey.properties.name.description - schemas.PublicKey.properties.name.type - schemas.PublicKey.type - schemas.StartEnvironmentMetadata.description - schemas.StartEnvironmentMetadata.id - schemas.StartEnvironmentMetadata.properties.state.description - schemas.StartEnvironmentMetadata.properties.state.enum - schemas.StartEnvironmentMetadata.properties.state.enumDescriptions - schemas.StartEnvironmentMetadata.properties.state.type - schemas.StartEnvironmentMetadata.type - schemas.StartEnvironmentResponse.description - schemas.StartEnvironmentResponse.id - schemas.StartEnvironmentResponse.properties.environment.$ref - schemas.StartEnvironmentResponse.properties.environment.description - schemas.StartEnvironmentResponse.type The following keys were changed: - description - resources.operations.methods.cancel.description - resources.operations.methods.delete.description - resources.operations.methods.get.description - resources.operations.methods.list.description - schemas.Empty.description - schemas.Operation.description - schemas.Operation.properties.done.description - schemas.Operation.properties.metadata.description - schemas.Operation.properties.name.description - schemas.Operation.properties.response.description - schemas.Status.description - schemas.Status.properties.details.description - schemas.Status.properties.message.description * feat(dataproc): update the API #### dataproc:v1beta2 The following keys were added: - schemas.ClusterConfig.properties.metastoreConfig.$ref - schemas.ClusterConfig.properties.metastoreConfig.description - schemas.MetastoreConfig.description - schemas.MetastoreConfig.id - schemas.MetastoreConfig.properties.dataprocMetastoreService.description - schemas.MetastoreConfig.properties.dataprocMetastoreService.type - schemas.MetastoreConfig.type * feat(doubleclickbidmanager): update the API #### doubleclickbidmanager:v1.1 The following keys were added: - schemas.ChannelGrouping.description - schemas.ChannelGrouping.id - schemas.ChannelGrouping.properties.fallbackName.description - schemas.ChannelGrouping.properties.fallbackName.type - schemas.ChannelGrouping.properties.name.description - schemas.ChannelGrouping.properties.name.type - schemas.ChannelGrouping.properties.rules.description - schemas.ChannelGrouping.properties.rules.items.$ref - schemas.ChannelGrouping.properties.rules.type - schemas.ChannelGrouping.type - schemas.DisjunctiveMatchStatement.description - schemas.DisjunctiveMatchStatement.id - schemas.DisjunctiveMatchStatement.properties.eventFilters.description - schemas.DisjunctiveMatchStatement.properties.eventFilters.items.$ref - schemas.DisjunctiveMatchStatement.properties.eventFilters.type - schemas.DisjunctiveMatchStatement.type - schemas.EventFilter.description - schemas.EventFilter.id - schemas.EventFilter.properties.dimensionFilter.$ref - schemas.EventFilter.properties.dimensionFilter.description - schemas.EventFilter.type - schemas.Options.properties.pathQueryOptions.$ref - schemas.Options.properties.pathQueryOptions.description - schemas.PathFilter.description - schemas.PathFilter.id - schemas.PathFilter.properties.eventFilters.description - schemas.PathFilter.properties.eventFilters.items.$ref - schemas.PathFilter.properties.eventFilters.type - schemas.PathFilter.properties.pathMatchPosition.description - schemas.PathFilter.properties.pathMatchPosition.enum - schemas.PathFilter.properties.pathMatchPosition.enumDescriptions - schemas.PathFilter.properties.pathMatchPosition.type - schemas.PathFilter.type - schemas.PathQueryOptions.description - schemas.PathQueryOptions.id - schemas.PathQueryOptions.properties.channelGrouping.$ref - schemas.PathQueryOptions.properties.channelGrouping.description - schemas.PathQueryOptions.properties.pathFilters.description - schemas.PathQueryOptions.properties.pathFilters.items.$ref - schemas.PathQueryOptions.properties.pathFilters.type - schemas.PathQueryOptions.type - schemas.PathQueryOptionsFilter.description - schemas.PathQueryOptionsFilter.id - schemas.PathQueryOptionsFilter.properties.filter.description - schemas.PathQueryOptionsFilter.properties.filter.enum - schemas.PathQueryOptionsFilter.properties.filter.enumDescriptions - schemas.PathQueryOptionsFilter.properties.filter.type - schemas.PathQueryOptionsFilter.properties.match.description - schemas.PathQueryOptionsFilter.properties.match.enum - schemas.PathQueryOptionsFilter.properties.match.enumDescriptions - schemas.PathQueryOptionsFilter.properties.match.type - schemas.PathQueryOptionsFilter.properties.values.description - schemas.PathQueryOptionsFilter.properties.values.items.type - schemas.PathQueryOptionsFilter.properties.values.type - schemas.PathQueryOptionsFilter.type - schemas.Rule.description - schemas.Rule.id - schemas.Rule.properties.disjunctiveMatchStatements.items.$ref - schemas.Rule.properties.disjunctiveMatchStatements.type - schemas.Rule.properties.name.description - schemas.Rule.properties.name.type - schemas.Rule.type The following keys were changed: - schemas.FilterPair.properties.type.enum - schemas.FilterPair.properties.type.enumDescriptions - schemas.Parameters.properties.groupBys.enumDescriptions - schemas.Parameters.properties.groupBys.items.enum - schemas.Parameters.properties.metrics.enumDescriptions - schemas.Parameters.properties.metrics.items.enum - schemas.Parameters.properties.type.enum - schemas.Parameters.properties.type.enumDescriptions * feat(genomics): update the API #### genomics:v1alpha2 The following keys were changed: - resources.operations.methods.cancel.description - resources.operations.methods.get.description - resources.operations.methods.list.description - resources.operations.methods.list.parameters.filter.description - resources.pipelines.methods.create.description - resources.pipelines.methods.delete.description - resources.pipelines.methods.delete.parameters.pipelineId.description - resources.pipelines.methods.get.description - resources.pipelines.methods.get.parameters.pipelineId.description - resources.pipelines.methods.getControllerConfig.description - resources.pipelines.methods.list.description - resources.pipelines.methods.list.parameters.namePrefix.description - resources.pipelines.methods.list.parameters.pageSize.description - resources.pipelines.methods.list.parameters.pageToken.description - resources.pipelines.methods.list.parameters.projectId.description - resources.pipelines.methods.run.description - resources.pipelines.methods.setOperationStatus.description - schemas.ComputeEngine.description - schemas.ContainerKilledEvent.description - schemas.ContainerStartedEvent.properties.ipAddress.description - schemas.ContainerStartedEvent.properties.portMappings.description - schemas.ContainerStoppedEvent.properties.stderr.description - schemas.ControllerConfig.description - schemas.DelayedEvent.description - schemas.DelayedEvent.properties.cause.description - schemas.DelayedEvent.properties.metrics.description - schemas.Disk.properties.autoDelete.description - schemas.Disk.properties.mountPoint.description - schemas.Disk.properties.name.description - schemas.Disk.properties.readOnly.description - schemas.Disk.properties.sizeGb.description - schemas.Disk.properties.source.description - schemas.Disk.properties.type.enumDescriptions - schemas.DockerExecutor.properties.cmd.description - schemas.DockerExecutor.properties.imageName.description - schemas.Empty.description - schemas.Event.properties.description.description - schemas.FailedEvent.description - schemas.FailedEvent.properties.code.enumDescriptions - schemas.ListPipelinesResponse.description - schemas.LocalCopy.properties.disk.description - schemas.LocalCopy.properties.path.description - schemas.LoggingOptions.properties.gcsPath.description - schemas.Operation.description - schemas.Operation.properties.done.description - schemas.Operation.properties.name.description - schemas.OperationEvent.properties.endTime.description - schemas.OperationMetadata.properties.clientId.description - schemas.OperationMetadata.properties.events.description - schemas.OperationMetadata.properties.labels.description - schemas.OperationMetadata.properties.request.description - schemas.Pipeline.description - schemas.Pipeline.properties.name.description - schemas.Pipeline.properties.pipelineId.description - schemas.Pipeline.properties.projectId.description - schemas.Pipeline.properties.resources.description - schemas.PipelineParameter.description - schemas.PipelineParameter.properties.defaultValue.description - schemas.PipelineParameter.properties.localCopy.description - schemas.PipelineParameter.properties.name.description - schemas.PipelineResources.properties.acceleratorCount.description - schemas.PipelineResources.properties.acceleratorType.description - schemas.PipelineResources.properties.noAddress.description - schemas.PipelineResources.properties.preemptible.description - schemas.PipelineResources.properties.zones.description - schemas.RunPipelineArgs.properties.clientId.description - schemas.RunPipelineArgs.properties.inputs.description - schemas.RunPipelineArgs.properties.keepVmAliveOnFailureDuration.description - schemas.RunPipelineArgs.properties.labels.description - schemas.RunPipelineArgs.properties.logging.description - schemas.RunPipelineArgs.properties.outputs.description - schemas.RunPipelineArgs.properties.projectId.description - schemas.RunPipelineArgs.properties.serviceAccount.description - schemas.RunPipelineRequest.description - schemas.RunPipelineResponse.description - schemas.RuntimeMetadata.description - schemas.ServiceAccount.properties.email.description - schemas.ServiceAccount.properties.scopes.description - schemas.SetOperationStatusRequest.description - schemas.SetOperationStatusRequest.properties.errorCode.enumDescriptions - schemas.Status.description - schemas.Status.properties.details.description - schemas.Status.properties.message.description - schemas.TimestampEvent.description - schemas.UnexpectedExitStatusEvent.description - schemas.WorkerAssignedEvent.description - schemas.WorkerReleasedEvent.description #### genomics:v2alpha1 The following keys were added: - schemas.Action.properties.flags.items.enumDescriptions - schemas.CheckInRequest.properties.sosReport.description - schemas.CheckInRequest.properties.sosReport.format - schemas.CheckInRequest.properties.sosReport.type The following keys were changed: - resources.pipelines.methods.run.description - resources.projects.resources.operations.methods.cancel.description - resources.projects.resources.operations.methods.get.description - resources.projects.resources.operations.methods.list.description - resources.projects.resources.operations.methods.list.parameters.filter.description - resources.projects.resources.workers.methods.checkIn.description - resources.projects.resources.workers.methods.checkIn.parameters.id.description - resources.workers.methods.checkIn.description - resources.workers.methods.checkIn.parameters.id.description - schemas.Accelerator.properties.type.description - schemas.Action.properties.commands.description - schemas.Action.properties.credentials.description - schemas.Action.properties.environment.description - schemas.Action.properties.flags.enumDescriptions - schemas.Action.properties.imageUri.description - schemas.Action.properties.labels.description - schemas.Action.properties.mounts.description - schemas.Action.properties.name.description - schemas.Action.properties.pidNamespace.description - schemas.Action.properties.portMappings.description - schemas.Action.properties.timeout.description - schemas.CheckInResponse.properties.deadline.description - schemas.ComputeEngine.description - schemas.ContainerKilledEvent.description - schemas.ContainerStartedEvent.properties.ipAddress.description - schemas.ContainerStartedEvent.properties.portMappings.description - schemas.ContainerStoppedEvent.properties.stderr.description - schemas.DelayedEvent.description - schemas.DelayedEvent.properties.cause.description - schemas.DelayedEvent.properties.metrics.description - schemas.Disk.description - schemas.Disk.properties.name.description - schemas.Disk.properties.sizeGb.description - schemas.Empty.description - schemas.Event.properties.description.description - schemas.FailedEvent.description - schemas.FailedEvent.properties.code.enumDescriptions - schemas.Metadata.description - schemas.Metadata.properties.events.description - schemas.Network.properties.name.description - schemas.Network.properties.subnetwork.description - schemas.Network.properties.usePrivateAddress.description - schemas.Operation.description - schemas.Operation.properties.done.description - schemas.Operation.properties.name.description - schemas.OperationEvent.properties.endTime.description - schemas.OperationMetadata.properties.clientId.description - schemas.OperationMetadata.properties.events.description - schemas.OperationMetadata.properties.labels.description - schemas.OperationMetadata.properties.request.description - schemas.Pipeline.properties.environment.description - schemas.Pipeline.properties.timeout.description - schemas.Resources.description - schemas.Resources.properties.regions.description - schemas.Resources.properties.zones.description - schemas.RunPipelineRequest.description - schemas.RunPipelineRequest.properties.labels.description - schemas.RunPipelineResponse.description - schemas.RuntimeMetadata.description - schemas.Secret.description - schemas.Secret.properties.cipherText.description - schemas.Secret.properties.keyName.description - schemas.ServiceAccount.properties.email.description - schemas.ServiceAccount.properties.scopes.description - schemas.Status.description - schemas.Status.properties.details.description - schemas.Status.properties.message.description - schemas.TimestampedEvent.description - schemas.UnexpectedExitStatusEvent.description - schemas.VirtualMachine.properties.bootDiskSizeGb.description - schemas.VirtualMachine.properties.bootImage.description - schemas.VirtualMachine.properties.cpuPlatform.description - schemas.VirtualMachine.properties.dockerCacheImages.description - schemas.VirtualMachine.properties.labels.description - schemas.VirtualMachine.properties.machineType.description - schemas.VirtualMachine.properties.nvidiaDriverVersion.description - schemas.VirtualMachine.properties.serviceAccount.description - schemas.WorkerAssignedEvent.description - schemas.WorkerReleasedEvent.description #### genomics:v1 The following keys were changed: - resources.operations.methods.cancel.description - resources.operations.methods.get.description - resources.operations.methods.list.description - resources.operations.methods.list.parameters.filter.description - schemas.ComputeEngine.description - schemas.ContainerKilledEvent.description - schemas.ContainerStartedEvent.properties.ipAddress.description - schemas.ContainerStartedEvent.properties.portMappings.description - schemas.ContainerStoppedEvent.properties.stderr.description - schemas.DelayedEvent.description - schemas.DelayedEvent.properties.cause.description - schemas.DelayedEvent.properties.metrics.description - schemas.Empty.description - schemas.Event.properties.description.description - schemas.FailedEvent.description - schemas.FailedEvent.properties.code.enumDescriptions - schemas.Operation.description - schemas.Operation.properties.done.description - schemas.Operation.properties.name.description - schemas.OperationEvent.properties.endTime.description - schemas.OperationMetadata.properties.clientId.description - schemas.OperationMetadata.properties.events.description - schemas.OperationMetadata.properties.labels.description - schemas.OperationMetadata.properties.request.description - schemas.RunPipelineResponse.description - schemas.RuntimeMetadata.description - schemas.Status.description - schemas.Status.properties.details.description - schemas.Status.properties.message.description - schemas.UnexpectedExitStatusEvent.description - schemas.WorkerAssignedEvent.description - schemas.WorkerReleasedEvent.description * feat(gmail): update the API #### gmail:v1 The following keys were added: - resources.users.resources.drafts.methods.get.parameters.format.enumDescriptions - resources.users.resources.history.methods.list.parameters.historyTypes.enumDescriptions - resources.users.resources.messages.methods.get.parameters.format.enumDescriptions - resources.users.resources.messages.methods.import.parameters.internalDateSource.enumDescriptions - resources.users.resources.messages.methods.insert.parameters.internalDateSource.enumDescriptions - resources.users.resources.threads.methods.get.parameters.format.enumDescriptions The following keys were changed: - description - resources.users.methods.getProfile.parameters.userId.description - resources.users.methods.stop.parameters.userId.description - resources.users.methods.watch.parameters.userId.description - resources.users.resources.drafts.methods.create.parameters.userId.description - resources.users.resources.drafts.methods.delete.description - resources.users.resources.drafts.methods.delete.parameters.userId.description - resources.users.resources.drafts.methods.get.parameters.userId.description - resources.users.resources.drafts.methods.list.parameters.includeSpamTrash.description - resources.users.resources.drafts.methods.list.parameters.q.description - resources.users.resources.drafts.methods.list.parameters.userId.description - resources.users.resources.drafts.methods.send.description - resources.users.resources.drafts.methods.send.parameters.userId.description - resources.users.resources.drafts.methods.update.parameters.userId.description - resources.users.resources.history.methods.list.description - resources.users.resources.history.methods.list.parameters.startHistoryId.description - resources.users.resources.history.methods.list.parameters.userId.description - resources.users.resources.labels.methods.create.parameters.userId.description - resources.users.resources.labels.methods.delete.description - resources.users.resources.labels.methods.delete.parameters.userId.description - resources.users.resources.labels.methods.get.parameters.userId.description - resources.users.resources.labels.methods.list.parameters.userId.description - resources.users.resources.labels.methods.patch.parameters.userId.description - resources.users.resources.labels.methods.update.parameters.userId.description - resources.users.resources.messages.methods.batchDelete.description - resources.users.resources.messages.methods.batchDelete.parameters.userId.description - resources.users.resources.messages.methods.batchModify.parameters.userId.description - resources.users.resources.messages.methods.delete.description - resources.users.resources.messages.methods.delete.parameters.userId.description - resources.users.resources.messages.methods.get.parameters.metadataHeaders.description - resources.users.resources.messages.methods.get.parameters.userId.description - resources.users.resources.messages.methods.import.description - resources.users.resources.messages.methods.import.parameters.deleted.description - resources.users.resources.messages.methods.import.parameters.neverMarkSpam.description - resources.users.resources.messages.methods.import.parameters.processForCalendar.description - resources.users.resources.messages.methods.import.parameters.userId.description - resources.users.resources.messages.methods.insert.description - resources.users.resources.messages.methods.insert.parameters.deleted.description - resources.users.resources.messages.methods.insert.parameters.userId.description - resources.users.resources.messages.methods.list.parameters.includeSpamTrash.description - resources.users.resources.messages.methods.list.parameters.q.description - resources.users.resources.messages.methods.list.parameters.userId.description - resources.users.resources.messages.methods.modify.parameters.userId.description - resources.users.resources.messages.methods.send.description - resources.users.resources.messages.methods.send.parameters.userId.description - resources.users.resources.messages.methods.trash.parameters.userId.description - resources.users.resources.messages.methods.untrash.parameters.userId.description - resources.users.resources.messages.resources.attachments.methods.get.parameters.userId.description - resources.users.resources.settings.methods.getAutoForwarding.parameters.userId.description - resources.users.resources.settings.methods.getImap.parameters.userId.description - resources.users.resources.settings.methods.getLanguage.parameters.userId.description - resources.users.resources.settings.methods.getPop.parameters.userId.description - resources.users.resources.settings.methods.getVacation.parameters.userId.description - resources.users.resources.settings.methods.updateAutoForwarding.description - resources.users.resources.settings.methods.updateAutoForwarding.parameters.userId.description - resources.users.resources.settings.methods.updateImap.parameters.userId.description - resources.users.resources.settings.methods.updateLanguage.description - resources.users.resources.settings.methods.updateLanguage.parameters.userId.description - resources.users.resources.settings.methods.updatePop.parameters.userId.description - resources.users.resources.settings.methods.updateVacation.parameters.userId.description - resources.users.resources.settings.resources.delegates.methods.create.description - resources.users.resources.settings.resources.delegates.methods.create.parameters.userId.description - resources.users.resources.settings.resources.delegates.methods.delete.description - resources.users.resources.settings.resources.delegates.methods.delete.parameters.userId.description - resources.users.resources.settings.resources.delegates.methods.get.description - resources.users.resources.settings.resources.delegates.methods.get.parameters.delegateEmail.description - resources.users.resources.settings.resources.delegates.methods.get.parameters.userId.description - resources.users.resources.settings.resources.delegates.methods.list.description - resources.users.resources.settings.resources.delegates.methods.list.parameters.userId.description - resources.users.resources.settings.resources.filters.methods.create.parameters.userId.description - resources.users.resources.settings.resources.filters.methods.delete.parameters.userId.description - resources.users.resources.settings.resources.filters.methods.get.parameters.userId.description - resources.users.resources.settings.resources.filters.methods.list.parameters.userId.description - resources.users.resources.settings.resources.forwardingAddresses.methods.create.description - resources.users.resources.settings.resources.forwardingAddresses.methods.create.parameters.userId.description - resources.users.resources.settings.resources.forwardingAddresses.methods.delete.description - resources.users.resources.settings.resources.forwardingAddresses.methods.delete.parameters.userId.description - resources.users.resources.settings.resources.forwardingAddresses.methods.get.parameters.userId.description - resources.users.resources.settings.resources.forwardingAddresses.methods.list.parameters.userId.description - resources.users.resources.settings.resources.sendAs.methods.create.description - resources.users.resources.settings.resources.sendAs.methods.create.parameters.userId.description - resources.users.resources.settings.resources.sendAs.methods.delete.description - resources.users.resources.settings.resources.sendAs.methods.delete.parameters.userId.description - resources.users.resources.settings.resources.sendAs.methods.get.description - resources.users.resources.settings.resources.sendAs.methods.get.parameters.userId.description - resources.users.resources.settings.resources.sendAs.methods.list.description - resources.users.resources.settings.resources.sendAs.methods.list.parameters.userId.description - resources.users.resources.settings.resources.sendAs.methods.patch.parameters.userId.description - resources.users.resources.settings.resources.sendAs.methods.update.description - resources.users.resources.settings.resources.sendAs.methods.update.parameters.userId.description - resources.users.resources.settings.resources.sendAs.methods.verify.description - resources.users.resources.settings.resources.sendAs.methods.verify.parameters.userId.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.delete.parameters.sendAsEmail.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.delete.parameters.userId.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.get.parameters.sendAsEmail.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.get.parameters.userId.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.insert.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.insert.parameters.sendAsEmail.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.insert.parameters.userId.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.list.parameters.sendAsEmail.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.list.parameters.userId.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.setDefault.parameters.sendAsEmail.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.setDefault.parameters.userId.description - resources.users.resources.threads.methods.delete.description - resources.users.resources.threads.methods.delete.parameters.userId.description - resources.users.resources.threads.methods.get.parameters.userId.description - resources.users.resources.threads.methods.list.parameters.includeSpamTrash.description - resources.users.resources.threads.methods.list.parameters.q.description - resources.users.resources.threads.methods.list.parameters.userId.description - resources.users.resources.threads.methods.modify.description - resources.users.resources.threads.methods.modify.parameters.userId.description - resources.users.resources.threads.methods.trash.parameters.userId.description - resources.users.resources.threads.methods.untrash.parameters.userId.description - schemas.AutoForwarding.properties.emailAddress.description - schemas.BatchModifyMessagesRequest.properties.ids.description - schemas.Delegate.description - schemas.Delegate.properties.verificationStatus.description - schemas.Delegate.properties.verificationStatus.enumDescriptions - schemas.Filter.description - schemas.FilterCriteria.properties.negatedQuery.description - schemas.FilterCriteria.properties.query.description - schemas.FilterCriteria.properties.size.description - schemas.FilterCriteria.properties.subject.description - schemas.FilterCriteria.properties.to.description - schemas.ForwardingAddress.properties.verificationStatus.description - schemas.History.description - schemas.History.properties.messages.description - schemas.ImapSettings.properties.autoExpunge.description - schemas.ImapSettings.properties.expungeBehavior.description - schemas.ImapSettings.properties.expungeBehavior.enumDescriptions - schemas.ImapSettings.properties.maxFolderSize.description - schemas.Label.description - schemas.Label.properties.color.description - schemas.Label.properties.labelListVisibility.description - schemas.Label.properties.messageListVisibility.description - schemas.Label.properties.name.description - schemas.Label.properties.type.description - schemas.LabelColor.properties.backgroundColor.description - schemas.LabelColor.properties.textColor.description - schemas.LanguageSettings.description - schemas.LanguageSettings.properties.displayLanguage.description - schemas.ListDraftsResponse.properties.drafts.description - schemas.ListHistoryResponse.properties.history.description - schemas.ListLabelsResponse.properties.labels.description - schemas.ListMessagesResponse.properties.messages.description - schemas.ListThreadsResponse.properties.threads.description - schemas.Message.properties.internalDate.description - schemas.Message.properties.labelIds.description - schemas.Message.properties.raw.description - schemas.Message.properties.threadId.description - schemas.MessagePart.properties.body.description - schemas.MessagePart.properties.filename.description - schemas.MessagePart.properties.headers.description - schemas.MessagePart.properties.parts.description - schemas.MessagePartBody.properties.attachmentId.description - schemas.MessagePartBody.properties.data.description - schemas.MessagePartHeader.properties.name.description - schemas.MessagePartHeader.properties.value.description - schemas.PopSettings.properties.accessWindow.enumDescriptions - schemas.PopSettings.properties.disposition.description - schemas.SendAs.description - schemas.SendAs.properties.displayName.description - schemas.SendAs.properties.isDefault.description - schemas.SendAs.properties.isPrimary.description - schemas.SendAs.properties.replyToAddress.description - schemas.SendAs.properties.sendAsEmail.description - schemas.SendAs.properties.signature.description - schemas.SendAs.properties.smtpMsa.description - schemas.SendAs.properties.treatAsAlias.description - schemas.SendAs.properties.verificationStatus.description - schemas.SmimeInfo.properties.pem.description - schemas.SmimeInfo.properties.pkcs12.description - schemas.SmtpMsa.properties.host.description - schemas.SmtpMsa.properties.password.description - schemas.SmtpMsa.properties.port.description - schemas.SmtpMsa.properties.securityMode.description - schemas.SmtpMsa.properties.securityMode.enumDescriptions - schemas.SmtpMsa.properties.username.description - schemas.VacationSettings.description - schemas.VacationSettings.properties.endTime.description - schemas.VacationSettings.properties.responseBodyHtml.description - schemas.VacationSettings.properties.responseBodyPlainText.description - schemas.VacationSettings.properties.responseSubject.description - schemas.VacationSettings.properties.restrictToContacts.description - schemas.VacationSettings.properties.restrictToDomain.description - schemas.VacationSettings.properties.startTime.description - schemas.WatchRequest.properties.labelFilterAction.enumDescriptions - schemas.WatchRequest.properties.labelIds.description - schemas.WatchRequest.properties.topicName.description - schemas.WatchResponse.properties.expiration.description * feat(osconfig): update the API #### osconfig:v1beta The following keys were added: - schemas.ExecResource.description - schemas.ExecResource.id - schemas.ExecResource.properties.enforce.$ref - schemas.ExecResource.properties.enforce.description - schemas.ExecResource.properties.validate.$ref - schemas.ExecResource.properties.validate.description - schemas.ExecResource.type - schemas.ExecResourceExec.description - schemas.ExecResourceExec.id - schemas.ExecResourceExec.properties.allowedSuccessCodes.description - schemas.ExecResourceExec.properties.allowedSuccessCodes.items.format - schemas.ExecResourceExec.properties.allowedSuccessCodes.items.type - schemas.ExecResourceExec.properties.allowedSuccessCodes.type - schemas.ExecResourceExec.properties.args.description - schemas.ExecResourceExec.properties.args.items.type - schemas.ExecResourceExec.properties.args.type - schemas.ExecResourceExec.properties.file.$ref - schemas.ExecResourceExec.properties.file.description - schemas.ExecResourceExec.properties.interpreter.description - schemas.ExecResourceExec.properties.interpreter.enum - schemas.ExecResourceExec.properties.interpreter.enumDescriptions - schemas.ExecResourceExec.properties.interpreter.type - schemas.ExecResourceExec.properties.script.description - schemas.ExecResourceExec.properties.script.type - schemas.ExecResourceExec.type - schemas.ExtractArchiveResource.description - schemas.ExtractArchiveResource.id - schemas.ExtractArchiveResource.properties.creates.description - schemas.ExtractArchiveResource.properties.creates.type - schemas.ExtractArchiveResource.properties.destination.description - schemas.ExtractArchiveResource.properties.destination.type - schemas.ExtractArchiveResource.properties.overwrite.description - schemas.ExtractArchiveResource.properties.overwrite.type - schemas.ExtractArchiveResource.properties.source.$ref - schemas.ExtractArchiveResource.properties.source.description - schemas.ExtractArchiveResource.properties.type.description - schemas.ExtractArchiveResource.properties.type.enum - schemas.ExtractArchiveResource.properties.type.enumDescriptions - schemas.ExtractArchiveResource.properties.type.type - schemas.ExtractArchiveResource.type - schemas.File.description - schemas.File.id - schemas.File.properties.allowInsecure.description - schemas.File.properties.allowInsecure.type - schemas.File.properties.gcs.$ref - schemas.File.properties.gcs.description - schemas.File.properties.localPath.description - schemas.File.properties.localPath.type - schemas.File.properties.remote.$ref - schemas.File.properties.remote.description - schemas.File.type - schemas.FileGcs.description - schemas.FileGcs.id - schemas.FileGcs.properties.bucket.description - schemas.FileGcs.properties.bucket.type - schemas.FileGcs.properties.generation.description - schemas.FileGcs.properties.generation.format - schemas.FileGcs.properties.generation.type - schemas.FileGcs.properties.object.description - schemas.FileGcs.properties.object.type - schemas.FileGcs.type - schemas.FileRemote.description - schemas.FileRemote.id - schemas.FileRemote.properties.sha256Checksum.description - schemas.FileRemote.properties.sha256Checksum.type - schemas.FileRemote.properties.uri.description - schemas.FileRemote.properties.uri.type - schemas.FileRemote.type - schemas.FileResource.description - schemas.FileResource.id - schemas.FileResource.properties.content.description - schemas.FileResource.properties.content.type - schemas.FileResource.properties.file.$ref - schemas.FileResource.properties.file.description - schemas.FileResource.properties.path.description - schemas.FileResource.properties.path.type - schemas.FileResource.properties.permissions.description - schemas.FileResource.properties.permissions.type - schemas.FileResource.properties.state.description - schemas.FileResource.properties.state.enum - schemas.FileResource.properties.state.enumDescriptions - schemas.FileResource.properties.state.type - schemas.FileResource.type - schemas.PackageResource.description - schemas.PackageResource.id - schemas.PackageResource.properties.apt.$ref - schemas.PackageResource.properties.apt.description - schemas.PackageResource.properties.deb.$ref - schemas.PackageResource.properties.deb.description - schemas.PackageResource.properties.desiredState.description - schemas.PackageResource.properties.desiredState.enum - schemas.PackageResource.properties.desiredState.enumDescriptions - schemas.PackageResource.properties.desiredState.type - schemas.PackageResource.properties.googet.$ref - schemas.PackageResource.properties.googet.description - schemas.PackageResource.properties.msi.$ref - schemas.PackageResource.properties.msi.description - schemas.PackageResource.properties.rpm.$ref - schemas.PackageResource.properties.rpm.description - schemas.PackageResource.properties.yum.$ref - schemas.PackageResource.properties.yum.description - schemas.PackageResource.properties.zypper.$ref - schemas.PackageResource.properties.zypper.description - schemas.PackageResource.type - schemas.PackageResourceAPT.description - schemas.PackageResourceAPT.id - schemas.PackageResourceAPT.properties.name.description - schemas.PackageResourceAPT.properties.name.type - schemas.PackageResourceAPT.type - schemas.PackageResourceDeb.description - schemas.PackageResourceDeb.id - schemas.PackageResourceDeb.properties.pullDeps.description - schemas.PackageResourceDeb.properties.pullDeps.type - schemas.PackageResourceDeb.properties.source.$ref - schemas.PackageResourceDeb.properties.source.description - schemas.PackageResourceDeb.type - schemas.PackageResourceGooGet.description - schemas.PackageResourceGooGet.id - schemas.PackageResourceGooGet.properties.name.description - schemas.PackageResourceGooGet.properties.name.type - schemas.PackageResourceGooGet.type - schemas.PackageResourceMSI.description - schemas.PackageResourceMSI.id - schemas.PackageResourceMSI.properties.allowedSuccessCodes.description - schemas.PackageResourceMSI.properties.allowedSuccessCodes.items.format - schemas.PackageResourceMSI.properties.allowedSuccessCodes.items.type - schemas.PackageResourceMSI.properties.allowedSuccessCodes.type - schemas.PackageResourceMSI.properties.flags.description - schemas.PackageResourceMSI.properties.flags.items.type - schemas.PackageResourceMSI.properties.flags.type - schemas.PackageResourceMSI.properties.source.$ref - schemas.PackageResourceMSI.properties.source.description - schemas.PackageResourceMSI.type - schemas.PackageResourceRPM.description - schemas.PackageResourceRPM.id - schemas.PackageResourceRPM.properties.pullDeps.description - schemas.PackageResourceRPM.properties.pullDeps.type - schemas.PackageResourceRPM.properties.source.$ref - schemas.PackageResourceRPM.properties.source.description - schemas.PackageResourceRPM.type - schemas.PackageResourceYUM.description - schemas.PackageResourceYUM.id - schemas.PackageResourceYUM.properties.name.description - schemas.PackageResourceYUM.properties.name.type - schemas.PackageResourceYUM.type - schemas.PackageResourceZypper.description - schemas.PackageResourceZypper.id - schemas.PackageResourceZypper.properties.name.description - schemas.PackageResourceZypper.properties.name.type - schemas.PackageResourceZypper.type - schemas.RepositoryResource.description - schemas.RepositoryResource.id - schemas.RepositoryResource.properties.apt.$ref - schemas.RepositoryResource.properties.apt.description - schemas.RepositoryResource.properties.goo.$ref - schemas.RepositoryResource.properties.goo.description - schemas.RepositoryResource.properties.yum.$ref - schemas.RepositoryResource.properties.yum.description - schemas.RepositoryResource.properties.zypper.$ref - schemas.RepositoryResource.properties.zypper.description - schemas.RepositoryResource.type - schemas.RepositoryResourceAptRepository.description - schemas.RepositoryResourceAptRepository.id - schemas.RepositoryResourceAptRepository.properties.archiveType.description - schemas.RepositoryResourceAptRepository.properties.archiveType.enum - schemas.RepositoryResourceAptRepository.properties.archiveType.enumDescriptions - schemas.RepositoryResourceAptRepository.properties.archiveType.type - schemas.RepositoryResourceAptRepository.properties.components.description - schemas.RepositoryResourceAptRepository.properties.components.items.type - schemas.RepositoryResourceAptRepository.properties.components.type - schemas.RepositoryResourceAptRepository.properties.distribution.description - schemas.RepositoryResourceAptRepository.properties.distribution.type - schemas.RepositoryResourceAptRepository.properties.gpgKey.description - schemas.RepositoryResourceAptRepository.properties.gpgKey.type - schemas.RepositoryResourceAptRepository.properties.uri.description - schemas.RepositoryResourceAptRepository.properties.uri.type - schemas.RepositoryResourceAptRepository.type - schemas.RepositoryResourceGooRepository.description - schemas.RepositoryResourceGooRepository.id - schemas.RepositoryResourceGooRepository.properties.name.description - schemas.RepositoryResourceGooRepository.properties.name.type - schemas.RepositoryResourceGooRepository.properties.url.description - schemas.RepositoryResourceGooRepository.properties.url.type - schemas.RepositoryResourceGooRepository.type - schemas.RepositoryResourceYumRepository.description - schemas.RepositoryResourceYumRepository.id - schemas.RepositoryResourceYumRepository.properties.baseUrl.description - schemas.RepositoryResourceYumRepository.properties.baseUrl.type - schemas.RepositoryResourceYumRepository.properties.displayName.description - schemas.RepositoryResourceYumRepository.properties.displayName.type - schemas.RepositoryResourceYumRepository.properties.gpgKeys.description - schemas.RepositoryResourceYumRepository.properties.gpgKeys.items.type - schemas.RepositoryResourceYumRepository.properties.gpgKeys.type - schemas.RepositoryResourceYumRepository.properties.id.description - schemas.RepositoryResourceYumRepository.properties.id.type - schemas.RepositoryResourceYumRepository.type - schemas.RepositoryResourceZypperRepository.description - schemas.RepositoryResourceZypperRepository.id - schemas.RepositoryResourceZypperRepository.properties.baseUrl.description - schemas.RepositoryResourceZypperRepository.properties.baseUrl.type - schemas.RepositoryResourceZypperRepository.properties.displayName.description - schemas.RepositoryResourceZypperRepository.properties.displayName.type - schemas.RepositoryResourceZypperRepository.properties.gpgKeys.description - schemas.RepositoryResourceZypperRepository.properties.gpgKeys.items.type - schemas.RepositoryResourceZypperRepository.properties.gpgKeys.type - schemas.RepositoryResourceZypperRepository.properties.id.description - schemas.RepositoryResourceZypperRepository.properties.id.type - schemas.RepositoryResourceZypperRepository.type - schemas.ServiceResource.description - schemas.ServiceResource.id - schemas.ServiceResource.type #### osconfig:v1 The following keys were added: - schemas.ExecResource.description - schemas.ExecResource.id - schemas.ExecResource.properties.enforce.$ref - schemas.ExecResource.properties.enforce.description - schemas.ExecResource.properties.validate.$ref - schemas.ExecResource.properties.validate.description - schemas.ExecResource.type - schemas.ExecResourceExec.description - schemas.ExecResourceExec.id - schemas.ExecResourceExec.properties.allowedSuccessCodes.description - schemas.ExecResourceExec.properties.allowedSuccessCodes.items.format - schemas.ExecResourceExec.properties.allowedSuccessCodes.items.type - schemas.ExecResourceExec.properties.allowedSuccessCodes.type - schemas.ExecResourceExec.properties.args.description - schemas.ExecResourceExec.properties.args.items.type - schemas.ExecResourceExec.properties.args.type - schemas.ExecResourceExec.properties.file.$ref - schemas.ExecResourceExec.properties.file.description - schemas.ExecResourceExec.properties.interpreter.description - schemas.ExecResourceExec.properties.interpreter.enum - schemas.ExecResourceExec.properties.interpreter.enumDescriptions - schemas.ExecResourceExec.properties.interpreter.type - schemas.ExecResourceExec.properties.script.description - schemas.ExecResourceExec.properties.script.type - schemas.ExecResourceExec.type - schemas.ExtractArchiveResource.description - schemas.ExtractArchiveResource.id - schemas.ExtractArchiveResource.properties.creates.description - schemas.ExtractArchiveResource.properties.creates.type - schemas.ExtractArchiveResource.properties.destination.description - schemas.ExtractArchiveResource.properties.destination.type - schemas.ExtractArchiveResource.properties.overwrite.description - schemas.ExtractArchiveResource.properties.overwrite.type - schemas.ExtractArchiveResource.properties.source.$ref - schemas.ExtractArchiveResource.properties.source.description - schemas.ExtractArchiveResource.properties.type.description - schemas.ExtractArchiveResource.properties.type.enum - schemas.ExtractArchiveResource.properties.type.enumDescriptions - schemas.ExtractArchiveResource.properties.type.type - schemas.ExtractArchiveResource.type - schemas.File.description - schemas.File.id - schemas.File.properties.allowInsecure.description - schemas.File.properties.allowInsecure.type - schemas.File.properties.gcs.$ref - schemas.File.properties.gcs.description - schemas.File.properties.localPath.description - schemas.File.properties.localPath.type - schemas.File.properties.remote.$ref - schemas.File.properties.remote.description - schemas.File.type - schemas.FileGcs.description - schemas.FileGcs.id - schemas.FileGcs.properties.bucket.description - schemas.FileGcs.properties.bucket.type - schemas.FileGcs.properties.generation.description - schemas.FileGcs.properties.generation.format - schemas.FileGcs.properties.generation.type - schemas.FileGcs.properties.object.description - schemas.FileGcs.properties.object.type - schemas.FileGcs.type - schemas.FileRemote.description - schemas.FileRemote.id - schemas.FileRemote.properties.sha256Checksum.description - schemas.FileRemote.properties.sha256Checksum.type - schemas.FileRemote.properties.uri.description - schemas.FileRemote.properties.uri.type - schemas.FileRemote.type - schemas.FileResource.description - schemas.FileResource.id - schemas.FileResource.properties.content.description - schemas.FileResource.properties.content.type - schemas.FileResource.properties.file.$ref - schemas.FileResource.properties.file.description - schemas.FileResource.properties.path.description - schemas.FileResource.properties.path.type - schemas.FileResource.properties.permissions.description - schemas.FileResource.properties.permissions.type - schemas.FileResource.properties.state.description - schemas.FileResource.properties.state.enum - schemas.FileResource.properties.state.enumDescriptions - schemas.FileResource.properties.state.type - schemas.FileResource.type - schemas.PackageResource.description - schemas.PackageResource.id - schemas.PackageResource.properties.apt.$ref - schemas.PackageResource.properties.apt.description - schemas.PackageResource.properties.deb.$ref - schemas.PackageResource.properties.deb.description - schemas.PackageResource.properties.desiredState.description - schemas.PackageResource.properties.desiredState.enum - schemas.PackageResource.properties.desiredState.enumDescriptions - schemas.PackageResource.properties.desiredState.type - schemas.PackageResource.properties.googet.$ref - schemas.PackageResource.properties.googet.description - schemas.PackageResource.properties.msi.$ref - schemas.PackageResource.properties.msi.description - schemas.PackageResource.properties.rpm.$ref - schemas.PackageResource.properties.rpm.description - schemas.PackageResource.properties.yum.$ref - schemas.PackageResource.properties.yum.description - schemas.PackageResource.properties.zypper.$ref - schemas.PackageResource.properties.zypper.description - schemas.PackageResource.type - schemas.PackageResourceAPT.description - schemas.PackageResourceAPT.id - schemas.PackageResourceAPT.properties.name.description - schemas.PackageResourceAPT.properties.name.type - schemas.PackageResourceAPT.type - schemas.PackageResourceDeb.description - schemas.PackageResourceDeb.id - schemas.PackageResourceDeb.properties.pullDeps.description - schemas.PackageResourceDeb.properties.pullDeps.type - schemas.PackageResourceDeb.properties.source.$ref - schemas.PackageResourceDeb.properties.source.description - schemas.PackageResourceDeb.type - schemas.PackageResourceGooGet.description - schemas.PackageResourceGooGet.id - schemas.PackageResourceGooGet.properties.name.description - schemas.PackageResourceGooGet.properties.name.type - schemas.PackageResourceGooGet.type - schemas.PackageResourceMSI.description - schemas.PackageResourceMSI.id - schemas.PackageResourceMSI.properties.allowedSuccessCodes.description - schemas.PackageResourceMSI.properties.allowedSuccessCodes.items.format - schemas.PackageResourceMSI.properties.allowedSuccessCodes.items.type - schemas.PackageResourceMSI.properties.allowedSuccessCodes.type - schemas.PackageResourceMSI.properties.flags.description - schemas.PackageResourceMSI.properties.flags.items.type - schemas.PackageResourceMSI.properties.flags.type - schemas.PackageResourceMSI.properties.source.$ref - schemas.PackageResourceMSI.properties.source.description - schemas.PackageResourceMSI.type - schemas.PackageResourceRPM.description - schemas.PackageResourceRPM.id - schemas.PackageResourceRPM.properties.pullDeps.description - schemas.PackageResourceRPM.properties.pullDeps.type - schemas.PackageResourceRPM.properties.source.$ref - schemas.PackageResourceRPM.properties.source.description - schemas.PackageResourceRPM.type - schemas.PackageResourceYUM.description - schemas.PackageResourceYUM.id - schemas.PackageResourceYUM.properties.name.description - schemas.PackageResourceYUM.properties.name.type - schemas.PackageResourceYUM.type - schemas.PackageResourceZypper.description - schemas.PackageResourceZypper.id - schemas.PackageResourceZypper.properties.name.description - schemas.PackageResourceZypper.properties.name.type - schemas.PackageResourceZypper.type - schemas.RepositoryResource.description - schemas.RepositoryResource.id - schemas.RepositoryResource.properties.apt.$ref - schemas.RepositoryResource.properties.apt.description - schemas.RepositoryResource.properties.goo.$ref - schemas.RepositoryResource.properties.goo.description - schemas.RepositoryResource.properties.yum.$ref - schemas.RepositoryResource.properties.yum.description - schemas.RepositoryResource.properties.zypper.$ref - schemas.RepositoryResource.properties.zypper.description - schemas.RepositoryResource.type - schemas.RepositoryResourceAptRepository.description - schemas.RepositoryResourceAptRepository.id - schemas.RepositoryResourceAptRepository.properties.archiveType.description - schemas.RepositoryResourceAptRepository.properties.archiveType.enum - schemas.RepositoryResourceAptRepository.properties.archiveType.enumDescriptions - schemas.RepositoryResourceAptRepository.properties.archiveType.type - schemas.RepositoryResourceAptRepository.properties.components.description - schemas.RepositoryResourceAptRepository.properties.components.items.type - schemas.RepositoryResourceAptRepository.properties.components.type - schemas.RepositoryResourceAptRepository.properties.distribution.description - schemas.RepositoryResourceAptRepository.properties.distribution.type - schemas.RepositoryResourceAptRepository.properties.gpgKey.description - schemas.RepositoryResourceAptRepository.properties.gpgKey.type - schemas.RepositoryResourceAptRepository.properties.uri.description - schemas.RepositoryResourceAptRepository.properties.uri.type - schemas.RepositoryResourceAptRepository.type - schemas.RepositoryResourceGooRepository.description - schemas.RepositoryResourceGooRepository.id - schemas.RepositoryResourceGooRepository.properties.name.description - schemas.RepositoryResourceGooRepository.properties.name.type - schemas.RepositoryResourceGooRepository.properties.url.description - schemas.RepositoryResourceGooRepository.properties.url.type - schemas.RepositoryResourceGooRepository.type - schemas.RepositoryResourceYumRepository.description - schemas.RepositoryResourceYumRepository.id - schemas.RepositoryResourceYumRepository.properties.baseUrl.description - schemas.RepositoryResourceYumRepository.properties.baseUrl.type - schemas.RepositoryResourceYumRepository.properties.displayName.description - schemas.RepositoryResourceYumRepository.properties.displayName.type - schemas.RepositoryResourceYumRepository.properties.gpgKeys.description - schemas.RepositoryResourceYumRepository.properties.gpgKeys.items.type - schemas.RepositoryResourceYumRepository.properties.gpgKeys.type - schemas.RepositoryResourceYumRepository.properties.id.description - schemas.RepositoryResourceYumRepository.properties.id.type - schemas.RepositoryResourceYumRepository.type - schemas.RepositoryResourceZypperRepository.description - schemas.RepositoryResourceZypperRepository.id - schemas.RepositoryResourceZypperRepository.properties.baseUrl.description - schemas.RepositoryResourceZypperRepository.properties.baseUrl.type - schemas.RepositoryResourceZypperRepository.properties.displayName.description - schemas.RepositoryResourceZypperRepository.properties.displayName.type - schemas.RepositoryResourceZypperRepository.properties.gpgKeys.description - schemas.RepositoryResourceZypperRepository.properties.gpgKeys.items.type - schemas.RepositoryResourceZypperRepository.properties.gpgKeys.type - schemas.RepositoryResourceZypperRepository.properties.id.description - schemas.RepositoryResourceZypperRepository.properties.id.type - schemas.RepositoryResourceZypperRepository.type - schemas.ServiceResource.description - schemas.ServiceResource.id - schemas.ServiceResource.type * feat(pubsub): update the API #### pubsub:v1 The following keys were added: - schemas.Subscription.properties.detached.description - schemas.Subscription.properties.detached.type * feat(recommendationengine)!: update the API BREAKING CHANGE: This release has breaking changes. #### recommendationengine:v1beta1 The following keys were deleted: - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.getGroupIdItems.description - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.getGroupIdItems.flatPath - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.getGroupIdItems.httpMethod - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.getGroupIdItems.id - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.getGroupIdItems.parameterOrder - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.getGroupIdItems.parameters.itemGroupId.description - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.getGroupIdItems.parameters.itemGroupId.location - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.getGroupIdItems.parameters.itemGroupId.type - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.getGroupIdItems.parameters.parent.description - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.getGroupIdItems.parameters.parent.location - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.getGroupIdItems.parameters.parent.pattern - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.getGroupIdItems.parameters.parent.required - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.getGroupIdItems.parameters.parent.type - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.getGroupIdItems.path - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.getGroupIdItems.response.$ref - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.getGroupIdItems.scopes - schemas.GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse.description - schemas.GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse.id - schemas.GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse.properties.canonicalCatalogItem.$ref - schemas.GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse.properties.canonicalCatalogItem.description - schemas.GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse.properties.catalogItems.description - schemas.GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse.properties.catalogItems.items.$ref - schemas.GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse.properties.catalogItems.type - schemas.GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse.type The following keys were added: - schemas.GoogleCloudRecommendationengineV1beta1ListCatalogsResponse.properties.catalogs.readOnly The following keys were changed: - resources.projects.resources.locations.resources.catalogs.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.catalogs.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.catalogs.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.get.parameters.name.description - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.import.description - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.import.parameters.parent.description - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.patch.description - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.catalogs.resources.catalogItems.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.operations.methods.get.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.operations.methods.list.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.placements.methods.predict.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.placements.methods.predict.parameters.name.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.predictionApiKeyRegistrations.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.predictionApiKeyRegistrations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.predictionApiKeyRegistrations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.predictionApiKeyRegistrations.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.userEvents.methods.collect.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.userEvents.methods.collect.parameters.ets.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.userEvents.methods.collect.parameters.parent.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.userEvents.methods.collect.parameters.uri.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.userEvents.methods.import.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.userEvents.methods.list.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.userEvents.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.userEvents.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.userEvents.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.userEvents.methods.purge.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.userEvents.methods.purge.parameters.parent.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.userEvents.methods.rejoin.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.userEvents.methods.rejoin.parameters.parent.description - resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.userEvents.methods.write.parameters.parent.description - resources.projects.resources.locations.resources.catalogs.resources.operations.methods.get.description - resources.projects.resources.locations.resources.catalogs.resources.operations.methods.list.description - schemas.GoogleApiHttpBody.description - schemas.GoogleApiHttpBody.properties.extensions.description - schemas.GoogleCloudRecommendationengineV1alphaTuningMetadata.properties.recommendationModel.description - schemas.GoogleCloudRecommendationengineV1beta1BigQuerySource.properties.dataSchema.description - schemas.GoogleCloudRecommendationengineV1beta1BigQuerySource.properties.gcsStagingDir.description - schemas.GoogleCloudRecommendationengineV1beta1BigQuerySource.properties.projectId.description - schemas.GoogleCloudRecommendationengineV1beta1Catalog.description - schemas.GoogleCloudRecommendationengineV1beta1Catalog.properties.defaultEventStoreId.description - schemas.GoogleCloudRecommendationengineV1beta1CatalogInlineSource.properties.catalogItems.description - schemas.GoogleCloudRecommendationengineV1beta1CatalogItem.properties.categoryHierarchies.description - schemas.GoogleCloudRecommendationengineV1beta1CatalogItem.properties.description.description - schemas.GoogleCloudRecommendationengineV1beta1CatalogItem.properties.id.description - schemas.GoogleCloudRecommendationengineV1beta1CatalogItem.properties.itemAttributes.description - schemas.GoogleCloudRecommendationengineV1beta1CatalogItem.properties.itemGroupId.description - schemas.GoogleCloudRecommendationengineV1beta1CatalogItem.properties.languageCode.description - schemas.GoogleCloudRecommendationengineV1beta1CatalogItem.properties.tags.description - schemas.GoogleCloudRecommendationengineV1beta1CatalogItem.properties.title.description - schemas.GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy.properties.categories.description - schemas.GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig.description - schemas.GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig.properties.eventItemLevel.description - schemas.GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig.properties.predictItemLevel.description - schemas.GoogleCloudRecommendationengineV1beta1EventDetail.properties.eventAttributes.description - schemas.GoogleCloudRecommendationengineV1beta1EventDetail.properties.experimentIds.description - schemas.GoogleCloudRecommendationengineV1beta1EventDetail.properties.pageViewId.description - schemas.GoogleCloudRecommendationengineV1beta1EventDetail.properties.recommendationToken.description - schemas.GoogleCloudRecommendationengineV1beta1EventDetail.properties.referrerUri.description - schemas.GoogleCloudRecommendationengineV1beta1EventDetail.properties.uri.description - schemas.GoogleCloudRecommendationengineV1beta1FeatureMap.description - schemas.GoogleCloudRecommendationengineV1beta1FeatureMap.properties.categoricalFeatures.description - schemas.GoogleCloudRecommendationengineV1beta1FeatureMap.properties.numericalFeatures.description - schemas.GoogleCloudRecommendationengineV1beta1GcsSource.description - schemas.GoogleCloudRecommendationengineV1beta1GcsSource.properties.inputUris.description - schemas.GoogleCloudRecommendationengineV1beta1GcsSource.properties.jsonSchema.description - schemas.GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest.properties.requestId.description - schemas.GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest.properties.updateMask.description - schemas.GoogleCloudRecommendationengineV1beta1ImportCatalogItemsResponse.description - schemas.GoogleCloudRecommendationengineV1beta1ImportErrorsConfig.properties.gcsPrefix.description - schemas.GoogleCloudRecommendationengineV1beta1ImportMetadata.description - schemas.GoogleCloudRecommendationengineV1beta1ImportMetadata.properties.requestId.description - schemas.GoogleCloudRecommendationengineV1beta1ImportMetadata.properties.updateTime.description - schemas.GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest.properties.requestId.description - schemas.GoogleCloudRecommendationengineV1beta1ImportUserEventsResponse.description - schemas.GoogleCloudRecommendationengineV1beta1ImportUserEventsResponse.properties.errorsConfig.description - schemas.GoogleCloudRecommendationengineV1beta1ListCatalogItemsResponse.properties.nextPageToken.description - schemas.GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse.properties.nextPageToken.description - schemas.GoogleCloudRecommendationengineV1beta1ListUserEventsResponse.properties.nextPageToken.description - schemas.GoogleCloudRecommendationengineV1beta1PredictRequest.properties.dryRun.description - schemas.GoogleCloudRecommendationengineV1beta1PredictRequest.properties.filter.description - schemas.GoogleCloudRecommendationengineV1beta1PredictRequest.properties.labels.description - schemas.GoogleCloudRecommendationengineV1beta1PredictRequest.properties.pageSize.description - schemas.GoogleCloudRecommendationengineV1beta1PredictRequest.properties.params.description - schemas.GoogleCloudRecommendationengineV1beta1PredictRequest.properties.userEvent.description - schemas.GoogleCloudRecommendationengineV1beta1PredictResponse.properties.nextPageToken.description - schemas.GoogleCloudRecommendationengineV1beta1PredictResponse.properties.recommendationToken.description - schemas.GoogleCloudRecommendationengineV1beta1PredictResponse.properties.results.description - schemas.GoogleCloudRecommendationengineV1beta1PredictResponsePredictionResult.properties.itemMetadata.description - schemas.GoogleCloudRecommendationengineV1beta1ProductCatalogItem.properties.canonicalProductUri.description - schemas.GoogleCloudRecommendationengineV1beta1ProductCatalogItem.properties.costs.description - schemas.GoogleCloudRecommendationengineV1beta1ProductCatalogItem.properties.currencyCode.description - schemas.GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice.properties.originalPrice.description - schemas.GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange.description - schemas.GoogleCloudRecommendationengineV1beta1ProductDetail.properties.availableQuantity.description - schemas.GoogleCloudRecommendationengineV1beta1ProductDetail.properties.currencyCode.description - schemas.GoogleCloudRecommendationengineV1beta1ProductDetail.properties.displayPrice.description - schemas.GoogleCloudRecommendationengineV1beta1ProductDetail.properties.id.description - schemas.GoogleCloudRecommendationengineV1beta1ProductDetail.properties.originalPrice.description - schemas.GoogleCloudRecommendationengineV1beta1ProductDetail.properties.quantity.description - schemas.GoogleCloudRecommendationengineV1beta1ProductDetail.properties.stockState.description - schemas.GoogleCloudRecommendationengineV1beta1ProductEventDetail.description - schemas.GoogleCloudRecommendationengineV1beta1ProductEventDetail.properties.cartId.description - schemas.GoogleCloudRecommendationengineV1beta1ProductEventDetail.properties.listId.description - schemas.GoogleCloudRecommendationengineV1beta1ProductEventDetail.properties.pageCategories.description - schemas.GoogleCloudRecommendationengineV1beta1ProductEventDetail.properties.productDetails.description - schemas.GoogleCloudRecommendationengineV1beta1ProductEventDetail.properties.purchaseTransaction.description - schemas.GoogleCloudRecommendationengineV1beta1ProductEventDetail.properties.searchQuery.description - schemas.GoogleCloudRecommendationengineV1beta1PurchaseTransaction.properties.costs.description - schemas.GoogleCloudRecommendationengineV1beta1PurchaseTransaction.properties.currencyCode.description - schemas.GoogleCloudRecommendationengineV1beta1PurchaseTransaction.properties.revenue.description - schemas.GoogleCloudRecommendationengineV1beta1PurgeUserEventsMetadata.description - schemas.GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest.properties.filter.description - schemas.GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest.properties.force.description - schemas.GoogleCloudRecommendationengineV1beta1PurgeUserEventsResponse.description - schemas.GoogleCloudRecommendationengineV1beta1PurgeUserEventsResponse.properties.userEventsSample.description - schemas.GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest.properties.userEventRejoinScope.description - schemas.GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest.properties.userEventRejoinScope.enumDescriptions - schemas.GoogleCloudRecommendationengineV1beta1UserEvent.description - schemas.GoogleCloudRecommendationengineV1beta1UserEvent.properties.eventDetail.description - schemas.GoogleCloudRecommendationengineV1beta1UserEvent.properties.eventSource.description - schemas.GoogleCloudRecommendationengineV1beta1UserEvent.properties.eventSource.enumDescriptions - schemas.GoogleCloudRecommendationengineV1beta1UserEvent.properties.eventTime.description - schemas.GoogleCloudRecommendationengineV1beta1UserEvent.properties.eventType.description - schemas.GoogleCloudRecommendationengineV1beta1UserEvent.properties.productEventDetail.description - schemas.GoogleCloudRecommendationengineV1beta1UserEventImportSummary.description - schemas.GoogleCloudRecommendationengineV1beta1UserEventImportSummary.properties.unjoinedEventsCount.description - schemas.GoogleCloudRecommendationengineV1beta1UserInfo.properties.directUserRequest.description - schemas.GoogleCloudRecommendationengineV1beta1UserInfo.properties.ipAddress.description - schemas.GoogleCloudRecommendationengineV1beta1UserInfo.properties.userAgent.description - schemas.GoogleCloudRecommendationengineV1beta1UserInfo.properties.userId.description - schemas.GoogleCloudRecommendationengineV1beta1UserInfo.properties.visitorId.description - schemas.GoogleLongrunningOperation.description - schemas.GoogleLongrunningOperation.properties.done.description - schemas.GoogleLongrunningOperation.properties.metadata.description - schemas.GoogleLongrunningOperation.properties.name.description - schemas.GoogleLongrunningOperation.properties.response.description - schemas.GoogleProtobufEmpty.description - schemas.GoogleRpcStatus.description - schemas.GoogleRpcStatus.properties.details.description - schemas.GoogleRpcStatus.properties.message.description * fix(recommender): update the API #### recommender:v1 The following keys were changed: - resources.projects.resources.locations.resources.insightTypes.resources.insights.methods.get.description - resources.projects.resources.locations.resources.insightTypes.resources.insights.methods.list.description - resources.projects.resources.locations.resources.insightTypes.resources.insights.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.insightTypes.resources.insights.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.insightTypes.resources.insights.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.insightTypes.resources.insights.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.insightTypes.resources.insights.methods.markAccepted.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.get.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.list.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.markClaimed.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.markFailed.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.markSucceeded.description - schemas.GoogleCloudRecommenderV1CostProjection.properties.cost.description - schemas.GoogleCloudRecommenderV1Insight.description - schemas.GoogleCloudRecommenderV1Insight.properties.content.description - schemas.GoogleCloudRecommenderV1Insight.properties.description.description - schemas.GoogleCloudRecommenderV1Insight.properties.etag.description - schemas.GoogleCloudRecommenderV1Insight.properties.observationPeriod.description - schemas.GoogleCloudRecommenderV1InsightRecommendationReference.properties.recommendation.description - schemas.GoogleCloudRecommenderV1InsightStateInfo.properties.state.enumDescriptions - schemas.GoogleCloudRecommenderV1ListInsightsResponse.properties.nextPageToken.description - schemas.GoogleCloudRecommenderV1ListRecommendationsResponse.properties.nextPageToken.description - schemas.GoogleCloudRecommenderV1MarkInsightAcceptedRequest.properties.stateMetadata.description - schemas.GoogleCloudRecommenderV1MarkRecommendationClaimedRequest.properties.stateMetadata.description - schemas.GoogleCloudRecommenderV1MarkRecommendationFailedRequest.properties.stateMetadata.description - schemas.GoogleCloudRecommenderV1MarkRecommendationSucceededRequest.properties.stateMetadata.description - schemas.GoogleCloudRecommenderV1Operation.description - schemas.GoogleCloudRecommenderV1Operation.properties.action.description - schemas.GoogleCloudRecommenderV1Operation.properties.path.description - schemas.GoogleCloudRecommenderV1Operation.properties.pathFilters.description - schemas.GoogleCloudRecommenderV1Operation.properties.pathValueMatchers.description - schemas.GoogleCloudRecommenderV1Operation.properties.resource.description - schemas.GoogleCloudRecommenderV1Operation.properties.resourceType.description - schemas.GoogleCloudRecommenderV1Operation.properties.sourcePath.description - schemas.GoogleCloudRecommenderV1Operation.properties.sourceResource.description - schemas.GoogleCloudRecommenderV1Operation.properties.value.description - schemas.GoogleCloudRecommenderV1Operation.properties.valueMatcher.description - schemas.GoogleCloudRecommenderV1OperationGroup.properties.operations.description - schemas.GoogleCloudRecommenderV1Recommendation.description - schemas.GoogleCloudRecommenderV1Recommendation.properties.additionalImpact.description - schemas.GoogleCloudRecommenderV1Recommendation.properties.description.description - schemas.GoogleCloudRecommenderV1Recommendation.properties.etag.description - schemas.GoogleCloudRecommenderV1Recommendation.properties.lastRefreshTime.description - schemas.GoogleCloudRecommenderV1Recommendation.properties.primaryImpact.description - schemas.GoogleCloudRecommenderV1Recommendation.properties.recommenderSubtype.description - schemas.GoogleCloudRecommenderV1RecommendationContent.properties.operationGroups.description - schemas.GoogleCloudRecommenderV1RecommendationInsightReference.properties.insight.description - schemas.GoogleCloudRecommenderV1RecommendationStateInfo.properties.state.enumDescriptions - schemas.GoogleCloudRecommenderV1ValueMatcher.properties.matchesPattern.description - schemas.GoogleTypeMoney.properties.nanos.description - schemas.GoogleTypeMoney.properties.units.description #### recommender:v1beta1 The following keys were changed: - resources.projects.resources.locations.resources.insightTypes.resources.insights.methods.get.description - resources.projects.resources.locations.resources.insightTypes.resources.insights.methods.list.description - resources.projects.resources.locations.resources.insightTypes.resources.insights.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.insightTypes.resources.insights.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.insightTypes.resources.insights.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.insightTypes.resources.insights.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.insightTypes.resources.insights.methods.markAccepted.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.get.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.list.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.markClaimed.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.markFailed.description - resources.projects.resources.locations.resources.recommenders.resources.recommendations.methods.markSucceeded.description - schemas.GoogleCloudRecommenderV1beta1CostProjection.properties.cost.description - schemas.GoogleCloudRecommenderV1beta1Insight.description - schemas.GoogleCloudRecommenderV1beta1Insight.properties.content.description - schemas.GoogleCloudRecommenderV1beta1Insight.properties.description.description - schemas.GoogleCloudRecommenderV1beta1Insight.properties.etag.description - schemas.GoogleCloudRecommenderV1beta1Insight.properties.observationPeriod.description - schemas.GoogleCloudRecommenderV1beta1InsightRecommendationReference.properties.recommendation.description - schemas.GoogleCloudRecommenderV1beta1InsightStateInfo.properties.state.enumDescriptions - schemas.GoogleCloudRecommenderV1beta1ListInsightsResponse.properties.nextPageToken.description - schemas.GoogleCloudRecommenderV1beta1ListRecommendationsResponse.properties.nextPageToken.description - schemas.GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest.properties.stateMetadata.description - schemas.GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest.properties.stateMetadata.description - schemas.GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest.properties.stateMetadata.description - schemas.GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest.properties.stateMetadata.description - schemas.GoogleCloudRecommenderV1beta1Operation.description - schemas.GoogleCloudRecommenderV1beta1Operation.properties.action.description - schemas.GoogleCloudRecommenderV1beta1Operation.properties.path.description - schemas.GoogleCloudRecommenderV1beta1Operation.properties.pathFilters.description - schemas.GoogleCloudRecommenderV1beta1Operation.properties.pathValueMatchers.description - schemas.GoogleCloudRecommenderV1beta1Operation.properties.resource.description - schemas.GoogleCloudRecommenderV1beta1Operation.properties.resourceType.description - schemas.GoogleCloudRecommenderV1beta1Operation.properties.sourcePath.description - schemas.GoogleCloudRecommenderV1beta1Operation.properties.sourceResource.description - schemas.GoogleCloudRecommenderV1beta1Operation.properties.value.description - schemas.GoogleCloudRecommenderV1beta1Operation.properties.valueMatcher.description - schemas.GoogleCloudRecommenderV1beta1OperationGroup.properties.operations.description - schemas.GoogleCloudRecommenderV1beta1Recommendation.description - schemas.GoogleCloudRecommenderV1beta1Recommendation.properties.additionalImpact.description - schemas.GoogleCloudRecommenderV1beta1Recommendation.properties.description.description - schemas.GoogleCloudRecommenderV1beta1Recommendation.properties.etag.description - schemas.GoogleCloudRecommenderV1beta1Recommendation.properties.lastRefreshTime.description - schemas.GoogleCloudRecommenderV1beta1Recommendation.properties.primaryImpact.description - schemas.GoogleCloudRecommenderV1beta1Recommendation.properties.recommenderSubtype.description - schemas.GoogleCloudRecommenderV1beta1RecommendationContent.properties.operationGroups.description - schemas.GoogleCloudRecommenderV1beta1RecommendationInsightReference.properties.insight.description - schemas.GoogleCloudRecommenderV1beta1RecommendationStateInfo.properties.state.enumDescriptions - schemas.GoogleCloudRecommenderV1beta1ValueMatcher.properties.matchesPattern.description - schemas.GoogleTypeMoney.properties.nanos.description - schemas.GoogleTypeMoney.properties.units.description * fix(runtimeconfig): update the API #### runtimeconfig:v1 The following keys were changed: - resources.operations.methods.cancel.description - resources.operations.methods.delete.description - resources.operations.methods.list.description - schemas.Empty.description - schemas.Operation.description - schemas.Operation.properties.done.description - schemas.Operation.properties.metadata.description - schemas.Operation.properties.name.description - schemas.Operation.properties.response.description - schemas.Status.description - schemas.Status.properties.details.description - schemas.Status.properties.message.description #### runtimeconfig:v1beta1 The following keys were changed: - resources.projects.resources.configs.methods.create.description - resources.projects.resources.configs.methods.create.parameters.parent.description - resources.projects.resources.configs.methods.create.parameters.requestId.description - resources.projects.resources.configs.methods.delete.parameters.name.description - resources.projects.resources.configs.methods.get.parameters.name.description - resources.projects.resources.configs.methods.getIamPolicy.description - resources.projects.resources.configs.methods.getIamPolicy.parameters.options.requestedPolicyVersion.description - resources.projects.resources.configs.methods.getIamPolicy.parameters.resource.description - resources.projects.resources.configs.methods.list.parameters.pageSize.description - resources.projects.resources.configs.methods.list.parameters.pageToken.description - resources.projects.resources.configs.methods.list.parameters.parent.description - resources.projects.resources.configs.methods.setIamPolicy.description - resources.projects.resources.configs.methods.setIamPolicy.parameters.resource.description - resources.projects.resources.configs.methods.testIamPermissions.description - resources.projects.resources.configs.methods.testIamPermissions.parameters.resource.description - resources.projects.resources.configs.methods.update.parameters.name.description - resources.projects.resources.configs.resources.operations.methods.get.description - resources.projects.resources.configs.resources.operations.methods.testIamPermissions.description - resources.projects.resources.configs.resources.operations.methods.testIamPermissions.parameters.resource.description - resources.projects.resources.configs.resources.variables.methods.create.description - resources.projects.resources.configs.resources.variables.methods.create.parameters.parent.description - resources.projects.resources.configs.resources.variables.methods.create.parameters.requestId.description - resources.projects.resources.configs.resources.variables.methods.delete.description - resources.projects.resources.configs.resources.variables.methods.delete.parameters.name.description - resources.projects.resources.configs.resources.variables.methods.delete.parameters.recursive.description - resources.projects.resources.configs.resources.variables.methods.get.parameters.name.description - resources.projects.resources.configs.resources.variables.methods.list.description - resources.projects.resources.configs.resources.variables.methods.list.parameters.filter.description - resources.projects.resources.configs.resources.variables.methods.list.parameters.pageSize.description - resources.projects.resources.configs.resources.variables.methods.list.parameters.pageToken.description - resources.projects.resources.configs.resources.variables.methods.list.parameters.parent.description - resources.projects.resources.configs.resources.variables.methods.list.parameters.returnValues.description - resources.projects.resources.configs.resources.variables.methods.testIamPermissions.description - resources.projects.resources.configs.resources.variables.methods.testIamPermissions.parameters.resource.description - resources.projects.resources.configs.resources.variables.methods.update.parameters.name.description - resources.projects.resources.configs.resources.variables.methods.watch.description - resources.projects.resources.configs.resources.variables.methods.watch.parameters.name.description - resources.projects.resources.configs.resources.waiters.methods.create.description - resources.projects.resources.configs.resources.waiters.methods.create.parameters.parent.description - resources.projects.resources.configs.resources.waiters.methods.create.parameters.requestId.description - resources.projects.resources.configs.resources.waiters.methods.delete.parameters.name.description - resources.projects.resources.configs.resources.waiters.methods.get.parameters.name.description - resources.projects.resources.configs.resources.waiters.methods.list.parameters.pageSize.description - resources.projects.resources.configs.resources.waiters.methods.list.parameters.pageToken.description - resources.projects.resources.configs.resources.waiters.methods.list.parameters.parent.description - resources.projects.resources.configs.resources.waiters.methods.testIamPermissions.description - resources.projects.resources.configs.resources.waiters.methods.testIamPermissions.parameters.resource.description - schemas.Binding.properties.condition.description - schemas.Binding.properties.members.description - schemas.Binding.properties.role.description - schemas.Cardinality.description - schemas.Cardinality.properties.number.description - schemas.Empty.description - schemas.Expr.description - schemas.Expr.properties.description.description - schemas.Expr.properties.expression.description - schemas.Expr.properties.location.description - schemas.Expr.properties.title.description - schemas.ListConfigsResponse.description - schemas.ListConfigsResponse.properties.configs.description - schemas.ListConfigsResponse.properties.nextPageToken.description - schemas.ListVariablesResponse.properties.nextPageToken.description - schemas.ListVariablesResponse.properties.variables.description - schemas.ListWaitersResponse.description - schemas.ListWaitersResponse.properties.nextPageToken.description - schemas.Operation.description - schemas.Operation.properties.done.description - schemas.Operation.properties.metadata.description - schemas.Operation.properties.name.description - schemas.Operation.properties.response.description - schemas.Policy.description - schemas.Policy.properties.bindings.description - schemas.Policy.properties.etag.description - schemas.Policy.properties.version.description - schemas.RuntimeConfig.description - schemas.RuntimeConfig.properties.name.description - schemas.SetIamPolicyRequest.properties.policy.description - schemas.Status.description - schemas.Status.properties.details.description - schemas.Status.properties.message.description - schemas.TestIamPermissionsRequest.properties.permissions.description - schemas.TestIamPermissionsResponse.properties.permissions.description - schemas.Variable.description - schemas.Variable.properties.name.description - schemas.Variable.properties.state.description - schemas.Variable.properties.text.description - schemas.Variable.properties.updateTime.description - schemas.Variable.properties.value.description - schemas.Waiter.description - schemas.Waiter.properties.createTime.description - schemas.Waiter.properties.done.description - schemas.Waiter.properties.error.description - schemas.Waiter.properties.failure.description - schemas.Waiter.properties.name.description - schemas.Waiter.properties.success.description - schemas.Waiter.properties.timeout.description - schemas.WatchVariableRequest.properties.newerThan.description * fix(serviceconsumermanagement): update the API #### serviceconsumermanagement:v1 The following keys were changed: - schemas.MetricDescriptor.description - schemas.MetricDescriptor.properties.labels.description - schemas.MetricDescriptor.properties.type.description - schemas.MonitoredResourceDescriptor.description - schemas.MonitoredResourceDescriptor.properties.labels.description - schemas.MonitoredResourceDescriptor.properties.type.description #### serviceconsumermanagement:v1beta1 The following keys were changed: - schemas.MetricDescriptor.description - schemas.MetricDescriptor.properties.labels.description - schemas.MetricDescriptor.properties.type.description - schemas.MonitoredResourceDescriptor.description - schemas.MonitoredResourceDescriptor.properties.labels.description - schemas.MonitoredResourceDescriptor.properties.type.description * fix(servicenetworking): update the API #### servicenetworking:v1beta The following keys were changed: - schemas.MetricDescriptor.description - schemas.MetricDescriptor.properties.labels.description - schemas.MetricDescriptor.properties.type.description - schemas.MonitoredResourceDescriptor.description - schemas.MonitoredResourceDescriptor.properties.labels.description - schemas.MonitoredResourceDescriptor.properties.type.description #### servicenetworking:v1 The following keys were changed: - schemas.MetricDescriptor.description - schemas.MetricDescriptor.properties.labels.description - schemas.MetricDescriptor.properties.type.description - schemas.MonitoredResourceDescriptor.description - schemas.MonitoredResourceDescriptor.properties.labels.description - schemas.MonitoredResourceDescriptor.properties.type.description * fix(serviceusage): update the API #### serviceusage:v1 The following keys were changed: - schemas.MetricDescriptor.description - schemas.MetricDescriptor.properties.labels.description - schemas.MetricDescriptor.properties.type.description - schemas.MonitoredResourceDescriptor.description - schemas.MonitoredResourceDescriptor.properties.labels.description - schemas.MonitoredResourceDescriptor.properties.type.description #### serviceusage:v1beta1 The following keys were changed: - schemas.MetricDescriptor.description - schemas.MetricDescriptor.properties.labels.description - schemas.MetricDescriptor.properties.type.description - schemas.MonitoredResourceDescriptor.description - schemas.MonitoredResourceDescriptor.properties.labels.description - schemas.MonitoredResourceDescriptor.properties.type.description * fix(sourcerepo): update the API #### sourcerepo:v1 The following keys were changed: - schemas.AuditConfig.description - schemas.AuditLogConfig.description * fix(storagetransfer): update the API #### storagetransfer:v1 The following keys were changed: - schemas.ErrorSummary.properties.errorCode.enumDescriptions - schemas.ObjectConditions.description - schemas.TransferOptions.description * feat(testing): update the API #### testing:v1 The following keys were added: - resources.testEnvironmentCatalog.methods.get.parameters.environmentType.enumDescriptions The following keys were changed: - resources.projects.resources.testMatrices.methods.cancel.description - resources.projects.resources.testMatrices.methods.create.description - resources.projects.resources.testMatrices.methods.create.parameters.requestId.description - resources.projects.resources.testMatrices.methods.get.description - resources.testEnvironmentCatalog.methods.get.description - schemas.AndroidDevice.properties.androidModelId.description - schemas.AndroidDevice.properties.androidVersionId.description - schemas.AndroidDevice.properties.locale.description - schemas.AndroidDevice.properties.orientation.description - schemas.AndroidInstrumentationTest.description - schemas.AndroidInstrumentationTest.properties.appPackageId.description - schemas.AndroidInstrumentationTest.properties.orchestratorOption.description - schemas.AndroidInstrumentationTest.properties.orchestratorOption.enumDescriptions - schemas.AndroidInstrumentationTest.properties.testPackageId.description - schemas.AndroidInstrumentationTest.properties.testRunnerClass.description - schemas.AndroidInstrumentationTest.properties.testTargets.description - schemas.AndroidMatrix.description - schemas.AndroidMatrix.properties.androidModelIds.description - schemas.AndroidMatrix.properties.androidVersionIds.description - schemas.AndroidMatrix.properties.locales.description - schemas.AndroidMatrix.properties.orientations.description - schemas.AndroidModel.properties.brand.description - schemas.AndroidModel.properties.codename.description - schemas.AndroidModel.properties.form.enumDescriptions - schemas.AndroidModel.properties.id.description - schemas.AndroidModel.properties.lowFpsVideoRecording.description - schemas.AndroidModel.properties.name.description - schemas.AndroidModel.properties.screenDensity.description - schemas.AndroidModel.properties.supportedAbis.description - schemas.AndroidModel.properties.tags.description - schemas.AndroidModel.properties.thumbnailUrl.description - schemas.AndroidRoboTest.description - schemas.AndroidRoboTest.properties.appPackageId.description - schemas.AndroidRoboTest.properties.maxDepth.description - schemas.AndroidRoboTest.properties.maxSteps.description - schemas.AndroidRoboTest.properties.roboDirectives.description - schemas.AndroidRoboTest.properties.roboScript.description - schemas.AndroidRoboTest.properties.startingIntents.description - schemas.AndroidTestLoop.description - schemas.AndroidTestLoop.properties.appPackageId.description - schemas.AndroidTestLoop.properties.scenarioLabels.description - schemas.AndroidTestLoop.properties.scenarios.description - schemas.AndroidVersion.properties.apiLevel.description - schemas.AndroidVersion.properties.codeName.description - schemas.AndroidVersion.properties.id.description - schemas.AndroidVersion.properties.tags.description - schemas.AndroidVersion.properties.versionString.description - schemas.Apk.properties.packageName.description - schemas.ApkDetail.description - schemas.ApkManifest.description - schemas.ApkManifest.properties.packageName.description - schemas.AppBundle.description - schemas.CancelTestMatrixResponse.properties.testState.description - schemas.CancelTestMatrixResponse.properties.testState.enumDescriptions - schemas.ClientInfoDetail.description - schemas.Date.description - schemas.Date.properties.day.description - schemas.Date.properties.month.description - schemas.Date.properties.year.description - schemas.DeviceIpBlock.properties.form.enumDescriptions - schemas.Distribution.description - schemas.Distribution.properties.marketShare.description - schemas.EnvironmentMatrix.properties.androidDeviceList.description - schemas.FileReference.properties.gcsPath.description - schemas.GoogleAuto.description - schemas.GoogleCloudStorage.properties.gcsPath.description - schemas.IntentFilter.description - schemas.IntentFilter.properties.actionNames.description - schemas.IntentFilter.properties.categoryNames.description - schemas.IntentFilter.properties.mimeType.description - schemas.IosDevice.properties.iosModelId.description - schemas.IosDevice.properties.iosVersionId.description - schemas.IosDevice.properties.locale.description - schemas.IosDevice.properties.orientation.description - schemas.IosModel.description - schemas.IosModel.properties.deviceCapabilities.description - schemas.IosModel.properties.id.description - schemas.IosModel.properties.name.description - schemas.IosModel.properties.tags.description - schemas.IosTestLoop.description - schemas.IosTestLoop.properties.scenarios.description - schemas.IosTestSetup.properties.networkProfile.description - schemas.IosVersion.properties.id.description - schemas.IosVersion.properties.majorVersion.description - schemas.IosVersion.properties.minorVersion.description - schemas.IosVersion.properties.tags.description - schemas.IosXcTest.description - schemas.IosXcTest.properties.testSpecialEntitlements.description - schemas.IosXcTest.properties.testsZip.description - schemas.IosXcTest.properties.xcodeVersion.description - schemas.IosXcTest.properties.xctestrun.description - schemas.Locale.properties.id.description - schemas.Locale.properties.name.description - schemas.Locale.properties.region.description - schemas.Locale.properties.tags.description - schemas.ManualSharding.description - schemas.ManualSharding.properties.testTargetsForShard.description - schemas.ObbFile.properties.obbFileName.description - schemas.Orientation.properties.id.description - schemas.Orientation.properties.name.description - schemas.Orientation.properties.tags.description - schemas.ProvidedSoftwareCatalog.properties.orchestratorVersion.description - schemas.RegularFile.properties.devicePath.description - schemas.ResultStorage.properties.toolResultsHistory.description - schemas.RoboDirective.description - schemas.RoboDirective.properties.actionType.description - schemas.RoboDirective.properties.actionType.enumDescriptions - schemas.RoboDirective.properties.inputText.description - schemas.RoboDirective.properties.resourceName.description - schemas.ShardingOption.properties.manualSharding.description - schemas.StartActivityIntent.properties.action.description - schemas.SystraceSetup.properties.durationSeconds.description - schemas.TestDetails.properties.errorMessage.description - schemas.TestDetails.properties.progressMessages.description - schemas.TestExecution.properties.state.description - schemas.TestExecution.properties.state.enumDescriptions - schemas.TestMatrix.description - schemas.TestMatrix.properties.flakyTestAttempts.description - schemas.TestMatrix.properties.invalidMatrixDetails.description - schemas.TestMatrix.properties.invalidMatrixDetails.enumDescriptions - schemas.TestMatrix.properties.outcomeSummary.description - schemas.TestMatrix.properties.outcomeSummary.enumDescriptions - schemas.TestMatrix.properties.state.enumDescriptions - schemas.TestMatrix.properties.testExecutions.description - schemas.TestSetup.properties.additionalApks.description - schemas.TestSetup.properties.directoriesToPull.description - schemas.TestSetup.properties.environmentVariables.description - schemas.TestSetup.properties.networkProfile.description - schemas.TestSetup.properties.systrace.description - schemas.TestSpecification.properties.testSetup.description - schemas.TestSpecification.properties.testTimeout.description - schemas.TestTargetsForShard.properties.testTargets.description - schemas.ToolResultsExecution.description - schemas.ToolResultsStep.description - schemas.UniformSharding.description - schemas.UniformSharding.properties.numShards.description - schemas.XcodeVersion.properties.tags.description - schemas.XcodeVersion.properties.version.description * feat(texttospeech): update the API #### texttospeech:v1beta1 The following keys were added: - schemas.SynthesizeSpeechRequest.properties.enableTimePointing.description - schemas.SynthesizeSpeechRequest.properties.enableTimePointing.enumDescriptions - schemas.SynthesizeSpeechRequest.properties.enableTimePointing.items.enum - schemas.SynthesizeSpeechRequest.properties.enableTimePointing.items.type - schemas.SynthesizeSpeechRequest.properties.enableTimePointing.type - schemas.SynthesizeSpeechResponse.properties.audioConfig.$ref - schemas.SynthesizeSpeechResponse.properties.audioConfig.description - schemas.SynthesizeSpeechResponse.properties.timepoints.description - schemas.SynthesizeSpeechResponse.properties.timepoints.items.$ref - schemas.SynthesizeSpeechResponse.properties.timepoints.type - schemas.Timepoint.description - schemas.Timepoint.id - schemas.Timepoint.properties.markName.description - schemas.Timepoint.properties.markName.type - schemas.Timepoint.properties.timeSeconds.description - schemas.Timepoint.properties.timeSeconds.format - schemas.Timepoint.properties.timeSeconds.type - schemas.Timepoint.type The following keys were changed: - schemas.AudioConfig.properties.audioEncoding.enum - schemas.AudioConfig.properties.audioEncoding.enumDescriptions * fix(translate): update the API #### translate:v3 The following keys were changed: - resources.projects.resources.locations.resources.glossaries.methods.list.parameters.filter.description #### translate:v3beta1 The following keys were changed: - resources.projects.resources.locations.resources.glossaries.methods.list.parameters.filter.description * feat: regenerate index files --- disclaimers.json | 12 +- discovery/bigquerydatatransfer-v1.json | 301 +++-- discovery/civicinfo-v2.json | 98 +- discovery/cloudasset-v1.json | 10 +- discovery/cloudasset-v1beta1.json | 4 +- discovery/cloudasset-v1p4beta1.json | 4 +- discovery/cloudasset-v1p5beta1.json | 4 +- discovery/cloudbuild-v1.json | 266 ++-- discovery/cloudbuild-v1alpha1.json | 247 ++-- discovery/cloudbuild-v1alpha2.json | 243 ++-- discovery/cloudshell-v1.json | 192 +-- discovery/cloudshell-v1alpha1.json | 96 +- discovery/dataproc-v1beta2.json | 17 +- discovery/displayvideo-v1.json | 8 +- discovery/doubleclickbidmanager-v1.1.json | 1140 ++++++++++++++--- discovery/genomics-v1.json | 98 +- discovery/genomics-v1alpha2.json | 244 ++-- discovery/genomics-v2alpha1.json | 219 ++-- discovery/gmail-v1.json | 419 +++--- discovery/osconfig-v1.json | 490 ++++++- discovery/osconfig-v1beta.json | 490 ++++++- discovery/pubsub-v1.json | 6 +- discovery/recommendationengine-v1beta1.json | 343 +++-- discovery/recommender-v1.json | 124 +- discovery/recommender-v1beta1.json | 124 +- discovery/runtimeconfig-v1.json | 26 +- discovery/runtimeconfig-v1beta1.json | 196 +-- discovery/serviceconsumermanagement-v1.json | 14 +- .../serviceconsumermanagement-v1beta1.json | 14 +- discovery/servicenetworking-v1.json | 14 +- discovery/servicenetworking-v1beta.json | 14 +- discovery/serviceusage-v1.json | 14 +- discovery/serviceusage-v1beta1.json | 14 +- discovery/sourcerepo-v1.json | 6 +- discovery/storagetransfer-v1.json | 8 +- discovery/testing-v1.json | 380 +++--- discovery/texttospeech-v1beta1.json | 50 +- discovery/translate-v3.json | 4 +- discovery/translate-v3beta1.json | 4 +- src/apis/bigquerydatatransfer/v1.ts | 322 +---- src/apis/cloudasset/v1.ts | 4 +- src/apis/cloudasset/v1beta1.ts | 2 +- src/apis/cloudasset/v1p5beta1.ts | 2 +- src/apis/cloudbuild/v1.ts | 112 +- src/apis/cloudbuild/v1alpha1.ts | 83 +- src/apis/cloudbuild/v1alpha2.ts | 103 +- src/apis/cloudfunctions/README.md | 9 + src/apis/cloudshell/v1.ts | 104 +- src/apis/cloudshell/v1alpha1.ts | 30 +- src/apis/dataproc/v1beta2.ts | 13 + src/apis/doubleclickbidmanager/v1.1.ts | 92 ++ src/apis/genomics/v1.ts | 51 +- src/apis/genomics/v1alpha2.ts | 98 +- src/apis/genomics/v2alpha1.ts | 103 +- src/apis/gmail/v1.ts | 521 +++----- src/apis/osconfig/v1.ts | 360 ++++++ src/apis/osconfig/v1beta.ts | 360 ++++++ src/apis/pubsub/v1.ts | 8 + src/apis/recommendationengine/v1beta1.ts | 428 ++----- src/apis/recommender/v1.ts | 78 +- src/apis/recommender/v1beta1.ts | 78 +- src/apis/runtimeconfig/v1.ts | 14 +- src/apis/runtimeconfig/v1beta1.ts | 285 ++--- src/apis/serviceconsumermanagement/v1.ts | 12 +- src/apis/serviceconsumermanagement/v1beta1.ts | 12 +- src/apis/servicenetworking/v1.ts | 12 +- src/apis/servicenetworking/v1beta.ts | 12 +- src/apis/serviceusage/v1.ts | 12 +- src/apis/serviceusage/v1beta1.ts | 12 +- src/apis/sourcerepo/v1.ts | 4 +- src/apis/storagetransfer/v1.ts | 4 +- src/apis/testing/v1.ts | 69 +- src/apis/texttospeech/v1beta1.ts | 30 +- src/apis/translate/v3.ts | 19 +- src/apis/translate/v3beta1.ts | 19 +- 75 files changed, 5612 insertions(+), 3822 deletions(-) diff --git a/disclaimers.json b/disclaimers.json index 1e97019b50..1c18d3fbb0 100644 --- a/disclaimers.json +++ b/disclaimers.json @@ -67,6 +67,10 @@ "api": "firestore", "package": "@google-cloud/connect-firestore" }, + { + "api": "cloudfunctions", + "package": "@google-cloud/functions" + }, { "api": "gameservices", "package": "@google-cloud/game-servers" @@ -147,6 +151,10 @@ "api": "phishingprotection", "package": "@google-cloud/phishing-protection" }, + { + "api": "cloudprofiler", + "package": "@google-cloud/profiler" + }, { "api": "pubsub", "package": "@google-cloud/pubsub" @@ -223,10 +231,6 @@ "api": "monitoring", "package": "@google-cloud/monitoring" }, - { - "api": "cloudprofiler", - "package": "@google-cloud/profiler" - }, { "api": "cloudtrace", "package": "@google-cloud/trace-agent" diff --git a/discovery/bigquerydatatransfer-v1.json b/discovery/bigquerydatatransfer-v1.json index 8753247fae..06cb8bef03 100644 --- a/discovery/bigquerydatatransfer-v1.json +++ b/discovery/bigquerydatatransfer-v1.json @@ -119,7 +119,7 @@ "dataSources": { "methods": { "checkValidCreds": { - "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.", + "description": "Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.", "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds", "httpMethod": "POST", "id": "bigquerydatatransfer.projects.dataSources.checkValidCreds", @@ -128,7 +128,7 @@ ], "parameters": { "name": { - "description": "Required. The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}` or\n`projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.", + "description": "Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.", "location": "path", "pattern": "^projects/[^/]+/dataSources/[^/]+$", "required": true, @@ -150,7 +150,7 @@ ] }, "get": { - "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.", + "description": "Retrieves a supported data source and returns its settings, which can be used for UI rendering.", "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}", "httpMethod": "GET", "id": "bigquerydatatransfer.projects.dataSources.get", @@ -159,7 +159,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}` or\n`projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`", + "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`", "location": "path", "pattern": "^projects/[^/]+/dataSources/[^/]+$", "required": true, @@ -178,7 +178,7 @@ ] }, "list": { - "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.", + "description": "Lists supported data sources and returns their settings, which can be used for UI rendering.", "flatPath": "v1/projects/{projectsId}/dataSources", "httpMethod": "GET", "id": "bigquerydatatransfer.projects.dataSources.list", @@ -193,12 +193,12 @@ "type": "integer" }, "pageToken": { - "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", + "description": "Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}` or\n`projects/{project_id}/locations/{location_id}", + "description": "Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -297,7 +297,7 @@ "dataSources": { "methods": { "checkValidCreds": { - "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.", + "description": "Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds", "httpMethod": "POST", "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds", @@ -306,7 +306,7 @@ ], "parameters": { "name": { - "description": "Required. The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}` or\n`projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.", + "description": "Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$", "required": true, @@ -328,7 +328,7 @@ ] }, "get": { - "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.", + "description": "Retrieves a supported data source and returns its settings, which can be used for UI rendering.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}", "httpMethod": "GET", "id": "bigquerydatatransfer.projects.locations.dataSources.get", @@ -337,7 +337,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}` or\n`projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`", + "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$", "required": true, @@ -356,7 +356,7 @@ ] }, "list": { - "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.", + "description": "Lists supported data sources and returns their settings, which can be used for UI rendering.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources", "httpMethod": "GET", "id": "bigquerydatatransfer.projects.locations.dataSources.list", @@ -371,12 +371,12 @@ "type": "integer" }, "pageToken": { - "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", + "description": "Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}` or\n`projects/{project_id}/locations/{location_id}", + "description": "Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -408,24 +408,24 @@ ], "parameters": { "authorizationCode": { - "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.", + "description": "Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The BigQuery project id where the transfer configuration should be created.\nMust be in the format projects/{project_id}/locations/{location_id} or\nprojects/{project_id}. If specified location and location of the\ndestination bigquery dataset do not match - the request will fail.", + "description": "Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "serviceAccountName": { - "description": "Optional service account name. If this field is set, transfer config will\nbe created with this service account credentials. It requires that\nrequesting user calling this API has permissions to act as this service\naccount.", + "description": "Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.", "location": "query", "type": "string" }, "versionInfo": { - "description": "Optional version info. If users want to find a very recent access token,\nthat is, immediately after approving access, users have to set the\nversion_info claim in the token request. To obtain the version_info, users\nmust use the \"none+gsession\" response type. which be return a\nversion_info back in the authorization response which be be put in a JWT\nclaim in the token request.", + "description": "Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the \"none+gsession\" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.", "location": "query", "type": "string" } @@ -442,7 +442,7 @@ ] }, "delete": { - "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.", + "description": "Deletes a data transfer configuration, including any associated transfer runs and logs.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}", "httpMethod": "DELETE", "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete", @@ -451,7 +451,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", + "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -477,7 +477,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", + "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -517,12 +517,12 @@ "type": "integer" }, "pageToken": { - "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", + "description": "Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}` or\n`projects/{project_id}/locations/{location_id}`", + "description": "Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -541,7 +541,7 @@ ] }, "patch": { - "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.", + "description": "Updates a data transfer configuration. All fields must be set, even if they are not updated.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}", "httpMethod": "PATCH", "id": "bigquerydatatransfer.projects.locations.transferConfigs.patch", @@ -550,19 +550,19 @@ ], "parameters": { "authorizationCode": { - "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\nauthorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.", + "description": "Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.", "location": "query", "type": "string" }, "name": { - "description": "The resource name of the transfer config.\nTransfer config names have the form of\n`projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.\nThe name is automatically generated based on the config_id specified in\nCreateTransferConfigRequest along with project_id and region. If config_id\nis not provided, usually a uuid, even though it is not guaranteed or\nrequired, will be generated for config_id.", + "description": "The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "required": true, "type": "string" }, "serviceAccountName": { - "description": "Optional service account name. If this field is set and\n\"service_account_name\" is set in update_mask, transfer config will be\nupdated to use this service account credentials. It requires that\nrequesting user calling this API has permissions to act as this service\naccount.", + "description": "Optional service account name. If this field is set and \"service_account_name\" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.", "location": "query", "type": "string" }, @@ -573,7 +573,7 @@ "type": "string" }, "versionInfo": { - "description": "Optional version info. If users want to find a very recent access token,\nthat is, immediately after approving access, users have to set the\nversion_info claim in the token request. To obtain the version_info, users\nmust use the \"none+gsession\" response type. which be return a\nversion_info back in the authorization response which be be put in a JWT\nclaim in the token request.", + "description": "Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the \"none+gsession\" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.", "location": "query", "type": "string" } @@ -590,7 +590,7 @@ ] }, "scheduleRuns": { - "description": "Creates transfer runs for a time range [start_time, end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.\nDEPRECATED: use StartManualTransferRuns instead.", + "description": "Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns", "httpMethod": "POST", "id": "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns", @@ -599,7 +599,7 @@ ], "parameters": { "parent": { - "description": "Required. Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", + "description": "Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -619,7 +619,7 @@ ] }, "startManualRuns": { - "description": "Start manual transfer runs to be executed now with schedule_time equal to\ncurrent time. The transfer runs can be created for a time range where the\nrun_time is between start_time (inclusive) and end_time (exclusive), or for\na specific run_time.", + "description": "Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:startManualRuns", "httpMethod": "POST", "id": "bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns", @@ -628,7 +628,7 @@ ], "parameters": { "parent": { - "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", + "description": "Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -661,7 +661,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", + "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "required": true, @@ -687,7 +687,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", + "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "required": true, @@ -721,12 +721,12 @@ "type": "integer" }, "pageToken": { - "description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", + "description": "Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", + "description": "Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -738,6 +738,10 @@ "RUN_ATTEMPT_UNSPECIFIED", "LATEST" ], + "enumDescriptions": [ + "All runs should be returned.", + "Only latest run per day should be returned." + ], "location": "query", "type": "string" }, @@ -751,6 +755,14 @@ "FAILED", "CANCELLED" ], + "enumDescriptions": [ + "State placeholder.", + "Data transfer is scheduled and is waiting to be picked up by data transfer backend.", + "Data transfer is in progress.", + "Data transfer completed successfully.", + "Data transfer failed.", + "Data transfer is cancelled." + ], "location": "query", "repeated": true, "type": "string" @@ -781,13 +793,19 @@ ], "parameters": { "messageTypes": { - "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.", + "description": "Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.", "enum": [ "MESSAGE_SEVERITY_UNSPECIFIED", "INFO", "WARNING", "ERROR" ], + "enumDescriptions": [ + "No severity specified.", + "Informational message.", + "Warning message.", + "Error message." + ], "location": "query", "repeated": true, "type": "string" @@ -799,12 +817,12 @@ "type": "integer" }, "pageToken": { - "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", + "description": "Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", + "description": "Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "required": true, @@ -842,24 +860,24 @@ ], "parameters": { "authorizationCode": { - "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.", + "description": "Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The BigQuery project id where the transfer configuration should be created.\nMust be in the format projects/{project_id}/locations/{location_id} or\nprojects/{project_id}. If specified location and location of the\ndestination bigquery dataset do not match - the request will fail.", + "description": "Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, "type": "string" }, "serviceAccountName": { - "description": "Optional service account name. If this field is set, transfer config will\nbe created with this service account credentials. It requires that\nrequesting user calling this API has permissions to act as this service\naccount.", + "description": "Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.", "location": "query", "type": "string" }, "versionInfo": { - "description": "Optional version info. If users want to find a very recent access token,\nthat is, immediately after approving access, users have to set the\nversion_info claim in the token request. To obtain the version_info, users\nmust use the \"none+gsession\" response type. which be return a\nversion_info back in the authorization response which be be put in a JWT\nclaim in the token request.", + "description": "Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the \"none+gsession\" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.", "location": "query", "type": "string" } @@ -876,7 +894,7 @@ ] }, "delete": { - "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.", + "description": "Deletes a data transfer configuration, including any associated transfer runs and logs.", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}", "httpMethod": "DELETE", "id": "bigquerydatatransfer.projects.transferConfigs.delete", @@ -885,7 +903,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", + "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -911,7 +929,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", + "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -951,12 +969,12 @@ "type": "integer" }, "pageToken": { - "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", + "description": "Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}` or\n`projects/{project_id}/locations/{location_id}`", + "description": "Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -975,7 +993,7 @@ ] }, "patch": { - "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.", + "description": "Updates a data transfer configuration. All fields must be set, even if they are not updated.", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}", "httpMethod": "PATCH", "id": "bigquerydatatransfer.projects.transferConfigs.patch", @@ -984,19 +1002,19 @@ ], "parameters": { "authorizationCode": { - "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\nauthorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.", + "description": "Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.", "location": "query", "type": "string" }, "name": { - "description": "The resource name of the transfer config.\nTransfer config names have the form of\n`projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.\nThe name is automatically generated based on the config_id specified in\nCreateTransferConfigRequest along with project_id and region. If config_id\nis not provided, usually a uuid, even though it is not guaranteed or\nrequired, will be generated for config_id.", + "description": "The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "required": true, "type": "string" }, "serviceAccountName": { - "description": "Optional service account name. If this field is set and\n\"service_account_name\" is set in update_mask, transfer config will be\nupdated to use this service account credentials. It requires that\nrequesting user calling this API has permissions to act as this service\naccount.", + "description": "Optional service account name. If this field is set and \"service_account_name\" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.", "location": "query", "type": "string" }, @@ -1007,7 +1025,7 @@ "type": "string" }, "versionInfo": { - "description": "Optional version info. If users want to find a very recent access token,\nthat is, immediately after approving access, users have to set the\nversion_info claim in the token request. To obtain the version_info, users\nmust use the \"none+gsession\" response type. which be return a\nversion_info back in the authorization response which be be put in a JWT\nclaim in the token request.", + "description": "Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the \"none+gsession\" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.", "location": "query", "type": "string" } @@ -1024,7 +1042,7 @@ ] }, "scheduleRuns": { - "description": "Creates transfer runs for a time range [start_time, end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.\nDEPRECATED: use StartManualTransferRuns instead.", + "description": "Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns", "httpMethod": "POST", "id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns", @@ -1033,7 +1051,7 @@ ], "parameters": { "parent": { - "description": "Required. Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", + "description": "Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -1053,7 +1071,7 @@ ] }, "startManualRuns": { - "description": "Start manual transfer runs to be executed now with schedule_time equal to\ncurrent time. The transfer runs can be created for a time range where the\nrun_time is between start_time (inclusive) and end_time (exclusive), or for\na specific run_time.", + "description": "Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:startManualRuns", "httpMethod": "POST", "id": "bigquerydatatransfer.projects.transferConfigs.startManualRuns", @@ -1062,7 +1080,7 @@ ], "parameters": { "parent": { - "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", + "description": "Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -1095,7 +1113,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", + "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "required": true, @@ -1121,7 +1139,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", + "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "required": true, @@ -1155,12 +1173,12 @@ "type": "integer" }, "pageToken": { - "description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", + "description": "Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", + "description": "Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -1172,6 +1190,10 @@ "RUN_ATTEMPT_UNSPECIFIED", "LATEST" ], + "enumDescriptions": [ + "All runs should be returned.", + "Only latest run per day should be returned." + ], "location": "query", "type": "string" }, @@ -1185,6 +1207,14 @@ "FAILED", "CANCELLED" ], + "enumDescriptions": [ + "State placeholder.", + "Data transfer is scheduled and is waiting to be picked up by data transfer backend.", + "Data transfer is in progress.", + "Data transfer completed successfully.", + "Data transfer failed.", + "Data transfer is cancelled." + ], "location": "query", "repeated": true, "type": "string" @@ -1215,13 +1245,19 @@ ], "parameters": { "messageTypes": { - "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.", + "description": "Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.", "enum": [ "MESSAGE_SEVERITY_UNSPECIFIED", "INFO", "WARNING", "ERROR" ], + "enumDescriptions": [ + "No severity specified.", + "Informational message.", + "Warning message.", + "Error message." + ], "location": "query", "repeated": true, "type": "string" @@ -1233,12 +1269,12 @@ "type": "integer" }, "pageToken": { - "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", + "description": "Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", + "description": "Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "required": true, @@ -1265,11 +1301,11 @@ } } }, - "revision": "20200726", + "revision": "20200801", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { - "description": "A request to determine whether the user has valid credentials. This method\nis used to limit the number of OAuth popups in the user interface. The\nuser id is inferred from the API call context.\nIf the data source has the Google+ authorization type, this method\nreturns false, as it cannot be determined whether the credentials are\nalready valid merely based on the user id.", + "description": "A request to determine whether the user has valid credentials. This method is used to limit the number of OAuth popups in the user interface. The user id is inferred from the API call context. If the data source has the Google+ authorization type, this method returns false, as it cannot be determined whether the credentials are already valid merely based on the user id.", "id": "CheckValidCredsRequest", "properties": {}, "type": "object" @@ -1286,7 +1322,7 @@ "type": "object" }, "DataSource": { - "description": "Represents data source metadata. Metadata is sufficient to\nrender UI and request proper OAuth tokens.", + "description": "Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.", "id": "DataSource", "properties": { "authorizationType": { @@ -1299,9 +1335,9 @@ ], "enumDescriptions": [ "Type unspecified.", - "Use OAuth 2 authorization codes that can be exchanged\nfor a refresh token on the backend.", - "Return an authorization code for a given Google+ page that can then be\nexchanged for a refresh token on the backend.", - "Use First Party OAuth based on Loas Owned Clients. First Party OAuth\ndoesn't require a refresh token to get an offline access token. Instead,\nit uses a client-signed JWT assertion to retrieve an access token." + "Use OAuth 2 authorization codes that can be exchanged for a refresh token on the backend.", + "Return an authorization code for a given Google+ page that can then be exchanged for a refresh token on the backend.", + "Use First Party OAuth based on Loas Owned Clients. First Party OAuth doesn't require a refresh token to get an offline access token. Instead, it uses a client-signed JWT assertion to retrieve an access token." ], "type": "string" }, @@ -1310,7 +1346,7 @@ "type": "string" }, "dataRefreshType": { - "description": "Specifies whether the data source supports automatic data refresh for the\npast few days, and how it's supported.\nFor some data sources, data might not be complete until a few days later,\nso it's useful to refresh data automatically.", + "description": "Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically.", "enum": [ "DATA_REFRESH_TYPE_UNSPECIFIED", "SLIDING_WINDOW", @@ -1318,8 +1354,8 @@ ], "enumDescriptions": [ "The data source won't support data auto refresh, which is default value.", - "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Does not allow custom values to be set for each\ntransfer config.", - "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Allows custom values to be set for each transfer\nconfig." + "The data source supports data auto refresh, and runs will be scheduled for the past few days. Does not allow custom values to be set for each transfer config.", + "The data source supports data auto refresh, and runs will be scheduled for the past few days. Allows custom values to be set for each transfer config." ], "type": "string" }, @@ -1328,12 +1364,12 @@ "type": "string" }, "defaultDataRefreshWindowDays": { - "description": "Default data refresh window on days.\nOnly meaningful when `data_refresh_type` = `SLIDING_WINDOW`.", + "description": "Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.", "format": "int32", "type": "integer" }, "defaultSchedule": { - "description": "Default data transfer schedule.\nExamples of valid schedules include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.", + "description": "Default data transfer schedule. Examples of valid schedules include: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`.", "type": "string" }, "description": { @@ -1349,7 +1385,7 @@ "type": "string" }, "manualRunsDisabled": { - "description": "Disables backfilling and manual run scheduling\nfor the data source.", + "description": "Disables backfilling and manual run scheduling for the data source.", "type": "boolean" }, "minimumScheduleInterval": { @@ -1359,6 +1395,7 @@ }, "name": { "description": "Output only. Data source resource name.", + "readOnly": true, "type": "string" }, "parameters": { @@ -1369,14 +1406,14 @@ "type": "array" }, "scopes": { - "description": "Api auth scopes for which refresh token needs to be obtained. These are\nscopes needed by a data source to prepare data and ingest them into\nBigQuery, e.g., https://www.googleapis.com/auth/bigquery", + "description": "Api auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery", "items": { "type": "string" }, "type": "array" }, "supportsCustomSchedule": { - "description": "Specifies whether the data source supports a user defined schedule, or\noperates on the default schedule.\nWhen set to `true`, user can override default schedule.", + "description": "Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule.", "type": "boolean" }, "supportsMultipleTransfers": { @@ -1393,12 +1430,12 @@ "enumDescriptions": [ "Invalid or Unknown transfer type placeholder.", "Batch data transfer.", - "Streaming data transfer. Streaming data source currently doesn't\nsupport multiple transfer configs per project." + "Streaming data transfer. Streaming data source currently doesn't support multiple transfer configs per project." ], "type": "string" }, "updateDeadlineSeconds": { - "description": "The number of seconds to wait for an update from the data source\nbefore the Data Transfer Service marks the transfer as FAILED.", + "description": "The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.", "format": "int32", "type": "integer" } @@ -1406,7 +1443,7 @@ "type": "object" }, "DataSourceParameter": { - "description": "Represents a data source parameter with validation rules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for rendering\nand validation.\nThus, whoever uses this api can decide to generate either generic ui,\nor custom data source specific forms.", + "description": "Represents a data source parameter with validation rules, so that parameters can be rendered in the UI. These parameters are given to us by supported data sources, and include all needed information for rendering and validation. Thus, whoever uses this api can decide to generate either generic ui, or custom data source specific forms.", "id": "DataSourceParameter", "properties": { "allowedValues": { @@ -1417,7 +1454,7 @@ "type": "array" }, "deprecated": { - "description": "If true, it should not be used in new transfers, and it should not be\nvisible to users.", + "description": "If true, it should not be used in new transfers, and it should not be visible to users.", "type": "boolean" }, "description": { @@ -1479,7 +1516,7 @@ "enumDescriptions": [ "Type unspecified.", "String parameter.", - "Integer parameter (64-bits).\nWill be serialized to json as string.", + "Integer parameter (64-bits). Will be serialized to json as string.", "Double precision floating point parameter.", "Boolean parameter.", "Deprecated. This field has no effect.", @@ -1488,7 +1525,7 @@ "type": "string" }, "validationDescription": { - "description": "Description of the requirements for this field, in case the user input does\nnot fulfill the regex pattern or min/max values.", + "description": "Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.", "type": "string" }, "validationHelpUrl": { @@ -1503,7 +1540,7 @@ "type": "object" }, "EmailPreferences": { - "description": "Represents preferences for sending email notifications for transfer run\nevents.", + "description": "Represents preferences for sending email notifications for transfer run events.", "id": "EmailPreferences", "properties": { "enableFailureEmail": { @@ -1514,7 +1551,7 @@ "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" @@ -1531,7 +1568,8 @@ "type": "array" }, "nextPageToken": { - "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListDataSourcesRequest.page_token`\nto request the next page of list results.", + "description": "Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListDataSourcesRequest.page_token` to request the next page of list results.", + "readOnly": true, "type": "string" } }, @@ -1560,7 +1598,8 @@ "id": "ListTransferConfigsResponse", "properties": { "nextPageToken": { - "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferConfigsRequest.page_token`\nto request the next page of list results.", + "description": "Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferConfigsRequest.page_token` to request the next page of list results.", + "readOnly": true, "type": "string" }, "transferConfigs": { @@ -1568,6 +1607,7 @@ "items": { "$ref": "TransferConfig" }, + "readOnly": true, "type": "array" } }, @@ -1578,7 +1618,8 @@ "id": "ListTransferLogsResponse", "properties": { "nextPageToken": { - "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`GetTransferRunLogRequest.page_token`\nto request the next page of list results.", + "description": "Output only. The next-pagination token. For multiple-page list results, this token can be used as the `GetTransferRunLogRequest.page_token` to request the next page of list results.", + "readOnly": true, "type": "string" }, "transferMessages": { @@ -1586,6 +1627,7 @@ "items": { "$ref": "TransferMessage" }, + "readOnly": true, "type": "array" } }, @@ -1596,7 +1638,8 @@ "id": "ListTransferRunsResponse", "properties": { "nextPageToken": { - "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferRunsRequest.page_token`\nto request the next page of list results.", + "description": "Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferRunsRequest.page_token` to request the next page of list results.", + "readOnly": true, "type": "string" }, "transferRuns": { @@ -1604,6 +1647,7 @@ "items": { "$ref": "TransferRun" }, + "readOnly": true, "type": "array" } }, @@ -1614,14 +1658,14 @@ "id": "Location", "properties": { "displayName": { - "description": "The friendly name for this location, typically a nearby city name.\nFor example, \"Tokyo\".", + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object" }, "locationId": { @@ -1633,11 +1677,11 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "Service-specific metadata. For example the available capacity at the given\nlocation.", + "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object" }, "name": { - "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`", + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" } }, @@ -1648,16 +1692,16 @@ "id": "ScheduleOptions", "properties": { "disableAutoScheduling": { - "description": "If true, automatic scheduling of data transfer runs for this configuration\nwill be disabled. The runs can be started on ad-hoc basis using\nStartManualTransferRuns API. When automatic scheduling is disabled, the\nTransferConfig.schedule field will be ignored.", + "description": "If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.", "type": "boolean" }, "endTime": { - "description": "Defines time to stop scheduling transfer runs. A transfer run cannot be\nscheduled at or after the end time. The end time can be changed at any\nmoment. The time when a data transfer can be trigerred manually is not\nlimited by this option.", + "description": "Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.", "format": "google-datetime", "type": "string" }, "startTime": { - "description": "Specifies time to start scheduling transfer runs. The first run will be\nscheduled at or after the start time according to a recurrence pattern\ndefined in the schedule string. The start time can be changed at any\nmoment. The time when a data transfer can be trigerred manually is not\nlimited by this option.", + "description": "Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.", "format": "google-datetime", "type": "string" } @@ -1669,12 +1713,12 @@ "id": "ScheduleTransferRunsRequest", "properties": { "endTime": { - "description": "Required. End time of the range of transfer runs. For example,\n`\"2017-05-30T00:00:00+00:00\"`.", + "description": "Required. End time of the range of transfer runs. For example, `\"2017-05-30T00:00:00+00:00\"`.", "format": "google-datetime", "type": "string" }, "startTime": { - "description": "Required. Start time of the range of transfer runs. For example,\n`\"2017-05-25T00:00:00+00:00\"`.", + "description": "Required. Start time of the range of transfer runs. For example, `\"2017-05-25T00:00:00+00:00\"`.", "format": "google-datetime", "type": "string" } @@ -1700,7 +1744,7 @@ "id": "StartManualTransferRunsRequest", "properties": { "requestedRunTime": { - "description": "Specific run_time for a transfer run to be started. The\nrequested_run_time must not be in the future.", + "description": "Specific run_time for a transfer run to be started. The requested_run_time must not be in the future.", "format": "google-datetime", "type": "string" }, @@ -1726,7 +1770,7 @@ "type": "object" }, "Status": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { @@ -1735,7 +1779,7 @@ "type": "integer" }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -1746,23 +1790,23 @@ "type": "array" }, "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "type": "object" }, "TimeRange": { - "description": "A specification for a time range, this will request transfer runs with\nrun_time between start_time (inclusive) and end_time (exclusive).", + "description": "A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).", "id": "TimeRange", "properties": { "endTime": { - "description": "End time of the range of transfer runs. For example,\n`\"2017-05-30T00:00:00+00:00\"`. The end_time must not be in the future.\nCreates transfer runs where run_time is in the range between start_time\n(inclusive) and end_time (exclusive).", + "description": "End time of the range of transfer runs. For example, `\"2017-05-30T00:00:00+00:00\"`. The end_time must not be in the future. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).", "format": "google-datetime", "type": "string" }, "startTime": { - "description": "Start time of the range of transfer runs. For example,\n`\"2017-05-25T00:00:00+00:00\"`. The start_time must be strictly less than\nthe end_time. Creates transfer runs where run_time is in the range\nbetween start_time (inclusive) and end_time (exclusive).", + "description": "Start time of the range of transfer runs. For example, `\"2017-05-25T00:00:00+00:00\"`. The start_time must be strictly less than the end_time. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).", "format": "google-datetime", "type": "string" } @@ -1770,11 +1814,11 @@ "type": "object" }, "TransferConfig": { - "description": "Represents a data transfer configuration. A transfer configuration\ncontains all metadata needed to perform a data transfer. For example,\n`destination_dataset_id` specifies where data should be stored.\nWhen a new transfer configuration is created, the specified\n`destination_dataset_id` is created when needed and shared with the\nappropriate data source service account.", + "description": "Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.", "id": "TransferConfig", "properties": { "dataRefreshWindowDays": { - "description": "The number of days to look back to automatically refresh the data.\nFor example, if `data_refresh_window_days = 10`, then every day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. Set the value to 0\nto use the default value.", + "description": "The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.", "format": "int32", "type": "integer" }, @@ -1784,6 +1828,7 @@ }, "datasetRegion": { "description": "Output only. Region in which BigQuery dataset is located.", + "readOnly": true, "type": "string" }, "destinationDatasetId": { @@ -1791,7 +1836,7 @@ "type": "string" }, "disabled": { - "description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer.", + "description": "Is this config disabled. When set to true, no runs are scheduled for a given transfer.", "type": "boolean" }, "displayName": { @@ -1800,19 +1845,20 @@ }, "emailPreferences": { "$ref": "EmailPreferences", - "description": "Email notifications will be sent according to these preferences\nto the email address of the user who owns this transfer config." + "description": "Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config." }, "name": { - "description": "The resource name of the transfer config.\nTransfer config names have the form of\n`projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.\nThe name is automatically generated based on the config_id specified in\nCreateTransferConfigRequest along with project_id and region. If config_id\nis not provided, usually a uuid, even though it is not guaranteed or\nrequired, will be generated for config_id.", + "description": "The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.", "type": "string" }, "nextRunTime": { "description": "Output only. Next time when data transfer will run.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "notificationPubsubTopic": { - "description": "Pub/Sub topic where notifications will be sent after transfer runs\nassociated with this transfer config finish.", + "description": "Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.", "type": "string" }, "params": { @@ -1824,7 +1870,7 @@ "type": "object" }, "schedule": { - "description": "Data transfer schedule.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified times are in UTC.\nExamples of valid format:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.\nSee more explanation about the format here:\nhttps://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\nNOTE: the granularity should be at least 8 hours, or less frequent.", + "description": "Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.", "type": "string" }, "scheduleOptions": { @@ -1843,17 +1889,19 @@ ], "enumDescriptions": [ "State placeholder.", - "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.", + "Data transfer is scheduled and is waiting to be picked up by data transfer backend.", "Data transfer is in progress.", "Data transfer completed successfully.", "Data transfer failed.", "Data transfer is cancelled." ], + "readOnly": true, "type": "string" }, "updateTime": { "description": "Output only. Data transfer modification time. Ignored by server on input.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "userId": { @@ -1902,19 +1950,23 @@ "properties": { "dataSourceId": { "description": "Output only. Data source id.", + "readOnly": true, "type": "string" }, "destinationDatasetId": { "description": "Output only. The BigQuery target dataset id.", + "readOnly": true, "type": "string" }, "emailPreferences": { "$ref": "EmailPreferences", - "description": "Output only. Email notifications will be sent according to these\npreferences to the email address of the user who owns the transfer config\nthis run was derived from." + "description": "Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.", + "readOnly": true }, "endTime": { - "description": "Output only. Time when transfer run ended.\nParameter ignored by server for input requests.", + "description": "Output only. Time when transfer run ended. Parameter ignored by server for input requests.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "errorStatus": { @@ -1922,11 +1974,12 @@ "description": "Status of the transfer run." }, "name": { - "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.", + "description": "The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.", "type": "string" }, "notificationPubsubTopic": { - "description": "Output only. Pub/Sub topic where a notification will be sent after this\ntransfer run finishes", + "description": "Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes", + "readOnly": true, "type": "string" }, "params": { @@ -1935,15 +1988,17 @@ "type": "any" }, "description": "Output only. Data transfer specific parameters.", + "readOnly": true, "type": "object" }, "runTime": { - "description": "For batch transfer runs, specifies the date and time of the data should be\ningested.", + "description": "For batch transfer runs, specifies the date and time of the data should be ingested.", "format": "google-datetime", "type": "string" }, "schedule": { - "description": "Output only. Describes the schedule of this transfer run if it was\ncreated as part of a regular schedule. For batch transfer runs that are\nscheduled manually, this is empty.\nNOTE: the system might choose to delay the schedule depending on the\ncurrent load, so `schedule_time` doesn't always match this.", + "description": "Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn't always match this.", + "readOnly": true, "type": "string" }, "scheduleTime": { @@ -1952,8 +2007,9 @@ "type": "string" }, "startTime": { - "description": "Output only. Time when transfer run was started.\nParameter ignored by server for input requests.", + "description": "Output only. Time when transfer run was started. Parameter ignored by server for input requests.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "state": { @@ -1968,7 +2024,7 @@ ], "enumDescriptions": [ "State placeholder.", - "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.", + "Data transfer is scheduled and is waiting to be picked up by data transfer backend.", "Data transfer is in progress.", "Data transfer completed successfully.", "Data transfer failed.", @@ -1979,6 +2035,7 @@ "updateTime": { "description": "Output only. Last time the data transfer run state was updated.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "userId": { diff --git a/discovery/civicinfo-v2.json b/discovery/civicinfo-v2.json index 696884549a..5002c65a97 100644 --- a/discovery/civicinfo-v2.json +++ b/discovery/civicinfo-v2.json @@ -206,6 +206,17 @@ "subLocality2", "special" ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], "location": "query", "repeated": true, "type": "string" @@ -225,6 +236,19 @@ "schoolBoard", "specialPurposeOfficer" ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], "location": "query", "repeated": true, "type": "string" @@ -257,6 +281,17 @@ "subLocality2", "special" ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], "location": "query", "repeated": true, "type": "string" @@ -287,6 +322,19 @@ "schoolBoard", "specialPurposeOfficer" ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], "location": "query", "repeated": true, "type": "string" @@ -300,7 +348,7 @@ } } }, - "revision": "20200706", + "revision": "20200804", "rootUrl": "https://civicinfo.googleapis.com/", "schemas": { "AdministrationRegion": { @@ -513,6 +561,17 @@ "subLocality2", "special" ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], "type": "string" }, "type": "array" @@ -614,6 +673,19 @@ "schoolBoard", "specialPurposeOfficer" ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], "type": "string" }, "type": "array" @@ -856,6 +928,17 @@ "subLocality2", "special" ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], "type": "string" }, "type": "array" @@ -901,6 +984,19 @@ "schoolBoard", "specialPurposeOfficer" ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], "type": "string" }, "type": "array" diff --git a/discovery/cloudasset-v1.json b/discovery/cloudasset-v1.json index 1b02ff2c64..5a0ddb36ff 100644 --- a/discovery/cloudasset-v1.json +++ b/discovery/cloudasset-v1.json @@ -450,7 +450,7 @@ } } }, - "revision": "20200724", + "revision": "20200731", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "Asset": { @@ -670,7 +670,7 @@ "Resource metadata.", "The actual IAM policy set on a resource.", "The Cloud Organization Policy set on an asset.", - "The Cloud Access context mananger Policy set on an asset." + "The Cloud Access context manager Policy set on an asset." ], "type": "string" }, @@ -729,7 +729,7 @@ }, "condition": { "$ref": "Expr", - "description": "A condition which determines whether an asset update should be published.\nIf specified, an asset will be returned only when the expression evaluates\nto true.\nWhen set, `expression` field in the `Expr` must be a valid [CEL expression]\n(https://github.com/google/cel-spec) on a TemporalAsset with name\n`temporal_asset`. Example: a Feed with expression (\"temporal_asset.deleted\n== true\") will only publish Asset deletions. Other fields of `Expr` are\noptional." + "description": "A condition which determines whether an asset update should be published.\nIf specified, an asset will be returned only when the expression evaluates\nto true.\nWhen set, `expression` field in the `Expr` must be a valid [CEL expression]\n(https://github.com/google/cel-spec) on a TemporalAsset with name\n`temporal_asset`. Example: a Feed with expression (\"temporal_asset.deleted\n== true\") will only publish Asset deletions. Other fields of `Expr` are\noptional.\n\nSee our [user\nguide](https://cloud.google.com/asset-inventory/docs/monitoring-asset-changes#feed_with_condition)\nfor detailed instructions." }, "contentType": { "description": "Asset content type. If not specified, no content but the asset name and\ntype will be returned.", @@ -745,7 +745,7 @@ "Resource metadata.", "The actual IAM policy set on a resource.", "The Cloud Organization Policy set on an asset.", - "The Cloud Access context mananger Policy set on an asset." + "The Cloud Access context manager Policy set on an asset." ], "type": "string" }, @@ -1195,7 +1195,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices", "properties": { "allowedServices": { - "description": "The list of APIs usable within the Service Perimeter. Must be empty\nunless 'enable_restriction' is True.", + "description": "The list of APIs usable within the Service Perimeter. Must be empty\nunless 'enable_restriction' is True. You can specify a list of individual\nservices, as well as include the 'RESTRICTED-SERVICES' value, which\nautomatically includes all of the services protected by the perimeter.", "items": { "type": "string" }, diff --git a/discovery/cloudasset-v1beta1.json b/discovery/cloudasset-v1beta1.json index a896490acb..efcea427ce 100644 --- a/discovery/cloudasset-v1beta1.json +++ b/discovery/cloudasset-v1beta1.json @@ -401,7 +401,7 @@ } } }, - "revision": "20200613", + "revision": "20200731", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "Asset": { @@ -1014,7 +1014,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices", "properties": { "allowedServices": { - "description": "The list of APIs usable within the Service Perimeter. Must be empty\nunless 'enable_restriction' is True.", + "description": "The list of APIs usable within the Service Perimeter. Must be empty\nunless 'enable_restriction' is True. You can specify a list of individual\nservices, as well as include the 'RESTRICTED-SERVICES' value, which\nautomatically includes all of the services protected by the perimeter.", "items": { "type": "string" }, diff --git a/discovery/cloudasset-v1p4beta1.json b/discovery/cloudasset-v1p4beta1.json index 9d413d5994..33f715353b 100644 --- a/discovery/cloudasset-v1p4beta1.json +++ b/discovery/cloudasset-v1p4beta1.json @@ -221,7 +221,7 @@ } } }, - "revision": "20200724", + "revision": "20200731", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { @@ -431,7 +431,7 @@ "Unknown error. For example, this error may be returned when\na `Status` value received from another address space belongs to\nan error space that is not known in this address space. Also\nerrors raised by APIs that do not return enough error information\nmay be converted to this error.\n\nHTTP Mapping: 500 Internal Server Error", "The client specified an invalid argument. Note that this differs\nfrom `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments\nthat are problematic regardless of the state of the system\n(e.g., a malformed file name).\n\nHTTP Mapping: 400 Bad Request", "The deadline expired before the operation could complete. For operations\nthat change the state of the system, this error may be returned\neven if the operation has completed successfully. For example, a\nsuccessful response from a server could have been delayed long\nenough for the deadline to expire.\n\nHTTP Mapping: 504 Gateway Timeout", - "Some requested entity (e.g., file or directory) was not found.\n\nNote to server developers: if a request is denied for an entire class\nof users, such as gradual feature rollout or undocumented whitelist,\n`NOT_FOUND` may be used. If a request is denied for some users within\na class of users, such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP Mapping: 404 Not Found", + "Some requested entity (e.g., file or directory) was not found.\n\nNote to server developers: if a request is denied for an entire class\nof users, such as gradual feature rollout or undocumented allowlist,\n`NOT_FOUND` may be used. If a request is denied for some users within\na class of users, such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP Mapping: 404 Not Found", "The entity that a client attempted to create (e.g., file or directory)\nalready exists.\n\nHTTP Mapping: 409 Conflict", "The caller does not have permission to execute the specified\noperation. `PERMISSION_DENIED` must not be used for rejections\ncaused by exhausting some resource (use `RESOURCE_EXHAUSTED`\ninstead for those errors). `PERMISSION_DENIED` must not be\nused if the caller can not be identified (use `UNAUTHENTICATED`\ninstead for those errors). This error code does not imply the\nrequest is valid or the requested entity exists or satisfies\nother pre-conditions.\n\nHTTP Mapping: 403 Forbidden", "The request does not have valid authentication credentials for the\noperation.\n\nHTTP Mapping: 401 Unauthorized", diff --git a/discovery/cloudasset-v1p5beta1.json b/discovery/cloudasset-v1p5beta1.json index 989c2bc508..3d504de3db 100644 --- a/discovery/cloudasset-v1p5beta1.json +++ b/discovery/cloudasset-v1p5beta1.json @@ -170,7 +170,7 @@ } } }, - "revision": "20200717", + "revision": "20200731", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "Asset": { @@ -724,7 +724,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices", "properties": { "allowedServices": { - "description": "The list of APIs usable within the Service Perimeter. Must be empty\nunless 'enable_restriction' is True.", + "description": "The list of APIs usable within the Service Perimeter. Must be empty\nunless 'enable_restriction' is True. You can specify a list of individual\nservices, as well as include the 'RESTRICTED-SERVICES' value, which\nautomatically includes all of the services protected by the perimeter.", "items": { "type": "string" }, diff --git a/discovery/cloudbuild-v1.json b/discovery/cloudbuild-v1.json index ba86831bf6..c008ea16da 100644 --- a/discovery/cloudbuild-v1.json +++ b/discovery/cloudbuild-v1.json @@ -108,7 +108,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "flatPath": "v1/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "cloudbuild.operations.cancel", @@ -136,7 +136,7 @@ ] }, "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1/operations/{operationsId}", "httpMethod": "GET", "id": "cloudbuild.operations.get", @@ -201,7 +201,7 @@ ] }, "create": { - "description": "Starts a build with the specified configuration.\n\nThis method returns a long-running `Operation`, which includes the build\nID. Pass the build ID to `GetBuild` to determine the build status (such as\n`SUCCESS` or `FAILURE`).", + "description": "Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`).", "flatPath": "v1/projects/{projectId}/builds", "httpMethod": "POST", "id": "cloudbuild.projects.builds.create", @@ -228,7 +228,7 @@ ] }, "get": { - "description": "Returns information about a previously requested build.\n\nThe `Build` that is returned includes its status (such as `SUCCESS`,\n`FAILURE`, or `WORKING`), and timing information.", + "description": "Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information.", "flatPath": "v1/projects/{projectId}/builds/{id}", "httpMethod": "GET", "id": "cloudbuild.projects.builds.get", @@ -259,7 +259,7 @@ ] }, "list": { - "description": "Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully.", + "description": "Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.", "flatPath": "v1/projects/{projectId}/builds", "httpMethod": "GET", "id": "cloudbuild.projects.builds.list", @@ -299,7 +299,7 @@ ] }, "retry": { - "description": "Creates a new build based on the specified build.\n\nThis method creates a new build using the original build request, which may\nor may not result in an identical build.\n\nFor triggered builds:\n\n* Triggered builds resolve to a precise revision; therefore a retry of a\ntriggered build will result in a build that uses the same revision.\n\nFor non-triggered builds that specify `RepoSource`:\n\n* If the original build built from the tip of a branch, the retried build\nwill build from the tip of that branch, which may not be the same revision\nas the original build.\n* If the original build specified a commit sha or revision ID, the retried\nbuild will use the identical source.\n\nFor builds that specify `StorageSource`:\n\n* If the original build pulled source from Google Cloud Storage without\nspecifying the generation of the object, the new build will use the current\nobject, which may be different from the original build source.\n* If the original build pulled source from Cloud Storage and specified the\ngeneration of the object, the new build will attempt to use the same\nobject, which may or may not be available depending on the bucket's\nlifecycle 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 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.", "flatPath": "v1/projects/{projectId}/builds/{id}:retry", "httpMethod": "POST", "id": "cloudbuild.projects.builds.retry", @@ -339,7 +339,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "cloudbuild.projects.locations.operations.cancel", @@ -367,7 +367,7 @@ ] }, "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "id": "cloudbuild.projects.locations.operations.get", @@ -398,7 +398,7 @@ "triggers": { "methods": { "create": { - "description": "Creates a new `BuildTrigger`.\n\nThis API is experimental.", + "description": "Creates a new `BuildTrigger`. This API is experimental.", "flatPath": "v1/projects/{projectId}/triggers", "httpMethod": "POST", "id": "cloudbuild.projects.triggers.create", @@ -425,7 +425,7 @@ ] }, "delete": { - "description": "Deletes a `BuildTrigger` by its project ID and trigger ID.\n\nThis API is experimental.", + "description": "Deletes a `BuildTrigger` by its project ID and trigger ID. This API is experimental.", "flatPath": "v1/projects/{projectId}/triggers/{triggerId}", "httpMethod": "DELETE", "id": "cloudbuild.projects.triggers.delete", @@ -456,7 +456,7 @@ ] }, "get": { - "description": "Returns information about a `BuildTrigger`.\n\nThis API is experimental.", + "description": "Returns information about a `BuildTrigger`. This API is experimental.", "flatPath": "v1/projects/{projectId}/triggers/{triggerId}", "httpMethod": "GET", "id": "cloudbuild.projects.triggers.get", @@ -487,7 +487,7 @@ ] }, "list": { - "description": "Lists existing `BuildTrigger`s.\n\nThis API is experimental.", + "description": "Lists existing `BuildTrigger`s. This API is experimental.", "flatPath": "v1/projects/{projectId}/triggers", "httpMethod": "GET", "id": "cloudbuild.projects.triggers.list", @@ -522,7 +522,7 @@ ] }, "patch": { - "description": "Updates a `BuildTrigger` by its project ID and trigger ID.\n\nThis API is experimental.", + "description": "Updates a `BuildTrigger` by its project ID and trigger ID. This API is experimental.", "flatPath": "v1/projects/{projectId}/triggers/{triggerId}", "httpMethod": "PATCH", "id": "cloudbuild.projects.triggers.patch", @@ -594,15 +594,15 @@ } } }, - "revision": "20200726", + "revision": "20200801", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ArtifactObjects": { - "description": "Files in the workspace to upload to Cloud Storage upon successful\ncompletion of all build steps.", + "description": "Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.", "id": "ArtifactObjects", "properties": { "location": { - "description": "Cloud Storage bucket and optional object path, in the form\n\"gs://bucket/path/to/somewhere/\". (see [Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\n\nFiles in the workspace matching any path pattern will be uploaded to\nCloud Storage with this location as a prefix.", + "description": "Cloud Storage bucket and optional object path, in the form \"gs://bucket/path/to/somewhere/\". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.", "type": "string" }, "paths": { @@ -620,7 +620,7 @@ "type": "object" }, "ArtifactResult": { - "description": "An artifact that was uploaded during a build. This\nis a single record in the artifact manifest JSON file.", + "description": "An artifact that was uploaded during a build. This is a single record in the artifact manifest JSON file.", "id": "ArtifactResult", "properties": { "fileHash": { @@ -631,18 +631,18 @@ "type": "array" }, "location": { - "description": "The path of an artifact in a Google Cloud Storage bucket, with the\ngeneration number. For example,\n`gs://mybucket/path/to/output.jar#generation`.", + "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`.", "type": "string" } }, "type": "object" }, "Artifacts": { - "description": "Artifacts produced by a build that should be uploaded upon\nsuccessful completion of all build steps.", + "description": "Artifacts produced by a build that should be uploaded upon successful completion of all build steps.", "id": "Artifacts", "properties": { "images": { - "description": "A list of images to be pushed upon the successful completion of all build\nsteps.\n\nThe images will be pushed using the builder service account's credentials.\n\nThe digests of the pushed images will be stored in the Build resource's\nresults field.\n\nIf any of the images fail to be pushed, the build is marked FAILURE.", + "description": "A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.", "items": { "type": "string" }, @@ -650,39 +650,43 @@ }, "objects": { "$ref": "ArtifactObjects", - "description": "A list of objects to be uploaded to Cloud Storage upon successful\ncompletion of all build steps.\n\nFiles in the workspace matching specified paths globs will be uploaded to\nthe specified Cloud Storage location using the builder service account's\ncredentials.\n\nThe location and generation of the uploaded objects will be stored in the\nBuild resource's results field.\n\nIf any objects fail to be pushed, the build is marked FAILURE." + "description": "A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE." } }, "type": "object" }, "Build": { - "description": "A build resource in the Cloud Build API.\n\nAt a high level, a `Build` describes where to find source code, how to build\nit (for example, the builder image to run on the source), and where to store\nthe built artifacts.\n\nFields can include the following variables, which will be expanded when the\nbuild is created:\n\n- $PROJECT_ID: the project ID of the build.\n- $BUILD_ID: the autogenerated ID of the build.\n- $REPO_NAME: the source repository name specified by RepoSource.\n- $BRANCH_NAME: the branch name specified by RepoSource.\n- $TAG_NAME: the tag name specified by RepoSource.\n- $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or\n resolved from the specified branch or tag.\n- $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.", + "description": "A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.", "id": "Build", "properties": { "artifacts": { "$ref": "Artifacts", - "description": "Artifacts produced by the build that should be uploaded upon\nsuccessful completion of all build steps." + "description": "Artifacts produced by the build that should be uploaded upon successful completion of all build steps." }, "buildTriggerId": { - "description": "Output only. The ID of the `BuildTrigger` that triggered this build, if it\nwas triggered automatically.", + "description": "Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.", + "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. Time at which the request to create the build was received.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "finishTime": { - "description": "Output only. Time at which execution of the build was finished.\n\nThe difference between finish_time and start_time is the duration of the\nbuild's execution.", + "description": "Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "id": { "description": "Output only. Unique identifier of the build.", + "readOnly": true, "type": "string" }, "images": { - "description": "A list of images to be pushed upon the successful completion of all build\nsteps.\n\nThe images are pushed using the builder service account's credentials.\n\nThe digests of the pushed images will be stored in the `Build` resource's\nresults field.\n\nIf any of the images fail to be pushed, the build status is marked\n`FAILURE`.", + "description": "A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`.", "items": { "type": "string" }, @@ -690,10 +694,11 @@ }, "logUrl": { "description": "Output only. URL to logs for this build in Google Cloud Console.", + "readOnly": true, "type": "string" }, "logsBucket": { - "description": "Google Cloud Storage bucket where logs should be written (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\nLogs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.", + "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`.", "type": "string" }, "options": { @@ -702,16 +707,18 @@ }, "projectId": { "description": "Output only. ID of the project.", + "readOnly": true, "type": "string" }, "queueTtl": { - "description": "TTL in queue for this build. If provided and the build is enqueued longer\nthan this value, the build will expire and the build status will be\n`EXPIRED`.\n\nThe TTL starts ticking from create_time.", + "description": "TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time.", "format": "google-duration", "type": "string" }, "results": { "$ref": "Results", - "description": "Output only. Results of the build." + "description": "Output only. Results of the build.", + "readOnly": true }, "secrets": { "description": "Secrets to decrypt using Cloud Key Management Service.", @@ -731,6 +738,7 @@ "startTime": { "description": "Output only. Time at which execution of the build was started.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "status": { @@ -785,7 +793,7 @@ "type": "array" }, "timeout": { - "description": "Amount of time that this build should be allowed to run, to second\ngranularity. If this amount of time elapses, work on the build will cease\nand the build status will be `TIMEOUT`.\n\n`timeout` starts ticking from `startTime`.\n\nDefault time is ten minutes.", + "description": "Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is ten minutes.", "format": "google-duration", "type": "string" }, @@ -793,7 +801,8 @@ "additionalProperties": { "$ref": "TimeSpan" }, - "description": "Output only. Stores timing information for phases of the build. Valid keys\nare:\n\n* BUILD: time to execute all build steps\n* PUSH: time to push all specified images.\n* FETCHSOURCE: time to fetch source.\n\nIf the build does not specify source or images,\nthese keys will not be included.", + "description": "Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included.", + "readOnly": true, "type": "object" } }, @@ -815,23 +824,23 @@ "id": "BuildOptions", "properties": { "diskSizeGb": { - "description": "Requested disk size for the VM that runs the build. Note that this is *NOT*\n\"disk free\"; some of the space will be used by the operating system and\nbuild utilities. Also note that this is the minimum disk size that will be\nallocated for the build -- the build may run with a larger disk than\nrequested. At present, the maximum disk size is 1000GB; builds that request\nmore than the maximum are rejected with an error.", + "description": "Requested disk size for the VM that runs the build. Note that this is *NOT* \"disk free\"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error.", "format": "int64", "type": "string" }, "dynamicSubstitutions": { - "description": "Option to specify whether or not to apply bash style string\noperations to the substitutions.\n\nNOTE: this is always enabled for triggered builds and cannot be\noverridden in the build configuration file.", + "description": "Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.", "type": "boolean" }, "env": { - "description": "A list of global environment variable definitions that will exist for all\nbuild steps in this build. If a variable is defined in both globally and in\na build step, the variable will use the build step value.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\".", + "description": "A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".", "items": { "type": "string" }, "type": "array" }, "logStreamingOption": { - "description": "Option to define build log streaming behavior to Google Cloud\nStorage.", + "description": "Option to define build log streaming behavior to Google Cloud Storage.", "enum": [ "STREAM_DEFAULT", "STREAM_ON", @@ -840,12 +849,12 @@ "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\nwritten when the build is completed." + "Build logs should not be streamed to Google Cloud Storage; they will be written when the build is completed." ], "type": "string" }, "logging": { - "description": "Option to specify the logging mode, which determines if and where build\nlogs are stored.", + "description": "Option to specify the logging mode, which determines if and where build logs are stored.", "enum": [ "LOGGING_UNSPECIFIED", "LEGACY", @@ -855,12 +864,12 @@ "NONE" ], "enumDescriptions": [ - "The service determines the logging mode. The default is `LEGACY`. Do not\nrely on the default logging behavior as it may change in the future.", + "The service determines the logging mode. The default is `LEGACY`. Do not rely on the default logging behavior as it may change in the future.", "Cloud Logging and Cloud Storage logging are enabled.", "Only Cloud Storage logging is enabled.", "This option is the same as CLOUD_LOGGING_ONLY.", - "Only Cloud Logging is enabled. Note that logs for both the Cloud Console\nUI and Cloud SDK are based on Cloud Storage logs, so neither will provide\nlogs if this option is chosen.", - "Turn off all logging. No build logs will be captured.\nNext ID: 6" + "Only Cloud Logging is enabled. Note that logs for both the Cloud Console UI and Cloud SDK are based on Cloud Storage logs, so neither will provide logs if this option is chosen.", + "Turn off all logging. No build logs will be captured. Next ID: 6" ], "type": "string" }, @@ -891,7 +900,7 @@ "type": "string" }, "secretEnv": { - "description": "A list of global environment variables, which are encrypted using a Cloud\nKey Management Service crypto key. These values must be specified in the\nbuild's `Secret`. These variables will be available to all build steps\nin this build.", + "description": "A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build.", "items": { "type": "string" }, @@ -910,31 +919,36 @@ "SHA256", "MD5" ], + "enumDescriptions": [ + "No hash requested.", + "Use a sha256 hash.", + "Use a md5 hash." + ], "type": "string" }, "type": "array" }, "substitutionOption": { - "description": "Option to specify behavior when there is an error in the substitution\nchecks.\n\nNOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot\nbe overridden in the build configuration file.", + "description": "Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file.", "enum": [ "MUST_MATCH", "ALLOW_LOOSE" ], "enumDescriptions": [ - "Fails the build if error in substitutions checks, like missing\na substitution in the template or in the map.", + "Fails the build if error in substitutions checks, like missing a substitution in the template or in the map.", "Do not fail the build if error in substitutions checks." ], "type": "string" }, "volumes": { - "description": "Global list of volumes to mount for ALL build steps\n\nEach volume is created as an empty volume prior to starting the build\nprocess. Upon completion of the build, volumes and their contents are\ndiscarded. Global volume names and paths cannot conflict with the volumes\ndefined a build step.\n\nUsing a global volume in a build with only one step is not valid as\nit is indicative of a build request with an incorrect configuration.", + "description": "Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.", "items": { "$ref": "Volume" }, "type": "array" }, "workerPool": { - "description": "Option to specify a `WorkerPool` for the build.\nFormat: projects/{project}/workerPools/{workerPool}\n\nThis field is experimental.", + "description": "Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is experimental.", "type": "string" } }, @@ -945,48 +959,49 @@ "id": "BuildStep", "properties": { "args": { - "description": "A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, the `args`\nare used as arguments to that entrypoint. If the image does not define\nan entrypoint, the first element in args is used as the entrypoint,\nand the remainder will be used as arguments.", + "description": "A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.", "items": { "type": "string" }, "type": "array" }, "dir": { - "description": "Working directory to use when running this step's container.\n\nIf this value is a relative path, it is relative to the build's working\ndirectory. If this value is absolute, it may be outside the build's working\ndirectory, in which case the contents of the path may not be persisted\nacross build step executions, unless a `volume` for that path is specified.\n\nIf the build specifies a `RepoSource` with `dir` and a step with a `dir`,\nwhich specifies an absolute path, the `RepoSource` `dir` is ignored for\nthe step's execution.", + "description": "Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.", "type": "string" }, "entrypoint": { - "description": "Entrypoint to be used instead of the build step image's default entrypoint.\nIf unset, the image's default entrypoint is used.", + "description": "Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.", "type": "string" }, "env": { - "description": "A list of environment variable definitions to be used when running a step.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\".", + "description": "A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".", "items": { "type": "string" }, "type": "array" }, "id": { - "description": "Unique identifier for this build step, used in `wait_for` to\nreference this build step as a dependency.", + "description": "Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.", "type": "string" }, "name": { - "description": "Required. The name of the container image that will run this particular\nbuild step.\n\nIf the image is available in the host's Docker daemon's cache, it\nwill be run directly. If not, the host will attempt to pull the image\nfirst, using the builder service account's credentials if necessary.\n\nThe Docker daemon's cache will already have the latest versions of all of\nthe officially supported build steps\n([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).\nThe Docker daemon will also have cached many of the layers for some popular\nimages, like \"ubuntu\", \"debian\", but they will be refreshed at the time you\nattempt to use them.\n\nIf you built an image in a previous build step, it will be stored in the\nhost's Docker daemon's cache and is available to use as the name for a\nlater build step.", + "description": "Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like \"ubuntu\", \"debian\", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.", "type": "string" }, "pullTiming": { "$ref": "TimeSpan", - "description": "Output only. Stores timing information for pulling this build step's\nbuilder image only." + "description": "Output only. Stores timing information for pulling this build step's builder image only.", + "readOnly": true }, "secretEnv": { - "description": "A list of environment variables which are encrypted using a Cloud Key\nManagement Service crypto key. These values must be specified in the\nbuild's `Secret`.", + "description": "A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.", "items": { "type": "string" }, "type": "array" }, "status": { - "description": "Output only. Status of the build step. At this time, build step status is\nonly updated on build completion; step status is not updated in real-time\nas the build progresses.", + "description": "Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.", "enum": [ "STATUS_UNKNOWN", "QUEUED", @@ -1012,23 +1027,24 @@ "type": "string" }, "timeout": { - "description": "Time limit for executing this build step. If not defined, the step has no\ntime limit and will be allowed to continue to run until either it completes\nor the build itself times out.", + "description": "Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.", "format": "google-duration", "type": "string" }, "timing": { "$ref": "TimeSpan", - "description": "Output only. Stores timing information for executing this build step." + "description": "Output only. Stores timing information for executing this build step.", + "readOnly": true }, "volumes": { - "description": "List of volumes to mount into the build step.\n\nEach volume is created as an empty volume prior to execution of the\nbuild step. Upon completion of the build, volumes and their contents are\ndiscarded.\n\nUsing a named volume in only one step is not valid as it is indicative\nof a build request with an incorrect configuration.", + "description": "List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.", "items": { "$ref": "Volume" }, "type": "array" }, "waitFor": { - "description": "The ID(s) of the step(s) that this build step depends on.\nThis build step will not start until all the build steps in `wait_for`\nhave completed successfully. If `wait_for` is empty, this build step will\nstart when all previous build steps in the `Build.Steps` list have\ncompleted successfully.", + "description": "The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.", "items": { "type": "string" }, @@ -1038,7 +1054,7 @@ "type": "object" }, "BuildTrigger": { - "description": "Configuration for an automated build in response to source repository\nchanges.", + "description": "Configuration for an automated build in response to source repository changes.", "id": "BuildTrigger", "properties": { "build": { @@ -1048,6 +1064,7 @@ "createTime": { "description": "Output only. Time when the trigger was created.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "description": { @@ -1059,40 +1076,41 @@ "type": "boolean" }, "filename": { - "description": "Path, from the source root, to a file whose contents is used for the\ntemplate.", + "description": "Path, from the source root, to a file whose contents is used for the template.", "type": "string" }, "github": { "$ref": "GitHubEventsConfig", - "description": "GitHubEventsConfig describes the configuration of a trigger that creates\na build whenever a GitHub event is received.\n\nMutually exclusive with `trigger_template`." + "description": "GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`." }, "id": { "description": "Output only. Unique identifier of the trigger.", + "readOnly": true, "type": "string" }, "ignoredFiles": { - "description": "ignored_files and included_files are file glob matches using\nhttps://golang.org/pkg/path/filepath/#Match extended with support for \"**\".\n\nIf ignored_files and changed files are both empty, then they are\nnot used to determine whether or not to trigger a build.\n\nIf ignored_files is not empty, then we ignore any files that match\nany of the ignored_file globs. If the change has no files that are\noutside of the ignored_files globs, then we do not trigger a build.", + "description": "ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for \"**\". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build.", "items": { "type": "string" }, "type": "array" }, "includedFiles": { - "description": "If any of the files altered in the commit pass the ignored_files\nfilter and included_files is empty, then as far as this filter is\nconcerned, we should trigger the build.\n\nIf any of the files altered in the commit pass the ignored_files\nfilter and included_files is not empty, then we make sure that at\nleast one of those files matches a included_files glob. If not,\nthen we do not trigger a build.", + "description": "If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build.", "items": { "type": "string" }, "type": "array" }, "name": { - "description": "User-assigned name of the trigger. Must be unique within the project.\nTrigger names must meet the following requirements:\n\n+ They must contain only alphanumeric characters and dashes.\n+ They can be 1-64 characters long.\n+ They must begin and end with an alphanumeric character.", + "description": "User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character.", "type": "string" }, "substitutions": { "additionalProperties": { "type": "string" }, - "description": "Substitutions for Build resource. The keys must match the following\nregular expression: `^_[A-Z0-9_]+$`.The keys cannot conflict with the\nkeys in bindings.", + "description": "Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`.The keys cannot conflict with the keys in bindings.", "type": "object" }, "tags": { @@ -1104,7 +1122,7 @@ }, "triggerTemplate": { "$ref": "RepoSource", - "description": "Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular expression\nwill trigger a build.\n\nMutually exclusive with `github`." + "description": "Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. Mutually exclusive with `github`." } }, "type": "object" @@ -1118,12 +1136,13 @@ "type": "string" }, "name": { - "description": "Name used to push the container image to Google Container Registry, as\npresented to `docker push`.", + "description": "Name used to push the container image to Google Container Registry, as presented to `docker push`.", "type": "string" }, "pushTiming": { "$ref": "TimeSpan", - "description": "Output only. Stores timing information for pushing the specified image." + "description": "Output only. Stores timing information for pushing the specified image.", + "readOnly": true } }, "type": "object" @@ -1141,13 +1160,13 @@ "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" }, "FileHashes": { - "description": "Container message for hashes of byte content of files, used in\nSourceProvenance messages to verify integrity of source input to the build.", + "description": "Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.", "id": "FileHashes", "properties": { "fileHash": { @@ -1161,7 +1180,7 @@ "type": "object" }, "GitHubEventsConfig": { - "description": "GitHubEventsConfig describes the configuration of a trigger that creates a\nbuild whenever a GitHub event is received.\n\nThis message is experimental.", + "description": "GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental.", "id": "GitHubEventsConfig", "properties": { "installationId": { @@ -1170,11 +1189,11 @@ "type": "string" }, "name": { - "description": "Name of the repository. For example: The name for\nhttps://github.com/googlecloudplatform/cloud-builders is \"cloud-builders\".", + "description": "Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is \"cloud-builders\".", "type": "string" }, "owner": { - "description": "Owner of the repository. For example: The owner for\nhttps://github.com/googlecloudplatform/cloud-builders is\n\"googlecloudplatform\".", + "description": "Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is \"googlecloudplatform\".", "type": "string" }, "pullRequest": { @@ -1262,11 +1281,11 @@ "type": "object" }, "Notification": { - "description": "Notification is the container which holds the data that is relevant to this\nparticular notification.", + "description": "Notification is the container which holds the data that is relevant to this particular notification.", "id": "Notification", "properties": { "filter": { - "description": "The filter string to use for notification filtering.\nCurrently, this is assumed to be a CEL program.\nSee https://opensource.google/projects/cel for more.", + "description": "The filter string to use for notification filtering. Currently, this is assumed to be a CEL program. See https://opensource.google/projects/cel for more.", "type": "string" }, "httpDelivery": { @@ -1316,41 +1335,41 @@ "type": "object" }, "NotifierMetadata": { - "description": "NotifierMetadata contains the data which can be used to reference or describe\nthis notifier.", + "description": "NotifierMetadata contains the data which can be used to reference or describe this notifier.", "id": "NotifierMetadata", "properties": { "name": { - "description": "The human-readable and user-given name for the notifier.\nFor example: \"repo-merge-email-notifier\".", + "description": "The human-readable and user-given name for the notifier. For example: \"repo-merge-email-notifier\".", "type": "string" }, "notifier": { - "description": "The string representing the name and version of notifier to deploy.\nExpected to be of the form of \"/:\".\nFor example: \"gcr.io/my-project/notifiers/smtp:1.2.34\".", + "description": "The string representing the name and version of notifier to deploy. Expected to be of the form of \"/:\". For example: \"gcr.io/my-project/notifiers/smtp:1.2.34\".", "type": "string" } }, "type": "object" }, "NotifierSecret": { - "description": "NotifierSecret is the container that maps a secret name (reference) to its\nGoogle Cloud Secret Manager resource path.", + "description": "NotifierSecret is the container that maps a secret name (reference) to its Google Cloud Secret Manager resource path.", "id": "NotifierSecret", "properties": { "name": { - "description": "Name is the local name of the secret, such as the verbatim string\n\"my-smtp-password\".", + "description": "Name is the local name of the secret, such as the verbatim string \"my-smtp-password\".", "type": "string" }, "value": { - "description": "Value is interpreted to be a resource path for fetching the actual\n(versioned) secret data for this secret. For example, this would be a\nGoogle Cloud Secret Manager secret version resource path like:\n\"projects/my-project/secrets/my-secret/versions/latest\".", + "description": "Value is interpreted to be a resource path for fetching the actual (versioned) secret data for this secret. For example, this would be a Google Cloud Secret Manager secret version resource path like: \"projects/my-project/secrets/my-secret/versions/latest\".", "type": "string" } }, "type": "object" }, "NotifierSecretRef": { - "description": "NotifierSecretRef contains the reference to a secret stored in the\ncorresponding NotifierSpec.", + "description": "NotifierSecretRef contains the reference to a secret stored in the corresponding NotifierSpec.", "id": "NotifierSecretRef", "properties": { "secretRef": { - "description": "The value of `secret_ref` should be a `name` that is registered in a\n`Secret` in the `secrets` list of the `Spec`.", + "description": "The value of `secret_ref` should be a `name` that is registered in a `Secret` in the `secrets` list of the `Spec`.", "type": "string" } }, @@ -1375,11 +1394,11 @@ "type": "object" }, "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "properties": { "done": { - "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { @@ -1391,11 +1410,11 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" }, "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "response": { @@ -1403,29 +1422,29 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" } }, "type": "object" }, "PullRequestFilter": { - "description": "PullRequestFilter contains filter properties for matching GitHub Pull\nRequests.", + "description": "PullRequestFilter contains filter properties for matching GitHub Pull Requests.", "id": "PullRequestFilter", "properties": { "branch": { - "description": "Regex of branches to match.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax", + "description": "Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", "type": "string" }, "commentControl": { - "description": "Configure builds to run whether a repository owner or collaborator need to\ncomment `/gcbrun`.", + "description": "Configure builds to run whether a repository owner or collaborator need to comment `/gcbrun`.", "enum": [ "COMMENTS_DISABLED", "COMMENTS_ENABLED" ], "enumDescriptions": [ "Do not require comments on Pull Requests before builds are triggered.", - "Enforce that repository owners or collaborators must comment on Pull\nRequests before builds are triggered." + "Enforce that repository owners or collaborators must comment on Pull Requests before builds are triggered." ], "type": "string" }, @@ -1441,15 +1460,15 @@ "id": "PushFilter", "properties": { "branch": { - "description": "Regexes matching branches to build.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax", + "description": "Regexes matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", "type": "string" }, "invertRegex": { - "description": "When true, only trigger a build if the revision regex does NOT match the\ngit_ref regex.", + "description": "When true, only trigger a build if the revision regex does NOT match the git_ref regex.", "type": "boolean" }, "tag": { - "description": "Regexes matching tags to build.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax", + "description": "Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", "type": "string" } }, @@ -1460,7 +1479,7 @@ "id": "RepoSource", "properties": { "branchName": { - "description": "Regex matching branches to build.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax", + "description": "Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", "type": "string" }, "commitSha": { @@ -1468,15 +1487,15 @@ "type": "string" }, "dir": { - "description": "Directory, relative to the source root, in which to run the build.\n\nThis must be a relative path. If a step's `dir` is specified and is an\nabsolute path, this value is ignored for that step's execution.", + "description": "Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.", "type": "string" }, "invertRegex": { - "description": "Only trigger a build if the revision regex does NOT match the revision\nregex.", + "description": "Only trigger a build if the revision regex does NOT match the revision regex.", "type": "boolean" }, "projectId": { - "description": "ID of the project that owns the Cloud Source Repository. If omitted, the\nproject ID requesting the build is assumed.", + "description": "ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.", "type": "string" }, "repoName": { @@ -1487,11 +1506,11 @@ "additionalProperties": { "type": "string" }, - "description": "Substitutions to use in a triggered build.\nShould only be used with RunBuildTrigger", + "description": "Substitutions to use in a triggered build. Should only be used with RunBuildTrigger", "type": "object" }, "tagName": { - "description": "Regex matching tags to build.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax", + "description": "Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", "type": "string" } }, @@ -1510,14 +1529,14 @@ "description": "Time to push all non-container artifacts." }, "buildStepImages": { - "description": "List of build step digests, in the order corresponding to build step\nindices.", + "description": "List of build step digests, in the order corresponding to build step indices.", "items": { "type": "string" }, "type": "array" }, "buildStepOutputs": { - "description": "List of build step outputs, produced by builder images, in the order\ncorresponding to build step indices.\n\n[Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders)\ncan produce this output by writing to `$BUILDER_OUTPUT/output`.\nOnly the first 4KB of data is stored.", + "description": "List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored.", "items": { "format": "byte", "type": "string" @@ -1550,7 +1569,7 @@ "id": "SMTPDelivery", "properties": { "fromAddress": { - "description": "This is the SMTP account/email that appears in the `From:` of the email.\nIf empty, it is assumed to be sender.", + "description": "This is the SMTP account/email that appears in the `From:` of the email. If empty, it is assumed to be sender.", "type": "string" }, "password": { @@ -1562,7 +1581,7 @@ "type": "string" }, "recipientAddresses": { - "description": "This is the list of addresses to which we send the email (i.e. in the `To:`\nof the email).", + "description": "This is the list of addresses to which we send the email (i.e. in the `To:` of the email).", "items": { "type": "string" }, @@ -1580,7 +1599,7 @@ "type": "object" }, "Secret": { - "description": "Pairs a set of secret environment variables containing encrypted\nvalues with the Cloud KMS key to use to decrypt the value.", + "description": "Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value.", "id": "Secret", "properties": { "kmsKeyName": { @@ -1592,19 +1611,19 @@ "format": "byte", "type": "string" }, - "description": "Map of environment variable name to its encrypted value.\n\nSecret environment variables must be unique across all of a build's\nsecrets, and must be used by at least one build step. Values can be at most\n64 KB in size. There can be at most 100 secret values across all of a\nbuild's secrets.", + "description": "Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.", "type": "object" } }, "type": "object" }, "SlackDelivery": { - "description": "SlackDelivery is the delivery configuration for delivering Slack messages via\nwebhooks. See Slack webhook documentation at:\nhttps://api.slack.com/messaging/webhooks.", + "description": "SlackDelivery is the delivery configuration for delivering Slack messages via webhooks. See Slack webhook documentation at: https://api.slack.com/messaging/webhooks.", "id": "SlackDelivery", "properties": { "webhookUri": { "$ref": "NotifierSecretRef", - "description": "The secret reference for the Slack webhook URI for sending messages to a\nchannel." + "description": "The secret reference for the Slack webhook URI for sending messages to a channel." } }, "type": "object" @@ -1615,7 +1634,7 @@ "properties": { "repoSource": { "$ref": "RepoSource", - "description": "If provided, get the source from this location in a Cloud Source\nRepository." + "description": "If provided, get the source from this location in a Cloud Source Repository." }, "storageSource": { "$ref": "StorageSource", @@ -1625,29 +1644,30 @@ "type": "object" }, "SourceProvenance": { - "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build.", + "description": "Provenance of the source. Ways to find the original source, or verify that some source was used for this build.", "id": "SourceProvenance", "properties": { "fileHashes": { "additionalProperties": { "$ref": "FileHashes" }, - "description": "Output only. Hash(es) of the build source, which can be used to verify that\nthe original source integrity was maintained in the build. Note that\n`FileHashes` will only be populated if `BuildOptions` has requested a\n`SourceProvenanceHash`.\n\nThe keys to this map are file paths used as build source and the values\ncontain the hash values for those files.\n\nIf the build source came in a single package such as a gzipped tarfile\n(`.tar.gz`), the `FileHash` will be for the single path to that file.", + "description": "Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file.", + "readOnly": true, "type": "object" }, "resolvedRepoSource": { "$ref": "RepoSource", - "description": "A copy of the build's `source.repo_source`, if exists, with any\nrevisions resolved." + "description": "A copy of the build's `source.repo_source`, if exists, with any revisions resolved." }, "resolvedStorageSource": { "$ref": "StorageSource", - "description": "A copy of the build's `source.storage_source`, if exists, with any\ngenerations resolved." + "description": "A copy of the build's `source.storage_source`, if exists, with any generations resolved." } }, "type": "object" }, "Status": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { @@ -1656,7 +1676,7 @@ "type": "integer" }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -1667,7 +1687,7 @@ "type": "array" }, "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, @@ -1678,16 +1698,16 @@ "id": "StorageSource", "properties": { "bucket": { - "description": "Google Cloud Storage bucket containing the source (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", + "description": "Google 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\nomitted, the latest generation will be used.", + "description": "Google 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.\n\nThis object must be a gzipped archive file (`.tar.gz`) containing source to\nbuild.", + "description": "Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.", "type": "string" } }, @@ -1711,15 +1731,15 @@ "type": "object" }, "Volume": { - "description": "Volume describes a Docker container volume which is mounted into build steps\nin order to persist files across build step execution.", + "description": "Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.", "id": "Volume", "properties": { "name": { - "description": "Name of the volume to mount.\n\nVolume names must be unique per build step and must be valid names for\nDocker volumes. Each named volume must be used by at least two build steps.", + "description": "Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.", "type": "string" }, "path": { - "description": "Path at which to mount the volume.\n\nPaths must be absolute and cannot conflict with other volume paths on the\nsame build step or with certain reserved volume paths.", + "description": "Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.", "type": "string" } }, diff --git a/discovery/cloudbuild-v1alpha1.json b/discovery/cloudbuild-v1alpha1.json index 37fc4acf23..502216e27e 100644 --- a/discovery/cloudbuild-v1alpha1.json +++ b/discovery/cloudbuild-v1alpha1.json @@ -112,7 +112,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "cloudbuild.projects.locations.operations.cancel", @@ -140,7 +140,7 @@ ] }, "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "id": "cloudbuild.projects.locations.operations.get", @@ -208,7 +208,7 @@ ], "parameters": { "name": { - "description": "The field will contain name of the resource requested, for example:\n\"projects/project-1/workerPools/workerpool-name\"", + "description": "The field will contain name of the resource requested, for example: \"projects/project-1/workerPools/workerpool-name\"", "location": "path", "pattern": "^projects/[^/]+/workerPools/[^/]+$", "required": true, @@ -233,7 +233,7 @@ ], "parameters": { "name": { - "description": "The field will contain name of the resource requested, for example:\n\"projects/project-1/workerPools/workerpool-name\"", + "description": "The field will contain name of the resource requested, for example: \"projects/project-1/workerPools/workerpool-name\"", "location": "path", "pattern": "^projects/[^/]+/workerPools/[^/]+$", "required": true, @@ -283,7 +283,7 @@ ], "parameters": { "name": { - "description": "The field will contain name of the resource requested, for example:\n\"projects/project-1/workerPools/workerpool-name\"", + "description": "The field will contain name of the resource requested, for example: \"projects/project-1/workerPools/workerpool-name\"", "location": "path", "pattern": "^projects/[^/]+/workerPools/[^/]+$", "required": true, @@ -306,15 +306,15 @@ } } }, - "revision": "20200726", + "revision": "20200801", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ArtifactObjects": { - "description": "Files in the workspace to upload to Cloud Storage upon successful\ncompletion of all build steps.", + "description": "Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.", "id": "ArtifactObjects", "properties": { "location": { - "description": "Cloud Storage bucket and optional object path, in the form\n\"gs://bucket/path/to/somewhere/\". (see [Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\n\nFiles in the workspace matching any path pattern will be uploaded to\nCloud Storage with this location as a prefix.", + "description": "Cloud Storage bucket and optional object path, in the form \"gs://bucket/path/to/somewhere/\". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.", "type": "string" }, "paths": { @@ -332,7 +332,7 @@ "type": "object" }, "ArtifactResult": { - "description": "An artifact that was uploaded during a build. This\nis a single record in the artifact manifest JSON file.", + "description": "An artifact that was uploaded during a build. This is a single record in the artifact manifest JSON file.", "id": "ArtifactResult", "properties": { "fileHash": { @@ -343,18 +343,18 @@ "type": "array" }, "location": { - "description": "The path of an artifact in a Google Cloud Storage bucket, with the\ngeneration number. For example,\n`gs://mybucket/path/to/output.jar#generation`.", + "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`.", "type": "string" } }, "type": "object" }, "Artifacts": { - "description": "Artifacts produced by a build that should be uploaded upon\nsuccessful completion of all build steps.", + "description": "Artifacts produced by a build that should be uploaded upon successful completion of all build steps.", "id": "Artifacts", "properties": { "images": { - "description": "A list of images to be pushed upon the successful completion of all build\nsteps.\n\nThe images will be pushed using the builder service account's credentials.\n\nThe digests of the pushed images will be stored in the Build resource's\nresults field.\n\nIf any of the images fail to be pushed, the build is marked FAILURE.", + "description": "A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.", "items": { "type": "string" }, @@ -362,39 +362,43 @@ }, "objects": { "$ref": "ArtifactObjects", - "description": "A list of objects to be uploaded to Cloud Storage upon successful\ncompletion of all build steps.\n\nFiles in the workspace matching specified paths globs will be uploaded to\nthe specified Cloud Storage location using the builder service account's\ncredentials.\n\nThe location and generation of the uploaded objects will be stored in the\nBuild resource's results field.\n\nIf any objects fail to be pushed, the build is marked FAILURE." + "description": "A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE." } }, "type": "object" }, "Build": { - "description": "A build resource in the Cloud Build API.\n\nAt a high level, a `Build` describes where to find source code, how to build\nit (for example, the builder image to run on the source), and where to store\nthe built artifacts.\n\nFields can include the following variables, which will be expanded when the\nbuild is created:\n\n- $PROJECT_ID: the project ID of the build.\n- $BUILD_ID: the autogenerated ID of the build.\n- $REPO_NAME: the source repository name specified by RepoSource.\n- $BRANCH_NAME: the branch name specified by RepoSource.\n- $TAG_NAME: the tag name specified by RepoSource.\n- $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or\n resolved from the specified branch or tag.\n- $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.", + "description": "A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.", "id": "Build", "properties": { "artifacts": { "$ref": "Artifacts", - "description": "Artifacts produced by the build that should be uploaded upon\nsuccessful completion of all build steps." + "description": "Artifacts produced by the build that should be uploaded upon successful completion of all build steps." }, "buildTriggerId": { - "description": "Output only. The ID of the `BuildTrigger` that triggered this build, if it\nwas triggered automatically.", + "description": "Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.", + "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. Time at which the request to create the build was received.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "finishTime": { - "description": "Output only. Time at which execution of the build was finished.\n\nThe difference between finish_time and start_time is the duration of the\nbuild's execution.", + "description": "Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "id": { "description": "Output only. Unique identifier of the build.", + "readOnly": true, "type": "string" }, "images": { - "description": "A list of images to be pushed upon the successful completion of all build\nsteps.\n\nThe images are pushed using the builder service account's credentials.\n\nThe digests of the pushed images will be stored in the `Build` resource's\nresults field.\n\nIf any of the images fail to be pushed, the build status is marked\n`FAILURE`.", + "description": "A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`.", "items": { "type": "string" }, @@ -402,10 +406,11 @@ }, "logUrl": { "description": "Output only. URL to logs for this build in Google Cloud Console.", + "readOnly": true, "type": "string" }, "logsBucket": { - "description": "Google Cloud Storage bucket where logs should be written (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\nLogs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.", + "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`.", "type": "string" }, "options": { @@ -414,16 +419,18 @@ }, "projectId": { "description": "Output only. ID of the project.", + "readOnly": true, "type": "string" }, "queueTtl": { - "description": "TTL in queue for this build. If provided and the build is enqueued longer\nthan this value, the build will expire and the build status will be\n`EXPIRED`.\n\nThe TTL starts ticking from create_time.", + "description": "TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time.", "format": "google-duration", "type": "string" }, "results": { "$ref": "Results", - "description": "Output only. Results of the build." + "description": "Output only. Results of the build.", + "readOnly": true }, "secrets": { "description": "Secrets to decrypt using Cloud Key Management Service.", @@ -443,6 +450,7 @@ "startTime": { "description": "Output only. Time at which execution of the build was started.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "status": { @@ -497,7 +505,7 @@ "type": "array" }, "timeout": { - "description": "Amount of time that this build should be allowed to run, to second\ngranularity. If this amount of time elapses, work on the build will cease\nand the build status will be `TIMEOUT`.\n\n`timeout` starts ticking from `startTime`.\n\nDefault time is ten minutes.", + "description": "Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is ten minutes.", "format": "google-duration", "type": "string" }, @@ -505,7 +513,8 @@ "additionalProperties": { "$ref": "TimeSpan" }, - "description": "Output only. Stores timing information for phases of the build. Valid keys\nare:\n\n* BUILD: time to execute all build steps\n* PUSH: time to push all specified images.\n* FETCHSOURCE: time to fetch source.\n\nIf the build does not specify source or images,\nthese keys will not be included.", + "description": "Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included.", + "readOnly": true, "type": "object" } }, @@ -527,23 +536,23 @@ "id": "BuildOptions", "properties": { "diskSizeGb": { - "description": "Requested disk size for the VM that runs the build. Note that this is *NOT*\n\"disk free\"; some of the space will be used by the operating system and\nbuild utilities. Also note that this is the minimum disk size that will be\nallocated for the build -- the build may run with a larger disk than\nrequested. At present, the maximum disk size is 1000GB; builds that request\nmore than the maximum are rejected with an error.", + "description": "Requested disk size for the VM that runs the build. Note that this is *NOT* \"disk free\"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error.", "format": "int64", "type": "string" }, "dynamicSubstitutions": { - "description": "Option to specify whether or not to apply bash style string\noperations to the substitutions.\n\nNOTE: this is always enabled for triggered builds and cannot be\noverridden in the build configuration file.", + "description": "Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.", "type": "boolean" }, "env": { - "description": "A list of global environment variable definitions that will exist for all\nbuild steps in this build. If a variable is defined in both globally and in\na build step, the variable will use the build step value.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\".", + "description": "A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".", "items": { "type": "string" }, "type": "array" }, "logStreamingOption": { - "description": "Option to define build log streaming behavior to Google Cloud\nStorage.", + "description": "Option to define build log streaming behavior to Google Cloud Storage.", "enum": [ "STREAM_DEFAULT", "STREAM_ON", @@ -552,12 +561,12 @@ "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\nwritten when the build is completed." + "Build logs should not be streamed to Google Cloud Storage; they will be written when the build is completed." ], "type": "string" }, "logging": { - "description": "Option to specify the logging mode, which determines if and where build\nlogs are stored.", + "description": "Option to specify the logging mode, which determines if and where build logs are stored.", "enum": [ "LOGGING_UNSPECIFIED", "LEGACY", @@ -567,12 +576,12 @@ "NONE" ], "enumDescriptions": [ - "The service determines the logging mode. The default is `LEGACY`. Do not\nrely on the default logging behavior as it may change in the future.", + "The service determines the logging mode. The default is `LEGACY`. Do not rely on the default logging behavior as it may change in the future.", "Cloud Logging and Cloud Storage logging are enabled.", "Only Cloud Storage logging is enabled.", "This option is the same as CLOUD_LOGGING_ONLY.", - "Only Cloud Logging is enabled. Note that logs for both the Cloud Console\nUI and Cloud SDK are based on Cloud Storage logs, so neither will provide\nlogs if this option is chosen.", - "Turn off all logging. No build logs will be captured.\nNext ID: 6" + "Only Cloud Logging is enabled. Note that logs for both the Cloud Console UI and Cloud SDK are based on Cloud Storage logs, so neither will provide logs if this option is chosen.", + "Turn off all logging. No build logs will be captured. Next ID: 6" ], "type": "string" }, @@ -603,7 +612,7 @@ "type": "string" }, "secretEnv": { - "description": "A list of global environment variables, which are encrypted using a Cloud\nKey Management Service crypto key. These values must be specified in the\nbuild's `Secret`. These variables will be available to all build steps\nin this build.", + "description": "A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build.", "items": { "type": "string" }, @@ -622,31 +631,36 @@ "SHA256", "MD5" ], + "enumDescriptions": [ + "No hash requested.", + "Use a sha256 hash.", + "Use a md5 hash." + ], "type": "string" }, "type": "array" }, "substitutionOption": { - "description": "Option to specify behavior when there is an error in the substitution\nchecks.\n\nNOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot\nbe overridden in the build configuration file.", + "description": "Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file.", "enum": [ "MUST_MATCH", "ALLOW_LOOSE" ], "enumDescriptions": [ - "Fails the build if error in substitutions checks, like missing\na substitution in the template or in the map.", + "Fails the build if error in substitutions checks, like missing a substitution in the template or in the map.", "Do not fail the build if error in substitutions checks." ], "type": "string" }, "volumes": { - "description": "Global list of volumes to mount for ALL build steps\n\nEach volume is created as an empty volume prior to starting the build\nprocess. Upon completion of the build, volumes and their contents are\ndiscarded. Global volume names and paths cannot conflict with the volumes\ndefined a build step.\n\nUsing a global volume in a build with only one step is not valid as\nit is indicative of a build request with an incorrect configuration.", + "description": "Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.", "items": { "$ref": "Volume" }, "type": "array" }, "workerPool": { - "description": "Option to specify a `WorkerPool` for the build.\nFormat: projects/{project}/workerPools/{workerPool}\n\nThis field is experimental.", + "description": "Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is experimental.", "type": "string" } }, @@ -657,48 +671,49 @@ "id": "BuildStep", "properties": { "args": { - "description": "A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, the `args`\nare used as arguments to that entrypoint. If the image does not define\nan entrypoint, the first element in args is used as the entrypoint,\nand the remainder will be used as arguments.", + "description": "A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.", "items": { "type": "string" }, "type": "array" }, "dir": { - "description": "Working directory to use when running this step's container.\n\nIf this value is a relative path, it is relative to the build's working\ndirectory. If this value is absolute, it may be outside the build's working\ndirectory, in which case the contents of the path may not be persisted\nacross build step executions, unless a `volume` for that path is specified.\n\nIf the build specifies a `RepoSource` with `dir` and a step with a `dir`,\nwhich specifies an absolute path, the `RepoSource` `dir` is ignored for\nthe step's execution.", + "description": "Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.", "type": "string" }, "entrypoint": { - "description": "Entrypoint to be used instead of the build step image's default entrypoint.\nIf unset, the image's default entrypoint is used.", + "description": "Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.", "type": "string" }, "env": { - "description": "A list of environment variable definitions to be used when running a step.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\".", + "description": "A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".", "items": { "type": "string" }, "type": "array" }, "id": { - "description": "Unique identifier for this build step, used in `wait_for` to\nreference this build step as a dependency.", + "description": "Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.", "type": "string" }, "name": { - "description": "Required. The name of the container image that will run this particular\nbuild step.\n\nIf the image is available in the host's Docker daemon's cache, it\nwill be run directly. If not, the host will attempt to pull the image\nfirst, using the builder service account's credentials if necessary.\n\nThe Docker daemon's cache will already have the latest versions of all of\nthe officially supported build steps\n([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).\nThe Docker daemon will also have cached many of the layers for some popular\nimages, like \"ubuntu\", \"debian\", but they will be refreshed at the time you\nattempt to use them.\n\nIf you built an image in a previous build step, it will be stored in the\nhost's Docker daemon's cache and is available to use as the name for a\nlater build step.", + "description": "Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like \"ubuntu\", \"debian\", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.", "type": "string" }, "pullTiming": { "$ref": "TimeSpan", - "description": "Output only. Stores timing information for pulling this build step's\nbuilder image only." + "description": "Output only. Stores timing information for pulling this build step's builder image only.", + "readOnly": true }, "secretEnv": { - "description": "A list of environment variables which are encrypted using a Cloud Key\nManagement Service crypto key. These values must be specified in the\nbuild's `Secret`.", + "description": "A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.", "items": { "type": "string" }, "type": "array" }, "status": { - "description": "Output only. Status of the build step. At this time, build step status is\nonly updated on build completion; step status is not updated in real-time\nas the build progresses.", + "description": "Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.", "enum": [ "STATUS_UNKNOWN", "QUEUED", @@ -724,23 +739,24 @@ "type": "string" }, "timeout": { - "description": "Time limit for executing this build step. If not defined, the step has no\ntime limit and will be allowed to continue to run until either it completes\nor the build itself times out.", + "description": "Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.", "format": "google-duration", "type": "string" }, "timing": { "$ref": "TimeSpan", - "description": "Output only. Stores timing information for executing this build step." + "description": "Output only. Stores timing information for executing this build step.", + "readOnly": true }, "volumes": { - "description": "List of volumes to mount into the build step.\n\nEach volume is created as an empty volume prior to execution of the\nbuild step. Upon completion of the build, volumes and their contents are\ndiscarded.\n\nUsing a named volume in only one step is not valid as it is indicative\nof a build request with an incorrect configuration.", + "description": "List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.", "items": { "$ref": "Volume" }, "type": "array" }, "waitFor": { - "description": "The ID(s) of the step(s) that this build step depends on.\nThis build step will not start until all the build steps in `wait_for`\nhave completed successfully. If `wait_for` is empty, this build step will\nstart when all previous build steps in the `Build.Steps` list have\ncompleted successfully.", + "description": "The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.", "items": { "type": "string" }, @@ -758,12 +774,13 @@ "type": "string" }, "name": { - "description": "Name used to push the container image to Google Container Registry, as\npresented to `docker push`.", + "description": "Name used to push the container image to Google Container Registry, as presented to `docker push`.", "type": "string" }, "pushTiming": { "$ref": "TimeSpan", - "description": "Output only. Stores timing information for pushing the specified image." + "description": "Output only. Stores timing information for pushing the specified image.", + "readOnly": true } }, "type": "object" @@ -775,13 +792,13 @@ "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" }, "FileHashes": { - "description": "Container message for hashes of byte content of files, used in\nSourceProvenance messages to verify integrity of source input to the build.", + "description": "Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.", "id": "FileHashes", "properties": { "fileHash": { @@ -850,26 +867,26 @@ "id": "Network", "properties": { "network": { - "description": "Network on which the workers are created.\n\"default\" network is used if empty.", + "description": "Network on which the workers are created. \"default\" network is used if empty.", "type": "string" }, "projectId": { - "description": "Project id containing the defined network and subnetwork. For a peered VPC,\nthis will be the same as the project_id in which the workers are created.\nFor a shared VPC, this will be the project sharing the network with the\nproject_id project in which workers will be created. For custom workers\nwith no VPC, this will be the same as project_id.", + "description": "Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id.", "type": "string" }, "subnetwork": { - "description": "Subnetwork on which the workers are created.\n\"default\" subnetwork is used if empty.", + "description": "Subnetwork on which the workers are created. \"default\" subnetwork is used if empty.", "type": "string" } }, "type": "object" }, "Notification": { - "description": "Notification is the container which holds the data that is relevant to this\nparticular notification.", + "description": "Notification is the container which holds the data that is relevant to this particular notification.", "id": "Notification", "properties": { "filter": { - "description": "The filter string to use for notification filtering.\nCurrently, this is assumed to be a CEL program.\nSee https://opensource.google/projects/cel for more.", + "description": "The filter string to use for notification filtering. Currently, this is assumed to be a CEL program. See https://opensource.google/projects/cel for more.", "type": "string" }, "httpDelivery": { @@ -919,41 +936,41 @@ "type": "object" }, "NotifierMetadata": { - "description": "NotifierMetadata contains the data which can be used to reference or describe\nthis notifier.", + "description": "NotifierMetadata contains the data which can be used to reference or describe this notifier.", "id": "NotifierMetadata", "properties": { "name": { - "description": "The human-readable and user-given name for the notifier.\nFor example: \"repo-merge-email-notifier\".", + "description": "The human-readable and user-given name for the notifier. For example: \"repo-merge-email-notifier\".", "type": "string" }, "notifier": { - "description": "The string representing the name and version of notifier to deploy.\nExpected to be of the form of \"/:\".\nFor example: \"gcr.io/my-project/notifiers/smtp:1.2.34\".", + "description": "The string representing the name and version of notifier to deploy. Expected to be of the form of \"/:\". For example: \"gcr.io/my-project/notifiers/smtp:1.2.34\".", "type": "string" } }, "type": "object" }, "NotifierSecret": { - "description": "NotifierSecret is the container that maps a secret name (reference) to its\nGoogle Cloud Secret Manager resource path.", + "description": "NotifierSecret is the container that maps a secret name (reference) to its Google Cloud Secret Manager resource path.", "id": "NotifierSecret", "properties": { "name": { - "description": "Name is the local name of the secret, such as the verbatim string\n\"my-smtp-password\".", + "description": "Name is the local name of the secret, such as the verbatim string \"my-smtp-password\".", "type": "string" }, "value": { - "description": "Value is interpreted to be a resource path for fetching the actual\n(versioned) secret data for this secret. For example, this would be a\nGoogle Cloud Secret Manager secret version resource path like:\n\"projects/my-project/secrets/my-secret/versions/latest\".", + "description": "Value is interpreted to be a resource path for fetching the actual (versioned) secret data for this secret. For example, this would be a Google Cloud Secret Manager secret version resource path like: \"projects/my-project/secrets/my-secret/versions/latest\".", "type": "string" } }, "type": "object" }, "NotifierSecretRef": { - "description": "NotifierSecretRef contains the reference to a secret stored in the\ncorresponding NotifierSpec.", + "description": "NotifierSecretRef contains the reference to a secret stored in the corresponding NotifierSpec.", "id": "NotifierSecretRef", "properties": { "secretRef": { - "description": "The value of `secret_ref` should be a `name` that is registered in a\n`Secret` in the `secrets` list of the `Spec`.", + "description": "The value of `secret_ref` should be a `name` that is registered in a `Secret` in the `secrets` list of the `Spec`.", "type": "string" } }, @@ -978,11 +995,11 @@ "type": "object" }, "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "properties": { "done": { - "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { @@ -994,11 +1011,11 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" }, "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "response": { @@ -1006,7 +1023,7 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" } }, @@ -1017,7 +1034,7 @@ "id": "RepoSource", "properties": { "branchName": { - "description": "Regex matching branches to build.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax", + "description": "Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", "type": "string" }, "commitSha": { @@ -1025,15 +1042,15 @@ "type": "string" }, "dir": { - "description": "Directory, relative to the source root, in which to run the build.\n\nThis must be a relative path. If a step's `dir` is specified and is an\nabsolute path, this value is ignored for that step's execution.", + "description": "Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.", "type": "string" }, "invertRegex": { - "description": "Only trigger a build if the revision regex does NOT match the revision\nregex.", + "description": "Only trigger a build if the revision regex does NOT match the revision regex.", "type": "boolean" }, "projectId": { - "description": "ID of the project that owns the Cloud Source Repository. If omitted, the\nproject ID requesting the build is assumed.", + "description": "ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.", "type": "string" }, "repoName": { @@ -1044,11 +1061,11 @@ "additionalProperties": { "type": "string" }, - "description": "Substitutions to use in a triggered build.\nShould only be used with RunBuildTrigger", + "description": "Substitutions to use in a triggered build. Should only be used with RunBuildTrigger", "type": "object" }, "tagName": { - "description": "Regex matching tags to build.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax", + "description": "Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", "type": "string" } }, @@ -1067,14 +1084,14 @@ "description": "Time to push all non-container artifacts." }, "buildStepImages": { - "description": "List of build step digests, in the order corresponding to build step\nindices.", + "description": "List of build step digests, in the order corresponding to build step indices.", "items": { "type": "string" }, "type": "array" }, "buildStepOutputs": { - "description": "List of build step outputs, produced by builder images, in the order\ncorresponding to build step indices.\n\n[Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders)\ncan produce this output by writing to `$BUILDER_OUTPUT/output`.\nOnly the first 4KB of data is stored.", + "description": "List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored.", "items": { "format": "byte", "type": "string" @@ -1101,7 +1118,7 @@ "id": "SMTPDelivery", "properties": { "fromAddress": { - "description": "This is the SMTP account/email that appears in the `From:` of the email.\nIf empty, it is assumed to be sender.", + "description": "This is the SMTP account/email that appears in the `From:` of the email. If empty, it is assumed to be sender.", "type": "string" }, "password": { @@ -1113,7 +1130,7 @@ "type": "string" }, "recipientAddresses": { - "description": "This is the list of addresses to which we send the email (i.e. in the `To:`\nof the email).", + "description": "This is the list of addresses to which we send the email (i.e. in the `To:` of the email).", "items": { "type": "string" }, @@ -1131,7 +1148,7 @@ "type": "object" }, "Secret": { - "description": "Pairs a set of secret environment variables containing encrypted\nvalues with the Cloud KMS key to use to decrypt the value.", + "description": "Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value.", "id": "Secret", "properties": { "kmsKeyName": { @@ -1143,19 +1160,19 @@ "format": "byte", "type": "string" }, - "description": "Map of environment variable name to its encrypted value.\n\nSecret environment variables must be unique across all of a build's\nsecrets, and must be used by at least one build step. Values can be at most\n64 KB in size. There can be at most 100 secret values across all of a\nbuild's secrets.", + "description": "Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.", "type": "object" } }, "type": "object" }, "SlackDelivery": { - "description": "SlackDelivery is the delivery configuration for delivering Slack messages via\nwebhooks. See Slack webhook documentation at:\nhttps://api.slack.com/messaging/webhooks.", + "description": "SlackDelivery is the delivery configuration for delivering Slack messages via webhooks. See Slack webhook documentation at: https://api.slack.com/messaging/webhooks.", "id": "SlackDelivery", "properties": { "webhookUri": { "$ref": "NotifierSecretRef", - "description": "The secret reference for the Slack webhook URI for sending messages to a\nchannel." + "description": "The secret reference for the Slack webhook URI for sending messages to a channel." } }, "type": "object" @@ -1166,7 +1183,7 @@ "properties": { "repoSource": { "$ref": "RepoSource", - "description": "If provided, get the source from this location in a Cloud Source\nRepository." + "description": "If provided, get the source from this location in a Cloud Source Repository." }, "storageSource": { "$ref": "StorageSource", @@ -1176,29 +1193,30 @@ "type": "object" }, "SourceProvenance": { - "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build.", + "description": "Provenance of the source. Ways to find the original source, or verify that some source was used for this build.", "id": "SourceProvenance", "properties": { "fileHashes": { "additionalProperties": { "$ref": "FileHashes" }, - "description": "Output only. Hash(es) of the build source, which can be used to verify that\nthe original source integrity was maintained in the build. Note that\n`FileHashes` will only be populated if `BuildOptions` has requested a\n`SourceProvenanceHash`.\n\nThe keys to this map are file paths used as build source and the values\ncontain the hash values for those files.\n\nIf the build source came in a single package such as a gzipped tarfile\n(`.tar.gz`), the `FileHash` will be for the single path to that file.", + "description": "Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file.", + "readOnly": true, "type": "object" }, "resolvedRepoSource": { "$ref": "RepoSource", - "description": "A copy of the build's `source.repo_source`, if exists, with any\nrevisions resolved." + "description": "A copy of the build's `source.repo_source`, if exists, with any revisions resolved." }, "resolvedStorageSource": { "$ref": "StorageSource", - "description": "A copy of the build's `source.storage_source`, if exists, with any\ngenerations resolved." + "description": "A copy of the build's `source.storage_source`, if exists, with any generations resolved." } }, "type": "object" }, "Status": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { @@ -1207,7 +1225,7 @@ "type": "integer" }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -1218,7 +1236,7 @@ "type": "array" }, "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, @@ -1229,16 +1247,16 @@ "id": "StorageSource", "properties": { "bucket": { - "description": "Google Cloud Storage bucket containing the source (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", + "description": "Google 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\nomitted, the latest generation will be used.", + "description": "Google 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.\n\nThis object must be a gzipped archive file (`.tar.gz`) containing source to\nbuild.", + "description": "Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.", "type": "string" } }, @@ -1262,55 +1280,55 @@ "type": "object" }, "Volume": { - "description": "Volume describes a Docker container volume which is mounted into build steps\nin order to persist files across build step execution.", + "description": "Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.", "id": "Volume", "properties": { "name": { - "description": "Name of the volume to mount.\n\nVolume names must be unique per build step and must be valid names for\nDocker volumes. Each named volume must be used by at least two build steps.", + "description": "Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.", "type": "string" }, "path": { - "description": "Path at which to mount the volume.\n\nPaths must be absolute and cannot conflict with other volume paths on the\nsame build step or with certain reserved volume paths.", + "description": "Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.", "type": "string" } }, "type": "object" }, "WorkerConfig": { - "description": "WorkerConfig defines the configuration to be used for a creating workers in\nthe pool.", + "description": "WorkerConfig defines the configuration to be used for a creating workers in the pool.", "id": "WorkerConfig", "properties": { "diskSizeGb": { - "description": "Size of the disk attached to the worker, in GB.\nSee https://cloud.google.com/compute/docs/disks/\nIf `0` is specified, Cloud Build will use a standard disk size.\n`disk_size` is overridden if you specify a different disk size in\n`build_options`. In this case, a VM with a disk size specified in the\n`build_options` will be created on demand at build time. For more\ninformation see\nhttps://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions", + "description": "Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. `disk_size` is overridden if you specify a different disk size in `build_options`. In this case, a VM with a disk size specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions", "format": "int64", "type": "string" }, "machineType": { - "description": "Machine Type of the worker, such as n1-standard-1.\nSee https://cloud.google.com/compute/docs/machine-types.\nIf left blank, Cloud Build will use a standard unspecified machine to\ncreate the worker pool.\n`machine_type` is overridden if you specify a different machine type in\n`build_options`. In this case, the VM specified in the `build_options`\nwill be created on demand at build time. For more information see\nhttps://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes", + "description": "Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes", "type": "string" }, "network": { "$ref": "Network", - "description": "The network definition used to create the worker.\nIf this section is left empty, the workers will be created in\nWorkerPool.project_id on the default network." + "description": "The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network." }, "tag": { - "description": "The tag applied to the worker, and the same tag used by the firewall rule.\nIt is used to identify the Cloud Build workers among other VMs.\nThe default value for tag is `worker`.", + "description": "The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is `worker`.", "type": "string" } }, "type": "object" }, "WorkerPool": { - "description": "Configuration for a WorkerPool to run the builds.\n\nWorkers are machines that Cloud Build uses to run your builds. By default,\nall workers run in a project owned by Cloud Build. To have full control over\nthe workers that execute your builds -- such as enabling them to access\nprivate resources on your private network -- you can request Cloud Build to\nrun the workers in your own project by creating a custom workers pool.", + "description": "Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool.", "id": "WorkerPool", "properties": { "createTime": { - "description": "Output only. Time at which the request to create the `WorkerPool` was\nreceived.", + "description": "Output only. Time at which the request to create the `WorkerPool` was received.", "format": "google-datetime", "type": "string" }, "deleteTime": { - "description": "Output only. Time at which the request to delete the `WorkerPool` was\nreceived.", + "description": "Output only. Time at which the request to delete the `WorkerPool` was received.", "format": "google-datetime", "type": "string" }, @@ -1323,7 +1341,7 @@ "type": "string" }, "regions": { - "description": "List of regions to create the `WorkerPool`. Regions can't be empty.\nIf Cloud Build adds a new GCP region in the future, the existing\n`WorkerPool` will not be enabled in the new region automatically;\nyou must add the new region to the `regions` field to enable the\n`WorkerPool` in that region.", + "description": "List of regions to create the `WorkerPool`. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing `WorkerPool` will not be enabled in the new region automatically; you must add the new region to the `regions` field to enable the `WorkerPool` in that region.", "enumDescriptions": [ "no region", "us-central1 region", @@ -1339,12 +1357,19 @@ "us-east1", "us-east4" ], + "enumDescriptions": [ + "no region", + "us-central1 region", + "us-west1 region", + "us-east1 region", + "us-east4 region" + ], "type": "string" }, "type": "array" }, "serviceAccountEmail": { - "description": "Output only. The service account used to manage the `WorkerPool`. The\nservice account must have the Compute Instance Admin (Beta) permission at\nthe project level.", + "description": "Output only. The service account used to manage the `WorkerPool`. The service account must have the Compute Instance Admin (Beta) permission at the project level.", "type": "string" }, "status": { @@ -1366,7 +1391,7 @@ "type": "string" }, "updateTime": { - "description": "Output only. Time at which the request to update the `WorkerPool` was\nreceived.", + "description": "Output only. Time at which the request to update the `WorkerPool` was received.", "format": "google-datetime", "type": "string" }, diff --git a/discovery/cloudbuild-v1alpha2.json b/discovery/cloudbuild-v1alpha2.json index 049f50cd76..96c146d798 100644 --- a/discovery/cloudbuild-v1alpha2.json +++ b/discovery/cloudbuild-v1alpha2.json @@ -112,7 +112,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "cloudbuild.projects.locations.operations.cancel", @@ -140,7 +140,7 @@ ] }, "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "id": "cloudbuild.projects.locations.operations.get", @@ -180,14 +180,14 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource where this book will be created.\nFormat: projects/{project}", + "description": "Required. The parent resource where this book will be created. Format: projects/{project}", "location": "path", "pattern": "^projects/[^/]+$", "required": true, "type": "string" }, "workerPoolId": { - "description": "Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component\nof the resource name.\n\nThis value should be 1-63 characters, and valid characters\nare /a-z-/.", + "description": "Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/.", "location": "query", "type": "string" } @@ -213,7 +213,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the `WorkerPool` to delete.\nFormat: projects/{project}/workerPools/{workerPool}", + "description": "Required. The name of the `WorkerPool` to delete. Format: projects/{project}/workerPools/{workerPool}", "location": "path", "pattern": "^projects/[^/]+/workerPools/[^/]+$", "required": true, @@ -238,7 +238,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the `WorkerPool` to retrieve.\nFormat: projects/{project}/workerPools/{workerPool}", + "description": "Required. The name of the `WorkerPool` to retrieve. Format: projects/{project}/workerPools/{workerPool}", "location": "path", "pattern": "^projects/[^/]+/workerPools/[^/]+$", "required": true, @@ -263,7 +263,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent, which owns this collection of `WorkerPools`.\nFormat: projects/{project}", + "description": "Required. The parent, which owns this collection of `WorkerPools`. Format: projects/{project}", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -288,7 +288,7 @@ ], "parameters": { "name": { - "description": "Output only. The resource name of the `WorkerPool`.\nFormat of the name is `projects/{project_id}/workerPools/{worker_pool_id}`,\nwhere the value of {worker_pool_id} is provided in the CreateWorkerPool\nrequest.", + "description": "Output only. The resource name of the `WorkerPool`. Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`, where the value of {worker_pool_id} is provided in the CreateWorkerPool request.", "location": "path", "pattern": "^projects/[^/]+/workerPools/[^/]+$", "required": true, @@ -317,15 +317,15 @@ } } }, - "revision": "20200726", + "revision": "20200801", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ArtifactObjects": { - "description": "Files in the workspace to upload to Cloud Storage upon successful\ncompletion of all build steps.", + "description": "Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.", "id": "ArtifactObjects", "properties": { "location": { - "description": "Cloud Storage bucket and optional object path, in the form\n\"gs://bucket/path/to/somewhere/\". (see [Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\n\nFiles in the workspace matching any path pattern will be uploaded to\nCloud Storage with this location as a prefix.", + "description": "Cloud Storage bucket and optional object path, in the form \"gs://bucket/path/to/somewhere/\". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.", "type": "string" }, "paths": { @@ -343,7 +343,7 @@ "type": "object" }, "ArtifactResult": { - "description": "An artifact that was uploaded during a build. This\nis a single record in the artifact manifest JSON file.", + "description": "An artifact that was uploaded during a build. This is a single record in the artifact manifest JSON file.", "id": "ArtifactResult", "properties": { "fileHash": { @@ -354,18 +354,18 @@ "type": "array" }, "location": { - "description": "The path of an artifact in a Google Cloud Storage bucket, with the\ngeneration number. For example,\n`gs://mybucket/path/to/output.jar#generation`.", + "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`.", "type": "string" } }, "type": "object" }, "Artifacts": { - "description": "Artifacts produced by a build that should be uploaded upon\nsuccessful completion of all build steps.", + "description": "Artifacts produced by a build that should be uploaded upon successful completion of all build steps.", "id": "Artifacts", "properties": { "images": { - "description": "A list of images to be pushed upon the successful completion of all build\nsteps.\n\nThe images will be pushed using the builder service account's credentials.\n\nThe digests of the pushed images will be stored in the Build resource's\nresults field.\n\nIf any of the images fail to be pushed, the build is marked FAILURE.", + "description": "A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.", "items": { "type": "string" }, @@ -373,39 +373,43 @@ }, "objects": { "$ref": "ArtifactObjects", - "description": "A list of objects to be uploaded to Cloud Storage upon successful\ncompletion of all build steps.\n\nFiles in the workspace matching specified paths globs will be uploaded to\nthe specified Cloud Storage location using the builder service account's\ncredentials.\n\nThe location and generation of the uploaded objects will be stored in the\nBuild resource's results field.\n\nIf any objects fail to be pushed, the build is marked FAILURE." + "description": "A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE." } }, "type": "object" }, "Build": { - "description": "A build resource in the Cloud Build API.\n\nAt a high level, a `Build` describes where to find source code, how to build\nit (for example, the builder image to run on the source), and where to store\nthe built artifacts.\n\nFields can include the following variables, which will be expanded when the\nbuild is created:\n\n- $PROJECT_ID: the project ID of the build.\n- $BUILD_ID: the autogenerated ID of the build.\n- $REPO_NAME: the source repository name specified by RepoSource.\n- $BRANCH_NAME: the branch name specified by RepoSource.\n- $TAG_NAME: the tag name specified by RepoSource.\n- $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or\n resolved from the specified branch or tag.\n- $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.", + "description": "A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.", "id": "Build", "properties": { "artifacts": { "$ref": "Artifacts", - "description": "Artifacts produced by the build that should be uploaded upon\nsuccessful completion of all build steps." + "description": "Artifacts produced by the build that should be uploaded upon successful completion of all build steps." }, "buildTriggerId": { - "description": "Output only. The ID of the `BuildTrigger` that triggered this build, if it\nwas triggered automatically.", + "description": "Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.", + "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. Time at which the request to create the build was received.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "finishTime": { - "description": "Output only. Time at which execution of the build was finished.\n\nThe difference between finish_time and start_time is the duration of the\nbuild's execution.", + "description": "Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "id": { "description": "Output only. Unique identifier of the build.", + "readOnly": true, "type": "string" }, "images": { - "description": "A list of images to be pushed upon the successful completion of all build\nsteps.\n\nThe images are pushed using the builder service account's credentials.\n\nThe digests of the pushed images will be stored in the `Build` resource's\nresults field.\n\nIf any of the images fail to be pushed, the build status is marked\n`FAILURE`.", + "description": "A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`.", "items": { "type": "string" }, @@ -413,10 +417,11 @@ }, "logUrl": { "description": "Output only. URL to logs for this build in Google Cloud Console.", + "readOnly": true, "type": "string" }, "logsBucket": { - "description": "Google Cloud Storage bucket where logs should be written (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\nLogs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.", + "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`.", "type": "string" }, "options": { @@ -425,16 +430,18 @@ }, "projectId": { "description": "Output only. ID of the project.", + "readOnly": true, "type": "string" }, "queueTtl": { - "description": "TTL in queue for this build. If provided and the build is enqueued longer\nthan this value, the build will expire and the build status will be\n`EXPIRED`.\n\nThe TTL starts ticking from create_time.", + "description": "TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time.", "format": "google-duration", "type": "string" }, "results": { "$ref": "Results", - "description": "Output only. Results of the build." + "description": "Output only. Results of the build.", + "readOnly": true }, "secrets": { "description": "Secrets to decrypt using Cloud Key Management Service.", @@ -454,6 +461,7 @@ "startTime": { "description": "Output only. Time at which execution of the build was started.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "status": { @@ -508,7 +516,7 @@ "type": "array" }, "timeout": { - "description": "Amount of time that this build should be allowed to run, to second\ngranularity. If this amount of time elapses, work on the build will cease\nand the build status will be `TIMEOUT`.\n\n`timeout` starts ticking from `startTime`.\n\nDefault time is ten minutes.", + "description": "Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is ten minutes.", "format": "google-duration", "type": "string" }, @@ -516,7 +524,8 @@ "additionalProperties": { "$ref": "TimeSpan" }, - "description": "Output only. Stores timing information for phases of the build. Valid keys\nare:\n\n* BUILD: time to execute all build steps\n* PUSH: time to push all specified images.\n* FETCHSOURCE: time to fetch source.\n\nIf the build does not specify source or images,\nthese keys will not be included.", + "description": "Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included.", + "readOnly": true, "type": "object" } }, @@ -538,23 +547,23 @@ "id": "BuildOptions", "properties": { "diskSizeGb": { - "description": "Requested disk size for the VM that runs the build. Note that this is *NOT*\n\"disk free\"; some of the space will be used by the operating system and\nbuild utilities. Also note that this is the minimum disk size that will be\nallocated for the build -- the build may run with a larger disk than\nrequested. At present, the maximum disk size is 1000GB; builds that request\nmore than the maximum are rejected with an error.", + "description": "Requested disk size for the VM that runs the build. Note that this is *NOT* \"disk free\"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error.", "format": "int64", "type": "string" }, "dynamicSubstitutions": { - "description": "Option to specify whether or not to apply bash style string\noperations to the substitutions.\n\nNOTE: this is always enabled for triggered builds and cannot be\noverridden in the build configuration file.", + "description": "Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.", "type": "boolean" }, "env": { - "description": "A list of global environment variable definitions that will exist for all\nbuild steps in this build. If a variable is defined in both globally and in\na build step, the variable will use the build step value.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\".", + "description": "A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".", "items": { "type": "string" }, "type": "array" }, "logStreamingOption": { - "description": "Option to define build log streaming behavior to Google Cloud\nStorage.", + "description": "Option to define build log streaming behavior to Google Cloud Storage.", "enum": [ "STREAM_DEFAULT", "STREAM_ON", @@ -563,12 +572,12 @@ "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\nwritten when the build is completed." + "Build logs should not be streamed to Google Cloud Storage; they will be written when the build is completed." ], "type": "string" }, "logging": { - "description": "Option to specify the logging mode, which determines if and where build\nlogs are stored.", + "description": "Option to specify the logging mode, which determines if and where build logs are stored.", "enum": [ "LOGGING_UNSPECIFIED", "LEGACY", @@ -578,12 +587,12 @@ "NONE" ], "enumDescriptions": [ - "The service determines the logging mode. The default is `LEGACY`. Do not\nrely on the default logging behavior as it may change in the future.", + "The service determines the logging mode. The default is `LEGACY`. Do not rely on the default logging behavior as it may change in the future.", "Cloud Logging and Cloud Storage logging are enabled.", "Only Cloud Storage logging is enabled.", "This option is the same as CLOUD_LOGGING_ONLY.", - "Only Cloud Logging is enabled. Note that logs for both the Cloud Console\nUI and Cloud SDK are based on Cloud Storage logs, so neither will provide\nlogs if this option is chosen.", - "Turn off all logging. No build logs will be captured.\nNext ID: 6" + "Only Cloud Logging is enabled. Note that logs for both the Cloud Console UI and Cloud SDK are based on Cloud Storage logs, so neither will provide logs if this option is chosen.", + "Turn off all logging. No build logs will be captured. Next ID: 6" ], "type": "string" }, @@ -614,7 +623,7 @@ "type": "string" }, "secretEnv": { - "description": "A list of global environment variables, which are encrypted using a Cloud\nKey Management Service crypto key. These values must be specified in the\nbuild's `Secret`. These variables will be available to all build steps\nin this build.", + "description": "A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build.", "items": { "type": "string" }, @@ -633,31 +642,36 @@ "SHA256", "MD5" ], + "enumDescriptions": [ + "No hash requested.", + "Use a sha256 hash.", + "Use a md5 hash." + ], "type": "string" }, "type": "array" }, "substitutionOption": { - "description": "Option to specify behavior when there is an error in the substitution\nchecks.\n\nNOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot\nbe overridden in the build configuration file.", + "description": "Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file.", "enum": [ "MUST_MATCH", "ALLOW_LOOSE" ], "enumDescriptions": [ - "Fails the build if error in substitutions checks, like missing\na substitution in the template or in the map.", + "Fails the build if error in substitutions checks, like missing a substitution in the template or in the map.", "Do not fail the build if error in substitutions checks." ], "type": "string" }, "volumes": { - "description": "Global list of volumes to mount for ALL build steps\n\nEach volume is created as an empty volume prior to starting the build\nprocess. Upon completion of the build, volumes and their contents are\ndiscarded. Global volume names and paths cannot conflict with the volumes\ndefined a build step.\n\nUsing a global volume in a build with only one step is not valid as\nit is indicative of a build request with an incorrect configuration.", + "description": "Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.", "items": { "$ref": "Volume" }, "type": "array" }, "workerPool": { - "description": "Option to specify a `WorkerPool` for the build.\nFormat: projects/{project}/workerPools/{workerPool}\n\nThis field is experimental.", + "description": "Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is experimental.", "type": "string" } }, @@ -668,48 +682,49 @@ "id": "BuildStep", "properties": { "args": { - "description": "A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, the `args`\nare used as arguments to that entrypoint. If the image does not define\nan entrypoint, the first element in args is used as the entrypoint,\nand the remainder will be used as arguments.", + "description": "A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.", "items": { "type": "string" }, "type": "array" }, "dir": { - "description": "Working directory to use when running this step's container.\n\nIf this value is a relative path, it is relative to the build's working\ndirectory. If this value is absolute, it may be outside the build's working\ndirectory, in which case the contents of the path may not be persisted\nacross build step executions, unless a `volume` for that path is specified.\n\nIf the build specifies a `RepoSource` with `dir` and a step with a `dir`,\nwhich specifies an absolute path, the `RepoSource` `dir` is ignored for\nthe step's execution.", + "description": "Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.", "type": "string" }, "entrypoint": { - "description": "Entrypoint to be used instead of the build step image's default entrypoint.\nIf unset, the image's default entrypoint is used.", + "description": "Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.", "type": "string" }, "env": { - "description": "A list of environment variable definitions to be used when running a step.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\".", + "description": "A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".", "items": { "type": "string" }, "type": "array" }, "id": { - "description": "Unique identifier for this build step, used in `wait_for` to\nreference this build step as a dependency.", + "description": "Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.", "type": "string" }, "name": { - "description": "Required. The name of the container image that will run this particular\nbuild step.\n\nIf the image is available in the host's Docker daemon's cache, it\nwill be run directly. If not, the host will attempt to pull the image\nfirst, using the builder service account's credentials if necessary.\n\nThe Docker daemon's cache will already have the latest versions of all of\nthe officially supported build steps\n([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).\nThe Docker daemon will also have cached many of the layers for some popular\nimages, like \"ubuntu\", \"debian\", but they will be refreshed at the time you\nattempt to use them.\n\nIf you built an image in a previous build step, it will be stored in the\nhost's Docker daemon's cache and is available to use as the name for a\nlater build step.", + "description": "Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like \"ubuntu\", \"debian\", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.", "type": "string" }, "pullTiming": { "$ref": "TimeSpan", - "description": "Output only. Stores timing information for pulling this build step's\nbuilder image only." + "description": "Output only. Stores timing information for pulling this build step's builder image only.", + "readOnly": true }, "secretEnv": { - "description": "A list of environment variables which are encrypted using a Cloud Key\nManagement Service crypto key. These values must be specified in the\nbuild's `Secret`.", + "description": "A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.", "items": { "type": "string" }, "type": "array" }, "status": { - "description": "Output only. Status of the build step. At this time, build step status is\nonly updated on build completion; step status is not updated in real-time\nas the build progresses.", + "description": "Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.", "enum": [ "STATUS_UNKNOWN", "QUEUED", @@ -735,23 +750,24 @@ "type": "string" }, "timeout": { - "description": "Time limit for executing this build step. If not defined, the step has no\ntime limit and will be allowed to continue to run until either it completes\nor the build itself times out.", + "description": "Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.", "format": "google-duration", "type": "string" }, "timing": { "$ref": "TimeSpan", - "description": "Output only. Stores timing information for executing this build step." + "description": "Output only. Stores timing information for executing this build step.", + "readOnly": true }, "volumes": { - "description": "List of volumes to mount into the build step.\n\nEach volume is created as an empty volume prior to execution of the\nbuild step. Upon completion of the build, volumes and their contents are\ndiscarded.\n\nUsing a named volume in only one step is not valid as it is indicative\nof a build request with an incorrect configuration.", + "description": "List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.", "items": { "$ref": "Volume" }, "type": "array" }, "waitFor": { - "description": "The ID(s) of the step(s) that this build step depends on.\nThis build step will not start until all the build steps in `wait_for`\nhave completed successfully. If `wait_for` is empty, this build step will\nstart when all previous build steps in the `Build.Steps` list have\ncompleted successfully.", + "description": "The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.", "items": { "type": "string" }, @@ -769,12 +785,13 @@ "type": "string" }, "name": { - "description": "Name used to push the container image to Google Container Registry, as\npresented to `docker push`.", + "description": "Name used to push the container image to Google Container Registry, as presented to `docker push`.", "type": "string" }, "pushTiming": { "$ref": "TimeSpan", - "description": "Output only. Stores timing information for pushing the specified image." + "description": "Output only. Stores timing information for pushing the specified image.", + "readOnly": true } }, "type": "object" @@ -786,13 +803,13 @@ "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" }, "FileHashes": { - "description": "Container message for hashes of byte content of files, used in\nSourceProvenance messages to verify integrity of source input to the build.", + "description": "Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.", "id": "FileHashes", "properties": { "fileHash": { @@ -861,18 +878,18 @@ "id": "NetworkConfig", "properties": { "peeredNetwork": { - "description": "Required. Immutable. The network definition that the workers are peered to.\nIf this section is left empty, the workers will be peered to\nWorkerPool.project_id on the default network. Must be in the format\n`projects/{project}/global/networks/{network}`, where {project}\nis a project number, such as `12345`, and {network} is the name of a\nVPC network in the project.", + "description": "Required. Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to WorkerPool.project_id on the default network. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number, such as `12345`, and {network} is the name of a VPC network in the project.", "type": "string" } }, "type": "object" }, "Notification": { - "description": "Notification is the container which holds the data that is relevant to this\nparticular notification.", + "description": "Notification is the container which holds the data that is relevant to this particular notification.", "id": "Notification", "properties": { "filter": { - "description": "The filter string to use for notification filtering.\nCurrently, this is assumed to be a CEL program.\nSee https://opensource.google/projects/cel for more.", + "description": "The filter string to use for notification filtering. Currently, this is assumed to be a CEL program. See https://opensource.google/projects/cel for more.", "type": "string" }, "httpDelivery": { @@ -922,41 +939,41 @@ "type": "object" }, "NotifierMetadata": { - "description": "NotifierMetadata contains the data which can be used to reference or describe\nthis notifier.", + "description": "NotifierMetadata contains the data which can be used to reference or describe this notifier.", "id": "NotifierMetadata", "properties": { "name": { - "description": "The human-readable and user-given name for the notifier.\nFor example: \"repo-merge-email-notifier\".", + "description": "The human-readable and user-given name for the notifier. For example: \"repo-merge-email-notifier\".", "type": "string" }, "notifier": { - "description": "The string representing the name and version of notifier to deploy.\nExpected to be of the form of \"/:\".\nFor example: \"gcr.io/my-project/notifiers/smtp:1.2.34\".", + "description": "The string representing the name and version of notifier to deploy. Expected to be of the form of \"/:\". For example: \"gcr.io/my-project/notifiers/smtp:1.2.34\".", "type": "string" } }, "type": "object" }, "NotifierSecret": { - "description": "NotifierSecret is the container that maps a secret name (reference) to its\nGoogle Cloud Secret Manager resource path.", + "description": "NotifierSecret is the container that maps a secret name (reference) to its Google Cloud Secret Manager resource path.", "id": "NotifierSecret", "properties": { "name": { - "description": "Name is the local name of the secret, such as the verbatim string\n\"my-smtp-password\".", + "description": "Name is the local name of the secret, such as the verbatim string \"my-smtp-password\".", "type": "string" }, "value": { - "description": "Value is interpreted to be a resource path for fetching the actual\n(versioned) secret data for this secret. For example, this would be a\nGoogle Cloud Secret Manager secret version resource path like:\n\"projects/my-project/secrets/my-secret/versions/latest\".", + "description": "Value is interpreted to be a resource path for fetching the actual (versioned) secret data for this secret. For example, this would be a Google Cloud Secret Manager secret version resource path like: \"projects/my-project/secrets/my-secret/versions/latest\".", "type": "string" } }, "type": "object" }, "NotifierSecretRef": { - "description": "NotifierSecretRef contains the reference to a secret stored in the\ncorresponding NotifierSpec.", + "description": "NotifierSecretRef contains the reference to a secret stored in the corresponding NotifierSpec.", "id": "NotifierSecretRef", "properties": { "secretRef": { - "description": "The value of `secret_ref` should be a `name` that is registered in a\n`Secret` in the `secrets` list of the `Spec`.", + "description": "The value of `secret_ref` should be a `name` that is registered in a `Secret` in the `secrets` list of the `Spec`.", "type": "string" } }, @@ -981,11 +998,11 @@ "type": "object" }, "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "properties": { "done": { - "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { @@ -997,11 +1014,11 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" }, "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "response": { @@ -1009,7 +1026,7 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" } }, @@ -1020,7 +1037,7 @@ "id": "RepoSource", "properties": { "branchName": { - "description": "Regex matching branches to build.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax", + "description": "Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", "type": "string" }, "commitSha": { @@ -1028,15 +1045,15 @@ "type": "string" }, "dir": { - "description": "Directory, relative to the source root, in which to run the build.\n\nThis must be a relative path. If a step's `dir` is specified and is an\nabsolute path, this value is ignored for that step's execution.", + "description": "Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.", "type": "string" }, "invertRegex": { - "description": "Only trigger a build if the revision regex does NOT match the revision\nregex.", + "description": "Only trigger a build if the revision regex does NOT match the revision regex.", "type": "boolean" }, "projectId": { - "description": "ID of the project that owns the Cloud Source Repository. If omitted, the\nproject ID requesting the build is assumed.", + "description": "ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.", "type": "string" }, "repoName": { @@ -1047,11 +1064,11 @@ "additionalProperties": { "type": "string" }, - "description": "Substitutions to use in a triggered build.\nShould only be used with RunBuildTrigger", + "description": "Substitutions to use in a triggered build. Should only be used with RunBuildTrigger", "type": "object" }, "tagName": { - "description": "Regex matching tags to build.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax", + "description": "Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", "type": "string" } }, @@ -1070,14 +1087,14 @@ "description": "Time to push all non-container artifacts." }, "buildStepImages": { - "description": "List of build step digests, in the order corresponding to build step\nindices.", + "description": "List of build step digests, in the order corresponding to build step indices.", "items": { "type": "string" }, "type": "array" }, "buildStepOutputs": { - "description": "List of build step outputs, produced by builder images, in the order\ncorresponding to build step indices.\n\n[Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders)\ncan produce this output by writing to `$BUILDER_OUTPUT/output`.\nOnly the first 4KB of data is stored.", + "description": "List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored.", "items": { "format": "byte", "type": "string" @@ -1104,7 +1121,7 @@ "id": "SMTPDelivery", "properties": { "fromAddress": { - "description": "This is the SMTP account/email that appears in the `From:` of the email.\nIf empty, it is assumed to be sender.", + "description": "This is the SMTP account/email that appears in the `From:` of the email. If empty, it is assumed to be sender.", "type": "string" }, "password": { @@ -1116,7 +1133,7 @@ "type": "string" }, "recipientAddresses": { - "description": "This is the list of addresses to which we send the email (i.e. in the `To:`\nof the email).", + "description": "This is the list of addresses to which we send the email (i.e. in the `To:` of the email).", "items": { "type": "string" }, @@ -1134,7 +1151,7 @@ "type": "object" }, "Secret": { - "description": "Pairs a set of secret environment variables containing encrypted\nvalues with the Cloud KMS key to use to decrypt the value.", + "description": "Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value.", "id": "Secret", "properties": { "kmsKeyName": { @@ -1146,19 +1163,19 @@ "format": "byte", "type": "string" }, - "description": "Map of environment variable name to its encrypted value.\n\nSecret environment variables must be unique across all of a build's\nsecrets, and must be used by at least one build step. Values can be at most\n64 KB in size. There can be at most 100 secret values across all of a\nbuild's secrets.", + "description": "Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.", "type": "object" } }, "type": "object" }, "SlackDelivery": { - "description": "SlackDelivery is the delivery configuration for delivering Slack messages via\nwebhooks. See Slack webhook documentation at:\nhttps://api.slack.com/messaging/webhooks.", + "description": "SlackDelivery is the delivery configuration for delivering Slack messages via webhooks. See Slack webhook documentation at: https://api.slack.com/messaging/webhooks.", "id": "SlackDelivery", "properties": { "webhookUri": { "$ref": "NotifierSecretRef", - "description": "The secret reference for the Slack webhook URI for sending messages to a\nchannel." + "description": "The secret reference for the Slack webhook URI for sending messages to a channel." } }, "type": "object" @@ -1169,7 +1186,7 @@ "properties": { "repoSource": { "$ref": "RepoSource", - "description": "If provided, get the source from this location in a Cloud Source\nRepository." + "description": "If provided, get the source from this location in a Cloud Source Repository." }, "storageSource": { "$ref": "StorageSource", @@ -1179,29 +1196,30 @@ "type": "object" }, "SourceProvenance": { - "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build.", + "description": "Provenance of the source. Ways to find the original source, or verify that some source was used for this build.", "id": "SourceProvenance", "properties": { "fileHashes": { "additionalProperties": { "$ref": "FileHashes" }, - "description": "Output only. Hash(es) of the build source, which can be used to verify that\nthe original source integrity was maintained in the build. Note that\n`FileHashes` will only be populated if `BuildOptions` has requested a\n`SourceProvenanceHash`.\n\nThe keys to this map are file paths used as build source and the values\ncontain the hash values for those files.\n\nIf the build source came in a single package such as a gzipped tarfile\n(`.tar.gz`), the `FileHash` will be for the single path to that file.", + "description": "Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file.", + "readOnly": true, "type": "object" }, "resolvedRepoSource": { "$ref": "RepoSource", - "description": "A copy of the build's `source.repo_source`, if exists, with any\nrevisions resolved." + "description": "A copy of the build's `source.repo_source`, if exists, with any revisions resolved." }, "resolvedStorageSource": { "$ref": "StorageSource", - "description": "A copy of the build's `source.storage_source`, if exists, with any\ngenerations resolved." + "description": "A copy of the build's `source.storage_source`, if exists, with any generations resolved." } }, "type": "object" }, "Status": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { @@ -1210,7 +1228,7 @@ "type": "integer" }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -1221,7 +1239,7 @@ "type": "array" }, "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, @@ -1232,16 +1250,16 @@ "id": "StorageSource", "properties": { "bucket": { - "description": "Google Cloud Storage bucket containing the source (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", + "description": "Google 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\nomitted, the latest generation will be used.", + "description": "Google 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.\n\nThis object must be a gzipped archive file (`.tar.gz`) containing source to\nbuild.", + "description": "Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.", "type": "string" } }, @@ -1265,52 +1283,55 @@ "type": "object" }, "Volume": { - "description": "Volume describes a Docker container volume which is mounted into build steps\nin order to persist files across build step execution.", + "description": "Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.", "id": "Volume", "properties": { "name": { - "description": "Name of the volume to mount.\n\nVolume names must be unique per build step and must be valid names for\nDocker volumes. Each named volume must be used by at least two build steps.", + "description": "Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.", "type": "string" }, "path": { - "description": "Path at which to mount the volume.\n\nPaths must be absolute and cannot conflict with other volume paths on the\nsame build step or with certain reserved volume paths.", + "description": "Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.", "type": "string" } }, "type": "object" }, "WorkerConfig": { - "description": "WorkerConfig defines the configuration to be used for a creating workers in\nthe pool.", + "description": "WorkerConfig defines the configuration to be used for a creating workers in the pool.", "id": "WorkerConfig", "properties": { "diskSizeGb": { - "description": "Size of the disk attached to the worker, in GB.\nSee https://cloud.google.com/compute/docs/disks/\nIf `0` is specified, Cloud Build will use a standard disk size.", + "description": "Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size.", "format": "int64", "type": "string" }, "machineType": { - "description": "Machine Type of the worker, such as n1-standard-1.\nSee https://cloud.google.com/compute/docs/machine-types.\nIf left blank, Cloud Build will use a standard unspecified machine to\ncreate the worker pool.", + "description": "Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool.", "type": "string" } }, "type": "object" }, "WorkerPool": { - "description": "Configuration for a WorkerPool to run the builds.\n\nWorkers are machines that Cloud Build uses to run your builds. By default,\nall workers run in a project owned by Cloud Build. To have full control over\nthe workers that execute your builds -- such as enabling them to access\nprivate resources on your private network -- you can request Cloud Build to\nrun the workers in your own project by creating a custom workers pool.", + "description": "Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool.", "id": "WorkerPool", "properties": { "createTime": { - "description": "Output only. Time at which the request to create the `WorkerPool` was\nreceived.", + "description": "Output only. Time at which the request to create the `WorkerPool` was received.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "deleteTime": { - "description": "Output only. Time at which the request to delete the `WorkerPool` was\nreceived.", + "description": "Output only. Time at which the request to delete the `WorkerPool` was received.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "name": { - "description": "Output only. The resource name of the `WorkerPool`.\nFormat of the name is `projects/{project_id}/workerPools/{worker_pool_id}`,\nwhere the value of {worker_pool_id} is provided in the CreateWorkerPool\nrequest.", + "description": "Output only. The resource name of the `WorkerPool`. Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`, where the value of {worker_pool_id} is provided in the CreateWorkerPool request.", + "readOnly": true, "type": "string" }, "networkConfig": { @@ -1318,7 +1339,7 @@ "description": "Network configuration for the `WorkerPool`." }, "region": { - "description": "Required. Immutable. The region where the `WorkerPool` runs. Only \"us-central1\" is currently\nsupported.\n\nNote that `region` cannot be changed once the `WorkerPool` is created.", + "description": "Required. Immutable. The region where the `WorkerPool` runs. Only \"us-central1\" is currently supported. Note that `region` cannot be changed once the `WorkerPool` is created.", "type": "string" }, "state": { @@ -1337,11 +1358,13 @@ "`WorkerPool` is being deleted: cancelling builds and draining workers.", "`WorkerPool` is deleted." ], + "readOnly": true, "type": "string" }, "updateTime": { - "description": "Output only. Time at which the request to update the `WorkerPool` was\nreceived.", + "description": "Output only. Time at which the request to update the `WorkerPool` was received.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "workerConfig": { diff --git a/discovery/cloudshell-v1.json b/discovery/cloudshell-v1.json index 8234ef21ee..1b94f21c71 100644 --- a/discovery/cloudshell-v1.json +++ b/discovery/cloudshell-v1.json @@ -12,7 +12,7 @@ "baseUrl": "https://cloudshell.googleapis.com/", "batchPath": "batch", "canonicalName": "Cloud Shell", - "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n", + "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/shell/docs/", "fullyEncodeReservedExpansion": true, @@ -108,7 +108,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "flatPath": "v1/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "cloudshell.operations.cancel", @@ -136,7 +136,7 @@ ] }, "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1/operations/{operationsId}", "httpMethod": "DELETE", "id": "cloudshell.operations.delete", @@ -161,7 +161,7 @@ ] }, "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1/operations/{operationsId}", "httpMethod": "GET", "id": "cloudshell.operations.get", @@ -186,7 +186,7 @@ ] }, "list": { - "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", "flatPath": "v1/operations", "httpMethod": "GET", "id": "cloudshell.operations.list", @@ -229,7 +229,7 @@ } } }, - "revision": "20200721", + "revision": "20200803", "rootUrl": "https://cloudshell.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -239,99 +239,11 @@ "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" }, - "Environment": { - "description": "A Cloud Shell environment, which is defined as the combination of a Docker\nimage specifying what is installed on the environment and a home directory\ncontaining the user's data that will remain across sessions. Each user has a\nsingle environment with the ID \"default\".", - "id": "Environment", - "properties": { - "dockerImage": { - "description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\".", - "type": "string" - }, - "id": { - "description": "Output only. The environment's identifier, unique among the user's\nenvironments.", - "type": "string" - }, - "name": { - "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the\nemail address of the user to whom this environment belongs, and\n`{environment_id}` is the identifier of this environment. For example,\n`users/someone@example.com/environments/default`.", - "type": "string" - }, - "publicKeys": { - "description": "Output only. Public keys associated with the environment. Clients can\nconnect to this environment via SSH only if they possess a private key\ncorresponding to at least one of these public keys. Keys can be added to or\nremoved from the environment using the CreatePublicKey and DeletePublicKey\nmethods.", - "items": { - "$ref": "PublicKey" - }, - "type": "array" - }, - "size": { - "description": "Indicates the size of the backing VM running the environment. If set to\nsomething other than DEFAULT, it will be reverted to the default VM size\nafter vm_size_expire_time.", - "enum": [ - "VM_SIZE_UNSPECIFIED", - "DEFAULT", - "BOOSTED" - ], - "enumDescriptions": [ - "The VM size is unknown.", - "The default VM size.", - "The boosted VM size." - ], - "type": "string" - }, - "sshHost": { - "description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.", - "type": "string" - }, - "sshPort": { - "description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.", - "format": "int32", - "type": "integer" - }, - "sshUsername": { - "description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment.", - "type": "string" - }, - "state": { - "description": "Output only. Current execution state of this environment.", - "enum": [ - "STATE_UNSPECIFIED", - "DISABLED", - "STARTING", - "RUNNING", - "DELETING" - ], - "enumDescriptions": [ - "The environment's states is unknown.", - "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.", - "The environment is being started but is not yet ready to accept\nconnections.", - "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started.", - "The environment is being deleted and can't be connected to." - ], - "type": "string" - }, - "vmSizeExpireTime": { - "description": "Output only. The time when the Environment will expire back to the default\nVM size.", - "format": "google-datetime", - "type": "string" - }, - "webHost": { - "description": "Output only. Host to which clients can connect to initiate HTTPS or WSS\nconnections with the environment.", - "type": "string" - }, - "webPorts": { - "description": "Output only. Ports to which clients can connect to initiate HTTPS or WSS\nconnections with the environment.", - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - } - }, - "type": "object" - }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", @@ -351,11 +263,11 @@ "type": "object" }, "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "properties": { "done": { - "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { @@ -367,11 +279,11 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" }, "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "response": { @@ -379,88 +291,14 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" } }, "type": "object" }, - "PublicKey": { - "description": "A public SSH key, corresponding to a private SSH key held by the client.", - "id": "PublicKey", - "properties": { - "format": { - "description": "Required. Format of this key's content.", - "enum": [ - "FORMAT_UNSPECIFIED", - "SSH_DSS", - "SSH_RSA", - "ECDSA_SHA2_NISTP256", - "ECDSA_SHA2_NISTP384", - "ECDSA_SHA2_NISTP521" - ], - "enumDescriptions": [ - "Unknown format. Do not use.", - "`ssh-dss` key format (see RFC4253).", - "`ssh-rsa` key format (see RFC4253).", - "`ecdsa-sha2-nistp256` key format (see RFC5656).", - "`ecdsa-sha2-nistp384` key format (see RFC5656).", - "`ecdsa-sha2-nistp521` key format (see RFC5656)." - ], - "type": "string" - }, - "key": { - "description": "Required. Content of this key.", - "format": "byte", - "type": "string" - }, - "name": { - "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.\n`{owner_email}` is the email address of the user to whom the key belongs.\n`{environment_id}` is the identifier of the environment to which the key\ngrants access. `{key_id}` is the unique identifier of the key. For example,\n`users/someone@example.com/environments/default/publicKeys/myKey`.", - "type": "string" - } - }, - "type": "object" - }, - "StartEnvironmentMetadata": { - "description": "Message included in the metadata field of operations returned from\nStartEnvironment.", - "id": "StartEnvironmentMetadata", - "properties": { - "state": { - "description": "Current state of the environment being started.", - "enum": [ - "STATE_UNSPECIFIED", - "STARTING", - "UNARCHIVING_DISK", - "AWAITING_VM", - "AWAITING_COMPUTE_RESOURCES", - "FINISHED" - ], - "enumDescriptions": [ - "The environment's start state is unknown.", - "The environment is in the process of being started, but no additional\ndetails are available.", - "Startup is waiting for the user's disk to be unarchived. This can happen\nwhen the user returns to Cloud Shell after not having used it for a\nwhile, and suggests that startup will take longer than normal.", - "Startup is waiting for a VM to be assigned to the environment. This\nshould normally happen very quickly, but an environment might stay in\nthis state for an extended period of time if the system is experiencing\nheavy load.", - "Startup is waiting for compute resources to be assigned to the\nenvironment. This should normally happen very quickly, but an environment\nmight stay in this state for an extended period of time if the system is\nexperiencing heavy load.", - "Startup has completed. If the start operation was successful, the user\nshould be able to establish an SSH connection to their environment.\nOtherwise, the operation will contain details of the failure." - ], - "type": "string" - } - }, - "type": "object" - }, - "StartEnvironmentResponse": { - "description": "Message included in the response field of operations returned from\nStartEnvironment\nonce the operation is complete.", - "id": "StartEnvironmentResponse", - "properties": { - "environment": { - "$ref": "Environment", - "description": "Environment that was started." - } - }, - "type": "object" - }, "Status": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { @@ -469,7 +307,7 @@ "type": "integer" }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -480,7 +318,7 @@ "type": "array" }, "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, diff --git a/discovery/cloudshell-v1alpha1.json b/discovery/cloudshell-v1alpha1.json index 8b15384a5a..01679d1a11 100644 --- a/discovery/cloudshell-v1alpha1.json +++ b/discovery/cloudshell-v1alpha1.json @@ -12,7 +12,7 @@ "baseUrl": "https://cloudshell.googleapis.com/", "batchPath": "batch", "canonicalName": "Cloud Shell", - "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n", + "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/shell/docs/", "fullyEncodeReservedExpansion": true, @@ -110,7 +110,7 @@ "environments": { "methods": { "authorize": { - "description": "Sends OAuth credentials to a running environment on behalf of a user. When\nthis completes, the environment will be authorized to run various Google\nCloud command line tools without requiring the user to manually\nauthenticate.", + "description": "Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate.", "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}:authorize", "httpMethod": "POST", "id": "cloudshell.users.environments.authorize", @@ -119,7 +119,7 @@ ], "parameters": { "name": { - "description": "Name of the resource that should receive the credentials, for example\n`users/me/environments/default` or\n`users/someone@example.com/environments/default`.", + "description": "Name of the resource that should receive the credentials, for example `users/me/environments/default` or `users/someone@example.com/environments/default`.", "location": "path", "pattern": "^users/[^/]+/environments/[^/]+$", "required": true, @@ -147,7 +147,7 @@ ], "parameters": { "name": { - "description": "Name of the requested resource, for example `users/me/environments/default`\nor `users/someone@example.com/environments/default`.", + "description": "Name of the requested resource, for example `users/me/environments/default` or `users/someone@example.com/environments/default`.", "location": "path", "pattern": "^users/[^/]+/environments/[^/]+$", "required": true, @@ -172,7 +172,7 @@ ], "parameters": { "name": { - "description": "Name of the resource to be updated, for example\n`users/me/environments/default` or\n`users/someone@example.com/environments/default`.", + "description": "Name of the resource to be updated, for example `users/me/environments/default` or `users/someone@example.com/environments/default`.", "location": "path", "pattern": "^users/[^/]+/environments/[^/]+$", "required": true, @@ -197,7 +197,7 @@ ] }, "start": { - "description": "Starts an existing environment, allowing clients to connect to it. The\nreturned operation will contain an instance of StartEnvironmentMetadata in\nits metadata field. Users can wait for the environment to start by polling\nthis operation via GetOperation. Once the environment has finished starting\nand is ready to accept connections, the operation will contain a\nStartEnvironmentResponse in its response field.", + "description": "Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.", "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}:start", "httpMethod": "POST", "id": "cloudshell.users.environments.start", @@ -206,7 +206,7 @@ ], "parameters": { "name": { - "description": "Name of the resource that should be started, for example\n`users/me/environments/default` or\n`users/someone@example.com/environments/default`.", + "description": "Name of the resource that should be started, for example `users/me/environments/default` or `users/someone@example.com/environments/default`.", "location": "path", "pattern": "^users/[^/]+/environments/[^/]+$", "required": true, @@ -229,7 +229,7 @@ "publicKeys": { "methods": { "create": { - "description": "Adds a public SSH key to an environment, allowing clients with the\ncorresponding private key to connect to that environment via SSH. If a key\nwith the same format and content already exists, this will return the\nexisting key.", + "description": "Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same format and content already exists, this will return the existing key.", "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys", "httpMethod": "POST", "id": "cloudshell.users.environments.publicKeys.create", @@ -257,7 +257,7 @@ ] }, "delete": { - "description": "Removes a public SSH key from an environment. Clients will no longer be\nable to connect to the environment using the corresponding private key.", + "description": "Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key.", "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys/{publicKeysId}", "httpMethod": "DELETE", "id": "cloudshell.users.environments.publicKeys.delete", @@ -266,7 +266,7 @@ ], "parameters": { "name": { - "description": "Name of the resource to be deleted, e.g.\n`users/me/environments/default/publicKeys/my-key`.", + "description": "Name of the resource to be deleted, e.g. `users/me/environments/default/publicKeys/my-key`.", "location": "path", "pattern": "^users/[^/]+/environments/[^/]+/publicKeys/[^/]+$", "required": true, @@ -288,11 +288,11 @@ } } }, - "revision": "20200721", + "revision": "20200803", "rootUrl": "https://cloudshell.googleapis.com/", "schemas": { "AuthorizeEnvironmentRequest": { - "description": "Request message for\nAuthorizeEnvironment.", + "description": "Request message for AuthorizeEnvironment.", "id": "AuthorizeEnvironmentRequest", "properties": { "accessToken": { @@ -300,7 +300,7 @@ "type": "string" }, "expireTime": { - "description": "The time when the credentials expire. If not set, defaults to one hour from\nwhen the server received the request.", + "description": "The time when the credentials expire. If not set, defaults to one hour from when the server received the request.", "format": "google-datetime", "type": "string" }, @@ -312,7 +312,7 @@ "type": "object" }, "CreatePublicKeyRequest": { - "description": "Request message for\nCreatePublicKey.", + "description": "Request message for CreatePublicKey.", "id": "CreatePublicKeyRequest", "properties": { "key": { @@ -323,36 +323,36 @@ "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" }, "Environment": { - "description": "A Cloud Shell environment, which is defined as the combination of a Docker\nimage specifying what is installed on the environment and a home directory\ncontaining the user's data that will remain across sessions. Each user has a\nsingle environment with the ID \"default\".", + "description": "A Cloud Shell environment, which is defined as the combination of a Docker image specifying what is installed on the environment and a home directory containing the user's data that will remain across sessions. Each user has a single environment with the ID \"default\".", "id": "Environment", "properties": { "dockerImage": { - "description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\".", + "description": "Required. Full path to the Docker image used to run this environment, e.g. \"gcr.io/dev-con/cloud-devshell:latest\".", "type": "string" }, "id": { - "description": "Output only. The environment's identifier, unique among the user's\nenvironments.", + "description": "Output only. The environment's identifier, unique among the user's environments.", "type": "string" }, "name": { - "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the\nemail address of the user to whom this environment belongs, and\n`{environment_id}` is the identifier of this environment. For example,\n`users/someone@example.com/environments/default`.", + "description": "Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the email address of the user to whom this environment belongs, and `{environment_id}` is the identifier of this environment. For example, `users/someone@example.com/environments/default`.", "type": "string" }, "publicKeys": { - "description": "Output only. Public keys associated with the environment. Clients can\nconnect to this environment via SSH only if they possess a private key\ncorresponding to at least one of these public keys. Keys can be added to or\nremoved from the environment using the CreatePublicKey and DeletePublicKey\nmethods.", + "description": "Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the CreatePublicKey and DeletePublicKey methods.", "items": { "$ref": "PublicKey" }, "type": "array" }, "size": { - "description": "Indicates the size of the backing VM running the environment. If set to\nsomething other than DEFAULT, it will be reverted to the default VM size\nafter vm_size_expire_time.", + "description": "Indicates the size of the backing VM running the environment. If set to something other than DEFAULT, it will be reverted to the default VM size after vm_size_expire_time.", "enum": [ "VM_SIZE_UNSPECIFIED", "DEFAULT", @@ -366,16 +366,16 @@ "type": "string" }, "sshHost": { - "description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.", + "description": "Output only. Host to which clients can connect to initiate SSH sessions with the environment.", "type": "string" }, "sshPort": { - "description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.", + "description": "Output only. Port to which clients can connect to initiate SSH sessions with the environment.", "format": "int32", "type": "integer" }, "sshUsername": { - "description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment.", + "description": "Output only. Username that clients should use when initiating SSH sessions with the environment.", "type": "string" }, "state": { @@ -389,24 +389,24 @@ ], "enumDescriptions": [ "The environment's states is unknown.", - "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.", - "The environment is being started but is not yet ready to accept\nconnections.", - "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started.", + "The environment is not running and can't be connected to. Starting the environment will transition it to the STARTING state.", + "The environment is being started but is not yet ready to accept connections.", + "The environment is running and ready to accept connections. It will automatically transition back to DISABLED after a period of inactivity or if another environment is started.", "The environment is being deleted and can't be connected to." ], "type": "string" }, "vmSizeExpireTime": { - "description": "Output only. The time when the Environment will expire back to the default\nVM size.", + "description": "Output only. The time when the Environment will expire back to the default VM size.", "format": "google-datetime", "type": "string" }, "webHost": { - "description": "Output only. Host to which clients can connect to initiate HTTPS or WSS\nconnections with the environment.", + "description": "Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.", "type": "string" }, "webPorts": { - "description": "Output only. Ports to which clients can connect to initiate HTTPS or WSS\nconnections with the environment.", + "description": "Output only. Ports to which clients can connect to initiate HTTPS or WSS connections with the environment.", "items": { "format": "int32", "type": "integer" @@ -417,11 +417,11 @@ "type": "object" }, "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "properties": { "done": { - "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { @@ -433,11 +433,11 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" }, "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "response": { @@ -445,7 +445,7 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" } }, @@ -481,14 +481,14 @@ "type": "string" }, "name": { - "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.\n`{owner_email}` is the email address of the user to whom the key belongs.\n`{environment_id}` is the identifier of the environment to which the key\ngrants access. `{key_id}` is the unique identifier of the key. For example,\n`users/someone@example.com/environments/default/publicKeys/myKey`.", + "description": "Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. `{owner_email}` is the email address of the user to whom the key belongs. `{environment_id}` is the identifier of the environment to which the key grants access. `{key_id}` is the unique identifier of the key. For example, `users/someone@example.com/environments/default/publicKeys/myKey`.", "type": "string" } }, "type": "object" }, "StartEnvironmentMetadata": { - "description": "Message included in the metadata field of operations returned from\nStartEnvironment.", + "description": "Message included in the metadata field of operations returned from StartEnvironment.", "id": "StartEnvironmentMetadata", "properties": { "state": { @@ -503,11 +503,11 @@ ], "enumDescriptions": [ "The environment's start state is unknown.", - "The environment is in the process of being started, but no additional\ndetails are available.", - "Startup is waiting for the user's disk to be unarchived. This can happen\nwhen the user returns to Cloud Shell after not having used it for a\nwhile, and suggests that startup will take longer than normal.", - "Startup is waiting for a VM to be assigned to the environment. This\nshould normally happen very quickly, but an environment might stay in\nthis state for an extended period of time if the system is experiencing\nheavy load.", - "Startup is waiting for compute resources to be assigned to the\nenvironment. This should normally happen very quickly, but an environment\nmight stay in this state for an extended period of time if the system is\nexperiencing heavy load.", - "Startup has completed. If the start operation was successful, the user\nshould be able to establish an SSH connection to their environment.\nOtherwise, the operation will contain details of the failure." + "The environment is in the process of being started, but no additional details are available.", + "Startup is waiting for the user's disk to be unarchived. This can happen when the user returns to Cloud Shell after not having used it for a while, and suggests that startup will take longer than normal.", + "Startup is waiting for a VM to be assigned to the environment. This should normally happen very quickly, but an environment might stay in this state for an extended period of time if the system is experiencing heavy load.", + "Startup is waiting for compute resources to be assigned to the environment. This should normally happen very quickly, but an environment might stay in this state for an extended period of time if the system is experiencing heavy load.", + "Startup has completed. If the start operation was successful, the user should be able to establish an SSH connection to their environment. Otherwise, the operation will contain details of the failure." ], "type": "string" } @@ -515,11 +515,11 @@ "type": "object" }, "StartEnvironmentRequest": { - "description": "Request message for\nStartEnvironment.", + "description": "Request message for StartEnvironment.", "id": "StartEnvironmentRequest", "properties": { "accessToken": { - "description": "The initial access token passed to the environment. If this is present and\nvalid, the environment will be pre-authenticated with gcloud so that the\nuser can run gcloud commands in Cloud Shell without having to log in. This\ncode can be updated later by calling AuthorizeEnvironment.", + "description": "The initial access token passed to the environment. If this is present and valid, the environment will be pre-authenticated with gcloud so that the user can run gcloud commands in Cloud Shell without having to log in. This code can be updated later by calling AuthorizeEnvironment.", "type": "string" }, "publicKeys": { @@ -533,7 +533,7 @@ "type": "object" }, "StartEnvironmentResponse": { - "description": "Message included in the response field of operations returned from\nStartEnvironment\nonce the operation is complete.", + "description": "Message included in the response field of operations returned from StartEnvironment once the operation is complete.", "id": "StartEnvironmentResponse", "properties": { "environment": { @@ -544,7 +544,7 @@ "type": "object" }, "Status": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { @@ -553,7 +553,7 @@ "type": "integer" }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -564,7 +564,7 @@ "type": "array" }, "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, diff --git a/discovery/dataproc-v1beta2.json b/discovery/dataproc-v1beta2.json index cc74d6c52c..c00bef84fb 100644 --- a/discovery/dataproc-v1beta2.json +++ b/discovery/dataproc-v1beta2.json @@ -2247,7 +2247,7 @@ } } }, - "revision": "20200725", + "revision": "20200731", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2472,6 +2472,10 @@ "$ref": "InstanceGroupConfig", "description": "Optional. The Compute Engine config settings for the master instance in a cluster." }, + "metastoreConfig": { + "$ref": "MetastoreConfig", + "description": "Optional. Metastore configuration." + }, "secondaryWorkerConfig": { "$ref": "InstanceGroupConfig", "description": "Optional. The Compute Engine config settings for additional worker instances in a cluster." @@ -3603,6 +3607,17 @@ }, "type": "object" }, + "MetastoreConfig": { + "description": "Specifies the metastore configuration.", + "id": "MetastoreConfig", + "properties": { + "dataprocMetastoreService": { + "description": "Optional. Relative resource name of an existing Dataproc Metastore service.", + "type": "string" + } + }, + "type": "object" + }, "NamespacedGkeDeploymentTarget": { "description": "A full, namespace-isolated deployment target for an existing GKE cluster.", "id": "NamespacedGkeDeploymentTarget", diff --git a/discovery/displayvideo-v1.json b/discovery/displayvideo-v1.json index 4ee7e1f8e8..2245874645 100644 --- a/discovery/displayvideo-v1.json +++ b/discovery/displayvideo-v1.json @@ -5906,7 +5906,7 @@ } } }, - "revision": "20200728", + "revision": "20200804", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -11439,7 +11439,8 @@ "LINE_ITEM_TYPE_VIDEO_DEFAULT", "LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL", "LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY", - "LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY" + "LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY", + "LINE_ITEM_TYPE_AUDIO_DEFAULT" ], "enumDescriptions": [ "Type value is not specified or is unknown in this version.", @@ -11448,7 +11449,8 @@ "Video ads sold on a CPM basis for a variety of environments.", "Video ads that drive installs of an app.", "Display ads served on mobile app inventory.", - "Video ads served on mobile app inventory." + "Video ads served on mobile app inventory.", + "Rtb Audio ads sold for a variety of environments." ], "type": "string" }, diff --git a/discovery/doubleclickbidmanager-v1.1.json b/discovery/doubleclickbidmanager-v1.1.json index 19d5db2941..8d8abe6da7 100644 --- a/discovery/doubleclickbidmanager-v1.1.json +++ b/discovery/doubleclickbidmanager-v1.1.json @@ -342,9 +342,45 @@ } } }, - "revision": "20200721", + "revision": "20200731", "rootUrl": "https://www.googleapis.com/", "schemas": { + "ChannelGrouping": { + "description": "A channel grouping defines a set of rules that can be used to categorize\nevents in a path report.", + "id": "ChannelGrouping", + "properties": { + "fallbackName": { + "description": "The name to apply to an event that does not match any of the rules in the\nchannel grouping.", + "type": "string" + }, + "name": { + "description": "Channel Grouping name.", + "type": "string" + }, + "rules": { + "description": "Rules within Channel Grouping. There is a limit of 100 rules that can be\nset per channel grouping.", + "items": { + "$ref": "Rule" + }, + "type": "array" + } + }, + "type": "object" + }, + "DisjunctiveMatchStatement": { + "description": "DisjunctiveMatchStatement that OR's all contained filters.", + "id": "DisjunctiveMatchStatement", + "properties": { + "eventFilters": { + "description": "Filters. There is a limit of 100 filters that can be set per disjunctive\nmatch statement.", + "items": { + "$ref": "EventFilter" + }, + "type": "array" + } + }, + "type": "object" + }, "DownloadLineItemsRequest": { "description": "Request to fetch stored line items.", "id": "DownloadLineItemsRequest", @@ -497,6 +533,17 @@ }, "type": "object" }, + "EventFilter": { + "description": "Defines the type of filter to be applied to the path, a DV360 event dimension\nfilter.", + "id": "EventFilter", + "properties": { + "dimensionFilter": { + "$ref": "PathQueryOptionsFilter", + "description": "Filter on a dimension." + } + }, + "type": "object" + }, "FilterPair": { "description": "Filter used to match traffic data in your report.", "id": "FilterPair", @@ -761,7 +808,11 @@ "FILTER_YOUTUBE_VIDEO", "FILTER_ZIP_POSTAL_CODE", "FILTER_PLACEMENT_NAME_ALL_YOUTUBE_CHANNELS", - "FILTER_TRUEVIEW_PLACEMENT_ID" + "FILTER_TRUEVIEW_PLACEMENT_ID", + "FILTER_PATH_PATTERN_ID", + "FILTER_PATH_EVENT_INDEX", + "FILTER_EVENT_TYPE", + "FILTER_CHANNEL_GROUPING" ], "enumDescriptions": [ "", @@ -1021,6 +1072,10 @@ "", "", "", + "", + "", + "", + "", "" ], "type": "string" @@ -1083,6 +1138,10 @@ "includeOnlyTargetedUserLists": { "description": "Set to true and filter your report by `FILTER_INSERTION_ORDER` or\n`FILTER_LINE_ITEM` to include data for audience lists specifically targeted\nby those items.", "type": "boolean" + }, + "pathQueryOptions": { + "$ref": "PathQueryOptions", + "description": "Options that contain Path Filters and Custom Channel Groupings." } }, "type": "object" @@ -1358,6 +1417,10 @@ "", "", "", + "", + "", + "", + "", "" ], "items": { @@ -1619,7 +1682,11 @@ "FILTER_YOUTUBE_VIDEO", "FILTER_ZIP_POSTAL_CODE", "FILTER_PLACEMENT_NAME_ALL_YOUTUBE_CHANNELS", - "FILTER_TRUEVIEW_PLACEMENT_ID" + "FILTER_TRUEVIEW_PLACEMENT_ID", + "FILTER_PATH_PATTERN_ID", + "FILTER_PATH_EVENT_INDEX", + "FILTER_EVENT_TYPE", + "FILTER_CHANNEL_GROUPING" ], "type": "string" }, @@ -2060,6 +2127,15 @@ "", "", "", + "", + "", + "", + "", + "", + "", + "", + "", + "", "" ], "items": { @@ -2491,6 +2567,15 @@ "METRIC_VERIFIABLE_IMPRESSIONS", "METRIC_VIDEO_CLIENT_COST_ECPCV_ADVERTISER_CURRENCY", "METRIC_WATCH_TIME", + "METRIC_LAST_TOUCH_TOTAL_CONVERSIONS", + "METRIC_LAST_TOUCH_CLICK_THROUGH_CONVERSIONS", + "METRIC_LAST_TOUCH_VIEW_THROUGH_CONVERSIONS", + "METRIC_TOTAL_PATHS", + "METRIC_TOTAL_EXPOSURES", + "METRIC_EXPOSURE_CONVERSION_RATE", + "METRIC_PATH_CONVERSION_RATE", + "METRIC_CONVERTING_PATHS", + "METRIC_ACTIVITY_REVENUE", "METRIC_PERCENT_INVALID_IMPRESSIONS_PREBID", "METRIC_PROVISIONAL_IMPRESSIONS" ], @@ -2536,7 +2621,9 @@ "TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET", "TYPE_NOT_SUPPORTED", "TYPE_REACH_AUDIENCE", - "TYPE_LINEAR_TV_SEARCH_LIFT" + "TYPE_LINEAR_TV_SEARCH_LIFT", + "TYPE_PATH", + "TYPE_PATH_ATTRIBUTION" ], "enumDescriptions": [ "", @@ -2570,6 +2657,8 @@ "", "", "", + "", + "", "" ], "type": "string" @@ -2577,239 +2666,849 @@ }, "type": "object" }, - "Query": { - "description": "Represents a query.", - "id": "Query", - "properties": { - "kind": { - "description": "Identifies what kind of resource this is. Value: the fixed string\n\"doubleclickbidmanager#query\".", - "type": "string" - }, - "metadata": { - "$ref": "QueryMetadata", - "description": "Query metadata." - }, - "params": { - "$ref": "Parameters", - "description": "Query parameters." - }, - "queryId": { - "description": "Query ID.", - "format": "int64", - "type": "string" - }, - "reportDataEndTimeMs": { - "description": "The ending time for the data that is shown in the report. Note,\nreportDataEndTimeMs is required if\nmetadata.dataRange is CUSTOM_DATES and ignored\notherwise.", - "format": "int64", - "type": "string" - }, - "reportDataStartTimeMs": { - "description": "The starting time for the data that is shown in the report. Note,\nreportDataStartTimeMs is required if\nmetadata.dataRange is CUSTOM_DATES and ignored\notherwise.", - "format": "int64", - "type": "string" - }, - "schedule": { - "$ref": "QuerySchedule", - "description": "Information on how often and when to run a query." - }, - "timezoneCode": { - "description": "Canonical timezone code for report data time. Defaults to\nAmerica/New_York.", - "type": "string" - } - }, - "type": "object" - }, - "QueryMetadata": { - "description": "Query metadata.", - "id": "QueryMetadata", + "PathFilter": { + "description": "Path filters specify which paths to include in a report. A path is the result\nof combining DV360 events based on User ID to create a workflow of\nusers' actions.

When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded.", + "id": "PathFilter", "properties": { - "dataRange": { - "description": "Range of report data.", - "enum": [ - "CUSTOM_DATES", - "CURRENT_DAY", - "PREVIOUS_DAY", - "WEEK_TO_DATE", - "MONTH_TO_DATE", - "QUARTER_TO_DATE", - "YEAR_TO_DATE", - "PREVIOUS_WEEK", - "PREVIOUS_HALF_MONTH", - "PREVIOUS_MONTH", - "PREVIOUS_QUARTER", - "PREVIOUS_YEAR", - "LAST_7_DAYS", - "LAST_30_DAYS", - "LAST_90_DAYS", - "LAST_365_DAYS", - "ALL_TIME", - "LAST_14_DAYS", - "TYPE_NOT_SUPPORTED", - "LAST_60_DAYS" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" - ], - "type": "string" - }, - "format": { - "description": "Format of the generated report.", - "enum": [ - "CSV", - "EXCEL_CSV", - "XLSX" - ], - "enumDescriptions": [ - "", - "", - "" - ], - "type": "string" - }, - "googleCloudStoragePathForLatestReport": { - "description": "The path to the location in Google Cloud Storage where the latest report is\nstored.", - "type": "string" - }, - "googleDrivePathForLatestReport": { - "description": "The path in Google Drive for the latest report.", - "type": "string" - }, - "latestReportRunTimeMs": { - "description": "The time when the latest report started to run.", - "format": "int64", - "type": "string" - }, - "locale": { - "description": "Locale of the generated reports. Valid values are cs CZECH de\nGERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja\nJAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru\nRUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW\nTAIWAN_CHINESE

An locale string not in the list above will\ngenerate reports in English.", - "type": "string" - }, - "reportCount": { - "description": "Number of reports that have been generated for the query.", - "format": "int32", - "type": "integer" - }, - "running": { - "description": "Whether the latest report is currently running.", - "type": "boolean" - }, - "sendNotification": { - "description": "Whether to send an email notification when a report is ready. Default to\nfalse.", - "type": "boolean" - }, - "shareEmailAddress": { - "description": "List of email addresses which are sent email notifications when the report\nis finished. Separate from sendNotification.", + "eventFilters": { + "description": "Filter on an event to be applied to some part of the path.", "items": { - "type": "string" + "$ref": "EventFilter" }, "type": "array" }, - "title": { - "description": "Query title. It is used to name the reports generated from this query.", - "type": "string" - } - }, - "type": "object" - }, - "QuerySchedule": { - "description": "Information on how frequently and when to run a query.", - "id": "QuerySchedule", - "properties": { - "endTimeMs": { - "description": "Datetime to periodically run the query until.", - "format": "int64", - "type": "string" - }, - "frequency": { - "description": "How often the query is run.", + "pathMatchPosition": { + "description": "Indicates the position of the path the filter should match to (first, last,\nor any event in path).", "enum": [ - "ONE_TIME", - "DAILY", - "WEEKLY", - "SEMI_MONTHLY", - "MONTHLY", - "QUARTERLY" + "ANY", + "FIRST", + "LAST" ], "enumDescriptions": [ - "", - "", - "", "", "", "" ], "type": "string" - }, - "nextRunMinuteOfDay": { - "description": "Time of day at which a new report will be generated, represented as minutes\npast midnight. Range is 0 to 1439. Only applies to scheduled reports.", - "format": "int32", - "type": "integer" - }, - "nextRunTimezoneCode": { - "description": "Canonical timezone code for report generation time. Defaults to\nAmerica/New_York.", - "type": "string" - }, - "startTimeMs": { - "description": "When to start running the query. Not applicable to `ONE_TIME` frequency.", - "format": "int64", - "type": "string" } }, "type": "object" }, - "Report": { - "description": "Represents a report.", - "id": "Report", + "PathQueryOptions": { + "description": "Path Query Options for Report Options.", + "id": "PathQueryOptions", "properties": { - "key": { - "$ref": "ReportKey", - "description": "Key used to identify a report." + "channelGrouping": { + "$ref": "ChannelGrouping", + "description": "Custom Channel Groupings." }, - "metadata": { - "$ref": "ReportMetadata", - "description": "Report metadata." - }, - "params": { - "$ref": "Parameters", - "description": "Report parameters." + "pathFilters": { + "description": "Path Filters. There is a limit of 100 path filters that can be set per\nreport.", + "items": { + "$ref": "PathFilter" + }, + "type": "array" } }, "type": "object" }, - "ReportFailure": { - "description": "An explanation of a report failure.", - "id": "ReportFailure", + "PathQueryOptionsFilter": { + "description": "Dimension Filter for a Path Filter.", + "id": "PathQueryOptionsFilter", "properties": { - "errorCode": { - "description": "Error code that shows why the report was not created.", + "filter": { + "description": "Dimension the filter is applied to.", "enum": [ - "AUTHENTICATION_ERROR", - "UNAUTHORIZED_API_ACCESS", - "SERVER_ERROR", - "VALIDATION_ERROR", - "REPORTING_FATAL_ERROR", - "REPORTING_TRANSIENT_ERROR", - "REPORTING_IMCOMPATIBLE_METRICS", - "REPORTING_ILLEGAL_FILENAME", - "REPORTING_QUERY_NOT_FOUND", + "FILTER_UNKNOWN", + "FILTER_DATE", + "FILTER_DAY_OF_WEEK", + "FILTER_WEEK", + "FILTER_MONTH", + "FILTER_YEAR", + "FILTER_TIME_OF_DAY", + "FILTER_CONVERSION_DELAY", + "FILTER_CREATIVE_ID", + "FILTER_CREATIVE_SIZE", + "FILTER_CREATIVE_TYPE", + "FILTER_EXCHANGE_ID", + "FILTER_AD_POSITION", + "FILTER_PUBLIC_INVENTORY", + "FILTER_INVENTORY_SOURCE", + "FILTER_CITY", + "FILTER_REGION", + "FILTER_DMA", + "FILTER_COUNTRY", + "FILTER_SITE_ID", + "FILTER_CHANNEL_ID", + "FILTER_PARTNER", + "FILTER_ADVERTISER", + "FILTER_INSERTION_ORDER", + "FILTER_LINE_ITEM", + "FILTER_PARTNER_CURRENCY", + "FILTER_ADVERTISER_CURRENCY", + "FILTER_ADVERTISER_TIMEZONE", + "FILTER_LINE_ITEM_TYPE", + "FILTER_USER_LIST", + "FILTER_USER_LIST_FIRST_PARTY", + "FILTER_USER_LIST_THIRD_PARTY", + "FILTER_TARGETED_USER_LIST", + "FILTER_DATA_PROVIDER", + "FILTER_ORDER_ID", + "FILTER_VIDEO_PLAYER_SIZE", + "FILTER_VIDEO_DURATION_SECONDS", + "FILTER_KEYWORD", + "FILTER_PAGE_CATEGORY", + "FILTER_CAMPAIGN_DAILY_FREQUENCY", + "FILTER_LINE_ITEM_DAILY_FREQUENCY", + "FILTER_LINE_ITEM_LIFETIME_FREQUENCY", + "FILTER_OS", + "FILTER_BROWSER", + "FILTER_CARRIER", + "FILTER_SITE_LANGUAGE", + "FILTER_INVENTORY_FORMAT", + "FILTER_ZIP_CODE", + "FILTER_VIDEO_RATING_TIER", + "FILTER_VIDEO_FORMAT_SUPPORT", + "FILTER_VIDEO_SKIPPABLE_SUPPORT", + "FILTER_VIDEO_VPAID_SUPPORT", + "FILTER_VIDEO_CREATIVE_DURATION", + "FILTER_PAGE_LAYOUT", + "FILTER_VIDEO_AD_POSITION_IN_STREAM", + "FILTER_AGE", + "FILTER_GENDER", + "FILTER_QUARTER", + "FILTER_TRUEVIEW_CONVERSION_TYPE", + "FILTER_MOBILE_GEO", + "FILTER_MRAID_SUPPORT", + "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY", + "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE", + "FILTER_NIELSEN_COUNTRY_CODE", + "FILTER_NIELSEN_DEVICE_ID", + "FILTER_NIELSEN_GENDER", + "FILTER_NIELSEN_AGE", + "FILTER_INVENTORY_SOURCE_TYPE", + "FILTER_CREATIVE_WIDTH", + "FILTER_CREATIVE_HEIGHT", + "FILTER_DFP_ORDER_ID", + "FILTER_TRUEVIEW_AGE", + "FILTER_TRUEVIEW_GENDER", + "FILTER_TRUEVIEW_PARENTAL_STATUS", + "FILTER_TRUEVIEW_REMARKETING_LIST", + "FILTER_TRUEVIEW_INTEREST", + "FILTER_TRUEVIEW_AD_GROUP_ID", + "FILTER_TRUEVIEW_AD_GROUP_AD_ID", + "FILTER_TRUEVIEW_IAR_LANGUAGE", + "FILTER_TRUEVIEW_IAR_GENDER", + "FILTER_TRUEVIEW_IAR_AGE", + "FILTER_TRUEVIEW_IAR_CATEGORY", + "FILTER_TRUEVIEW_IAR_COUNTRY", + "FILTER_TRUEVIEW_IAR_CITY", + "FILTER_TRUEVIEW_IAR_REGION", + "FILTER_TRUEVIEW_IAR_ZIPCODE", + "FILTER_TRUEVIEW_IAR_REMARKETING_LIST", + "FILTER_TRUEVIEW_IAR_INTEREST", + "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS", + "FILTER_TRUEVIEW_IAR_TIME_OF_DAY", + "FILTER_TRUEVIEW_CUSTOM_AFFINITY", + "FILTER_TRUEVIEW_CATEGORY", + "FILTER_TRUEVIEW_KEYWORD", + "FILTER_TRUEVIEW_PLACEMENT", + "FILTER_TRUEVIEW_URL", + "FILTER_TRUEVIEW_COUNTRY", + "FILTER_TRUEVIEW_REGION", + "FILTER_TRUEVIEW_CITY", + "FILTER_TRUEVIEW_DMA", + "FILTER_TRUEVIEW_ZIPCODE", + "FILTER_NOT_SUPPORTED", + "FILTER_MEDIA_PLAN", + "FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL", + "FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO", + "FILTER_SKIPPABLE_SUPPORT", + "FILTER_COMPANION_CREATIVE_ID", + "FILTER_BUDGET_SEGMENT_DESCRIPTION", + "FILTER_FLOODLIGHT_ACTIVITY_ID", + "FILTER_DEVICE_MODEL", + "FILTER_DEVICE_MAKE", + "FILTER_DEVICE_TYPE", + "FILTER_CREATIVE_ATTRIBUTE", + "FILTER_INVENTORY_COMMITMENT_TYPE", + "FILTER_INVENTORY_RATE_TYPE", + "FILTER_INVENTORY_DELIVERY_METHOD", + "FILTER_INVENTORY_SOURCE_EXTERNAL_ID", + "FILTER_AUTHORIZED_SELLER_STATE", + "FILTER_VIDEO_DURATION_SECONDS_RANGE", + "FILTER_PARTNER_NAME", + "FILTER_PARTNER_STATUS", + "FILTER_ADVERTISER_NAME", + "FILTER_ADVERTISER_INTEGRATION_CODE", + "FILTER_ADVERTISER_INTEGRATION_STATUS", + "FILTER_AD_POSITION_NAME", + "FILTER_CARRIER_NAME", + "FILTER_CHANNEL_NAME", + "FILTER_CITY_NAME", + "FILTER_COMPANION_CREATIVE_NAME", + "FILTER_USER_LIST_FIRST_PARTY_NAME", + "FILTER_USER_LIST_THIRD_PARTY_NAME", + "FILTER_NIELSEN_RESTATEMENT_DATE", + "FILTER_NIELSEN_DATE_RANGE", + "FILTER_INSERTION_ORDER_NAME", + "FILTER_REGION_NAME", + "FILTER_DMA_NAME", + "FILTER_TRUEVIEW_IAR_REGION_NAME", + "FILTER_TRUEVIEW_DMA_NAME", + "FILTER_TRUEVIEW_REGION_NAME", + "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_ID", + "FILTER_ACTIVE_VIEW_CUSTOM_METRIC_NAME", + "FILTER_AD_TYPE", + "FILTER_ALGORITHM", + "FILTER_ALGORITHM_ID", + "FILTER_AMP_PAGE_REQUEST", + "FILTER_ANONYMOUS_INVENTORY_MODELING", + "FILTER_APP_URL", + "FILTER_APP_URL_EXCLUDED", + "FILTER_ATTRIBUTED_USERLIST", + "FILTER_ATTRIBUTED_USERLIST_COST", + "FILTER_ATTRIBUTED_USERLIST_TYPE", + "FILTER_ATTRIBUTION_MODEL", + "FILTER_AUDIENCE_LIST", + "FILTER_AUDIENCE_LIST_COST", + "FILTER_AUDIENCE_LIST_TYPE", + "FILTER_AUDIENCE_NAME", + "FILTER_AUDIENCE_TYPE", + "FILTER_BILLABLE_OUTCOME", + "FILTER_BRAND_LIFT_TYPE", + "FILTER_CHANNEL_TYPE", + "FILTER_CM_PLACEMENT_ID", + "FILTER_CONVERSION_SOURCE", + "FILTER_CONVERSION_SOURCE_ID", + "FILTER_COUNTRY_ID", + "FILTER_CREATIVE", + "FILTER_CREATIVE_ASSET", + "FILTER_CREATIVE_INTEGRATION_CODE", + "FILTER_CREATIVE_RENDERED_IN_AMP", + "FILTER_CREATIVE_SOURCE", + "FILTER_CREATIVE_STATUS", + "FILTER_DATA_PROVIDER_NAME", + "FILTER_DETAILED_DEMOGRAPHICS", + "FILTER_DETAILED_DEMOGRAPHICS_ID", + "FILTER_DEVICE", + "FILTER_GAM_INSERTION_ORDER", + "FILTER_GAM_LINE_ITEM", + "FILTER_GAM_LINE_ITEM_ID", + "FILTER_DIGITAL_CONTENT_LABEL", + "FILTER_DOMAIN", + "FILTER_ELIGIBLE_COOKIES_ON_FIRST_PARTY_AUDIENCE_LIST", + "FILTER_ELIGIBLE_COOKIES_ON_THIRD_PARTY_AUDIENCE_LIST_AND_INTEREST", + "FILTER_EXCHANGE", + "FILTER_EXCHANGE_CODE", + "FILTER_EXTENSION", + "FILTER_EXTENSION_STATUS", + "FILTER_EXTENSION_TYPE", + "FILTER_FIRST_PARTY_AUDIENCE_LIST_COST", + "FILTER_FIRST_PARTY_AUDIENCE_LIST_TYPE", + "FILTER_FLOODLIGHT_ACTIVITY", + "FILTER_FORMAT", + "FILTER_GMAIL_AGE", + "FILTER_GMAIL_CITY", + "FILTER_GMAIL_COUNTRY", + "FILTER_GMAIL_COUNTRY_NAME", + "FILTER_GMAIL_DEVICE_TYPE", + "FILTER_GMAIL_DEVICE_TYPE_NAME", + "FILTER_GMAIL_GENDER", + "FILTER_GMAIL_REGION", + "FILTER_GMAIL_REMARKETING_LIST", + "FILTER_HOUSEHOLD_INCOME", + "FILTER_IMPRESSION_COUNTING_METHOD", + "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_INSERTION_ORDER", + "FILTER_INSERTION_ORDER_INTEGRATION_CODE", + "FILTER_INSERTION_ORDER_STATUS", + "FILTER_INTEREST", + "FILTER_INVENTORY_SOURCE_GROUP", + "FILTER_INVENTORY_SOURCE_GROUP_ID", + "FILTER_INVENTORY_SOURCE_ID", + "FILTER_INVENTORY_SOURCE_NAME", + "FILTER_LIFE_EVENT", + "FILTER_LIFE_EVENTS", + "FILTER_LINE_ITEM_INTEGRATION_CODE", + "FILTER_LINE_ITEM_NAME", + "FILTER_LINE_ITEM_STATUS", + "FILTER_MATCH_RATIO", + "FILTER_MEASUREMENT_SOURCE", + "FILTER_MEDIA_PLAN_NAME", + "FILTER_PARENTAL_STATUS", + "FILTER_PLACEMENT_ALL_YOUTUBE_CHANNELS", + "FILTER_PLATFORM", + "FILTER_PLAYBACK_METHOD", + "FILTER_POSITION_IN_CONTENT", + "FILTER_PUBLISHER_PROPERTY", + "FILTER_PUBLISHER_PROPERTY_ID", + "FILTER_PUBLISHER_PROPERTY_SECTION", + "FILTER_PUBLISHER_PROPERTY_SECTION_ID", + "FILTER_REFUND_REASON", + "FILTER_REMARKETING_LIST", + "FILTER_REWARDED", + "FILTER_SENSITIVE_CATEGORY", + "FILTER_SERVED_PIXEL_DENSITY", + "FILTER_TARGETED_DATA_PROVIDERS", + "FILTER_THIRD_PARTY_AUDIENCE_LIST_COST", + "FILTER_THIRD_PARTY_AUDIENCE_LIST_TYPE", + "FILTER_TRUEVIEW_AD", + "FILTER_TRUEVIEW_AD_GROUP", + "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS", + "FILTER_TRUEVIEW_DETAILED_DEMOGRAPHICS_ID", + "FILTER_TRUEVIEW_HOUSEHOLD_INCOME", + "FILTER_TRUEVIEW_IAR_COUNTRY_NAME", + "FILTER_TRUEVIEW_REMARKETING_LIST_NAME", + "FILTER_VARIANT_ID", + "FILTER_VARIANT_NAME", + "FILTER_VARIANT_VERSION", + "FILTER_VERIFICATION_VIDEO_PLAYER_SIZE", + "FILTER_VERIFICATION_VIDEO_POSITION", + "FILTER_VIDEO_COMPANION_CREATIVE_SIZE", + "FILTER_VIDEO_CONTINUOUS_PLAY", + "FILTER_VIDEO_DURATION", + "FILTER_YOUTUBE_ADAPTED_AUDIENCE_LIST", + "FILTER_YOUTUBE_AD_VIDEO", + "FILTER_YOUTUBE_AD_VIDEO_ID", + "FILTER_YOUTUBE_CHANNEL", + "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_ADVERTISER", + "FILTER_YOUTUBE_PROGRAMMATIC_GUARANTEED_PARTNER", + "FILTER_YOUTUBE_VIDEO", + "FILTER_ZIP_POSTAL_CODE", + "FILTER_PLACEMENT_NAME_ALL_YOUTUBE_CHANNELS", + "FILTER_TRUEVIEW_PLACEMENT_ID", + "FILTER_PATH_PATTERN_ID", + "FILTER_PATH_EVENT_INDEX", + "FILTER_EVENT_TYPE", + "FILTER_CHANNEL_GROUPING" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "match": { + "description": "Indicates how the filter should be matched to the value.", + "enum": [ + "UNKNOWN", + "EXACT", + "PARTIAL", + "BEGINS_WITH", + "WILDCARD_EXPRESSION" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "values": { + "description": "Value to filter on.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Query": { + "description": "Represents a query.", + "id": "Query", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string\n\"doubleclickbidmanager#query\".", + "type": "string" + }, + "metadata": { + "$ref": "QueryMetadata", + "description": "Query metadata." + }, + "params": { + "$ref": "Parameters", + "description": "Query parameters." + }, + "queryId": { + "description": "Query ID.", + "format": "int64", + "type": "string" + }, + "reportDataEndTimeMs": { + "description": "The ending time for the data that is shown in the report. Note,\nreportDataEndTimeMs is required if\nmetadata.dataRange is CUSTOM_DATES and ignored\notherwise.", + "format": "int64", + "type": "string" + }, + "reportDataStartTimeMs": { + "description": "The starting time for the data that is shown in the report. Note,\nreportDataStartTimeMs is required if\nmetadata.dataRange is CUSTOM_DATES and ignored\notherwise.", + "format": "int64", + "type": "string" + }, + "schedule": { + "$ref": "QuerySchedule", + "description": "Information on how often and when to run a query." + }, + "timezoneCode": { + "description": "Canonical timezone code for report data time. Defaults to\nAmerica/New_York.", + "type": "string" + } + }, + "type": "object" + }, + "QueryMetadata": { + "description": "Query metadata.", + "id": "QueryMetadata", + "properties": { + "dataRange": { + "description": "Range of report data.", + "enum": [ + "CUSTOM_DATES", + "CURRENT_DAY", + "PREVIOUS_DAY", + "WEEK_TO_DATE", + "MONTH_TO_DATE", + "QUARTER_TO_DATE", + "YEAR_TO_DATE", + "PREVIOUS_WEEK", + "PREVIOUS_HALF_MONTH", + "PREVIOUS_MONTH", + "PREVIOUS_QUARTER", + "PREVIOUS_YEAR", + "LAST_7_DAYS", + "LAST_30_DAYS", + "LAST_90_DAYS", + "LAST_365_DAYS", + "ALL_TIME", + "LAST_14_DAYS", + "TYPE_NOT_SUPPORTED", + "LAST_60_DAYS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "format": { + "description": "Format of the generated report.", + "enum": [ + "CSV", + "EXCEL_CSV", + "XLSX" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "googleCloudStoragePathForLatestReport": { + "description": "The path to the location in Google Cloud Storage where the latest report is\nstored.", + "type": "string" + }, + "googleDrivePathForLatestReport": { + "description": "The path in Google Drive for the latest report.", + "type": "string" + }, + "latestReportRunTimeMs": { + "description": "The time when the latest report started to run.", + "format": "int64", + "type": "string" + }, + "locale": { + "description": "Locale of the generated reports. Valid values are cs CZECH de\nGERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja\nJAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru\nRUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW\nTAIWAN_CHINESE

An locale string not in the list above will\ngenerate reports in English.", + "type": "string" + }, + "reportCount": { + "description": "Number of reports that have been generated for the query.", + "format": "int32", + "type": "integer" + }, + "running": { + "description": "Whether the latest report is currently running.", + "type": "boolean" + }, + "sendNotification": { + "description": "Whether to send an email notification when a report is ready. Default to\nfalse.", + "type": "boolean" + }, + "shareEmailAddress": { + "description": "List of email addresses which are sent email notifications when the report\nis finished. Separate from sendNotification.", + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "Query title. It is used to name the reports generated from this query.", + "type": "string" + } + }, + "type": "object" + }, + "QuerySchedule": { + "description": "Information on how frequently and when to run a query.", + "id": "QuerySchedule", + "properties": { + "endTimeMs": { + "description": "Datetime to periodically run the query until.", + "format": "int64", + "type": "string" + }, + "frequency": { + "description": "How often the query is run.", + "enum": [ + "ONE_TIME", + "DAILY", + "WEEKLY", + "SEMI_MONTHLY", + "MONTHLY", + "QUARTERLY" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "nextRunMinuteOfDay": { + "description": "Time of day at which a new report will be generated, represented as minutes\npast midnight. Range is 0 to 1439. Only applies to scheduled reports.", + "format": "int32", + "type": "integer" + }, + "nextRunTimezoneCode": { + "description": "Canonical timezone code for report generation time. Defaults to\nAmerica/New_York.", + "type": "string" + }, + "startTimeMs": { + "description": "When to start running the query. Not applicable to `ONE_TIME` frequency.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Report": { + "description": "Represents a report.", + "id": "Report", + "properties": { + "key": { + "$ref": "ReportKey", + "description": "Key used to identify a report." + }, + "metadata": { + "$ref": "ReportMetadata", + "description": "Report metadata." + }, + "params": { + "$ref": "Parameters", + "description": "Report parameters." + } + }, + "type": "object" + }, + "ReportFailure": { + "description": "An explanation of a report failure.", + "id": "ReportFailure", + "properties": { + "errorCode": { + "description": "Error code that shows why the report was not created.", + "enum": [ + "AUTHENTICATION_ERROR", + "UNAUTHORIZED_API_ACCESS", + "SERVER_ERROR", + "VALIDATION_ERROR", + "REPORTING_FATAL_ERROR", + "REPORTING_TRANSIENT_ERROR", + "REPORTING_IMCOMPATIBLE_METRICS", + "REPORTING_ILLEGAL_FILENAME", + "REPORTING_QUERY_NOT_FOUND", "REPORTING_BUCKET_NOT_FOUND", "REPORTING_CREATE_BUCKET_FAILED", "REPORTING_DELETE_BUCKET_FAILED", @@ -2967,6 +3666,23 @@ }, "type": "object" }, + "Rule": { + "description": "A Rule defines a name, and a boolean expression in [conjunctive normal\nform](http:\n//mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be\n// applied to a path event to determine if that name should be applied.", + "id": "Rule", + "properties": { + "disjunctiveMatchStatements": { + "items": { + "$ref": "DisjunctiveMatchStatement" + }, + "type": "array" + }, + "name": { + "description": "Rule name.", + "type": "string" + } + }, + "type": "object" + }, "RunQueryRequest": { "description": "Request to run a stored query to generate a report.", "id": "RunQueryRequest", diff --git a/discovery/genomics-v1.json b/discovery/genomics-v1.json index a76ab24c28..4812f6fb93 100644 --- a/discovery/genomics-v1.json +++ b/discovery/genomics-v1.json @@ -110,7 +110,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation.\nThe server makes a best effort to cancel the operation, but success is not\nguaranteed. Clients may use Operations.GetOperation\nor Operations.ListOperations\nto check whether the cancellation succeeded or the operation completed\ndespite cancellation.\nAuthorization requires the following [Google IAM](https://cloud.google.com/iam) permission:\n\n* `genomics.operations.cancel`", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel`", "flatPath": "v1/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "genomics.operations.cancel", @@ -139,7 +139,7 @@ ] }, "get": { - "description": "Gets the latest state of a long-running operation.\nClients can use this method to poll the operation result at intervals as\nrecommended by the API service.\nAuthorization requires the following [Google IAM](https://cloud.google.com/iam) permission:\n\n* `genomics.operations.get`", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get`", "flatPath": "v1/operations/{operationsId}", "httpMethod": "GET", "id": "genomics.operations.get", @@ -165,7 +165,7 @@ ] }, "list": { - "description": "Lists operations that match the specified filter in the request.\nAuthorization requires the following [Google IAM](https://cloud.google.com/iam) permission:\n\n* `genomics.operations.list`", + "description": "Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list`", "flatPath": "v1/operations", "httpMethod": "GET", "id": "genomics.operations.list", @@ -174,7 +174,7 @@ ], "parameters": { "filter": { - "description": "A string for filtering Operations.\nIn v2alpha1, the following filter fields are supported:\n\n* createTime: The time this job was created\n* events: The set of event (names) that have occurred while running\n the pipeline. The : operator can be used to determine if a\n particular event has occurred.\n* error: If the pipeline is running, this value is NULL. Once the\n pipeline finishes, the value is the standard Google error code.\n* labels.key or labels.\"key with space\" where key is a label key.\n* done: If the pipeline is running, this value is false. Once the\n pipeline finishes, the value is true.\n\nIn v1 and v1alpha2, the following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime >= 1432140000`\n* `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`", + "description": "A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels.\"key with space\" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red`", "location": "query", "type": "string" }, @@ -209,7 +209,7 @@ } } }, - "revision": "20200727", + "revision": "20200804", "rootUrl": "https://genomics.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -219,7 +219,7 @@ "type": "object" }, "ComputeEngine": { - "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.", + "description": "Describes a Compute Engine resource that is being managed by a running pipeline.", "id": "ComputeEngine", "properties": { "diskNames": { @@ -245,7 +245,7 @@ "type": "object" }, "ContainerKilledEvent": { - "description": "An event generated when a container is forcibly terminated by the\nworker. Currently, this only occurs when the container outlives the\ntimeout specified by the user.", + "description": "An event generated when a container is forcibly terminated by the worker. Currently, this only occurs when the container outlives the timeout specified by the user.", "id": "ContainerKilledEvent", "properties": { "actionId": { @@ -266,7 +266,7 @@ "type": "integer" }, "ipAddress": { - "description": "The public IP address that can be used to connect to the container. This\nfield is only populated when at least one port mapping is present. If the\ninstance was created with a private address, this field will be empty even\nif port mappings exist.", + "description": "The public IP address that can be used to connect to the container. This field is only populated when at least one port mapping is present. If the instance was created with a private address, this field will be empty even if port mappings exist.", "type": "string" }, "portMappings": { @@ -274,7 +274,7 @@ "format": "int32", "type": "integer" }, - "description": "The container-to-host port mappings installed for this container. This\nset will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag\nas well as any specified in the `Action` definition.", + "description": "The container-to-host port mappings installed for this container. This set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well as any specified in the `Action` definition.", "type": "object" } }, @@ -295,22 +295,22 @@ "type": "integer" }, "stderr": { - "description": "The tail end of any content written to standard error by the container.\nIf the content emits large amounts of debugging noise or contains\nsensitive information, you can prevent the content from being printed by\nsetting the `DISABLE_STANDARD_ERROR_CAPTURE` flag.\n\nNote that only a small amount of the end of the stream is captured here.\nThe entire stream is stored in the `/google/logs` directory mounted into\neach action, and can be copied off the machine as described elsewhere.", + "description": "The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere.", "type": "string" } }, "type": "object" }, "DelayedEvent": { - "description": "An event generated whenever a resource limitation or transient error\ndelays execution of a pipeline that was otherwise ready to run.", + "description": "An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run.", "id": "DelayedEvent", "properties": { "cause": { - "description": "A textual description of the cause of the delay. The string can change\nwithout notice because it is often generated by another service (such as\nCompute Engine).", + "description": "A textual description of the cause of the delay. The string can change without notice because it is often generated by another service (such as Compute Engine).", "type": "string" }, "metrics": { - "description": "If the delay was caused by a resource shortage, this field lists the\nCompute Engine metrics that are preventing this operation from running\n(for example, `CPUS` or `INSTANCES`). If the particular metric is not\nknown, a single `UNKNOWN` metric will be present.", + "description": "If the delay was caused by a resource shortage, this field lists the Compute Engine metrics that are preventing this operation from running (for example, `CPUS` or `INSTANCES`). If the particular metric is not known, a single `UNKNOWN` metric will be present.", "items": { "type": "string" }, @@ -320,7 +320,7 @@ "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" @@ -330,7 +330,7 @@ "id": "Event", "properties": { "description": { - "description": "A human-readable description of the event. Note that these strings can\nchange at any time without notice. Any application logic must use the\ninformation in the `details` field.", + "description": "A human-readable description of the event. Note that these strings can change at any time without notice. Any application logic must use the information in the `details` field.", "type": "string" }, "details": { @@ -350,7 +350,7 @@ "type": "object" }, "FailedEvent": { - "description": "An event generated when the execution of a pipeline has failed. Note\nthat other events can continue to occur after this event.", + "description": "An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event.", "id": "FailedEvent", "properties": { "cause": { @@ -379,23 +379,23 @@ "DATA_LOSS" ], "enumDescriptions": [ - "Not an error; returned on success\n\nHTTP Mapping: 200 OK", - "The operation was cancelled, typically by the caller.\n\nHTTP Mapping: 499 Client Closed Request", - "Unknown error. For example, this error may be returned when\na `Status` value received from another address space belongs to\nan error space that is not known in this address space. Also\nerrors raised by APIs that do not return enough error information\nmay be converted to this error.\n\nHTTP Mapping: 500 Internal Server Error", - "The client specified an invalid argument. Note that this differs\nfrom `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments\nthat are problematic regardless of the state of the system\n(e.g., a malformed file name).\n\nHTTP Mapping: 400 Bad Request", - "The deadline expired before the operation could complete. For operations\nthat change the state of the system, this error may be returned\neven if the operation has completed successfully. For example, a\nsuccessful response from a server could have been delayed long\nenough for the deadline to expire.\n\nHTTP Mapping: 504 Gateway Timeout", - "Some requested entity (e.g., file or directory) was not found.\n\nNote to server developers: if a request is denied for an entire class\nof users, such as gradual feature rollout or undocumented allowlist,\n`NOT_FOUND` may be used. If a request is denied for some users within\na class of users, such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP Mapping: 404 Not Found", - "The entity that a client attempted to create (e.g., file or directory)\nalready exists.\n\nHTTP Mapping: 409 Conflict", - "The caller does not have permission to execute the specified\noperation. `PERMISSION_DENIED` must not be used for rejections\ncaused by exhausting some resource (use `RESOURCE_EXHAUSTED`\ninstead for those errors). `PERMISSION_DENIED` must not be\nused if the caller can not be identified (use `UNAUTHENTICATED`\ninstead for those errors). This error code does not imply the\nrequest is valid or the requested entity exists or satisfies\nother pre-conditions.\n\nHTTP Mapping: 403 Forbidden", - "The request does not have valid authentication credentials for the\noperation.\n\nHTTP Mapping: 401 Unauthorized", - "Some resource has been exhausted, perhaps a per-user quota, or\nperhaps the entire file system is out of space.\n\nHTTP Mapping: 429 Too Many Requests", - "The operation was rejected because the system is not in a state\nrequired for the operation's execution. For example, the directory\nto be deleted is non-empty, an rmdir operation is applied to\na non-directory, etc.\n\nService implementors can use the following guidelines to decide\nbetween `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:\n (a) Use `UNAVAILABLE` if the client can retry just the failing call.\n (b) Use `ABORTED` if the client should retry at a higher level\n (e.g., when a client-specified test-and-set fails, indicating the\n client should restart a read-modify-write sequence).\n (c) Use `FAILED_PRECONDITION` if the client should not retry until\n the system state has been explicitly fixed. E.g., if an \"rmdir\"\n fails because the directory is non-empty, `FAILED_PRECONDITION`\n should be returned since the client should not retry unless\n the files are deleted from the directory.\n\nHTTP Mapping: 400 Bad Request", - "The operation was aborted, typically due to a concurrency issue such as\na sequencer check failure or transaction abort.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 409 Conflict", - "The operation was attempted past the valid range. E.g., seeking or\nreading past end-of-file.\n\nUnlike `INVALID_ARGUMENT`, this error indicates a problem that may\nbe fixed if the system state changes. For example, a 32-bit file\nsystem will generate `INVALID_ARGUMENT` if asked to read at an\noffset that is not in the range [0,2^32-1], but it will generate\n`OUT_OF_RANGE` if asked to read from an offset past the current\nfile size.\n\nThere is a fair bit of overlap between `FAILED_PRECONDITION` and\n`OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific\nerror) when it applies so that callers who are iterating through\na space can easily look for an `OUT_OF_RANGE` error to detect when\nthey are done.\n\nHTTP Mapping: 400 Bad Request", - "The operation is not implemented or is not supported/enabled in this\nservice.\n\nHTTP Mapping: 501 Not Implemented", - "Internal errors. This means that some invariants expected by the\nunderlying system have been broken. This error code is reserved\nfor serious errors.\n\nHTTP Mapping: 500 Internal Server Error", - "The service is currently unavailable. This is most likely a\ntransient condition, which can be corrected by retrying with\na backoff. Note that it is not always safe to retry\nnon-idempotent operations.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 503 Service Unavailable", - "Unrecoverable data loss or corruption.\n\nHTTP Mapping: 500 Internal Server Error" + "Not an error; returned on success HTTP Mapping: 200 OK", + "The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request", + "Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error", + "The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request", + "The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout", + "Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found", + "The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict", + "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", + "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", + "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", + "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", + "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", + "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", + "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", + "Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error", + "The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable", + "Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error" ], "type": "string" } @@ -421,11 +421,11 @@ "type": "object" }, "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "properties": { "done": { - "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { @@ -441,7 +441,7 @@ "type": "object" }, "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`", + "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`", "type": "string" }, "response": { @@ -464,7 +464,7 @@ "type": "string" }, "endTime": { - "description": "Optional time of when event finished. An event can have a start time and no\nfinish time. If an event has a finish time, there must be a start time.", + "description": "Optional time of when event finished. An event can have a start time and no finish time. If an event has a finish time, there must be a start time.", "format": "google-datetime", "type": "string" }, @@ -481,7 +481,7 @@ "id": "OperationMetadata", "properties": { "clientId": { - "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.", + "description": "This field is deprecated. Use `labels` instead. Optionally provided by the caller when submitting the request that creates the operation.", "type": "string" }, "createTime": { @@ -495,7 +495,7 @@ "type": "string" }, "events": { - "description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.", + "description": "Optional event messages that were generated during the job's execution. This also contains any warnings that were generated during import or export.", "items": { "$ref": "OperationEvent" }, @@ -505,7 +505,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.", + "description": "Optionally provided by the caller when submitting the request that creates the operation.", "type": "object" }, "projectId": { @@ -517,7 +517,7 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.", + "description": "The original request that started the operation. Note that this will be in current version of the API. If the operation was started with v1beta2 API and a GetOperation is performed on v1 API, a v1 request will be returned.", "type": "object" }, "runtimeMetadata": { @@ -559,13 +559,13 @@ "type": "object" }, "RunPipelineResponse": { - "description": "The response to the RunPipeline method, returned in the operation's result\nfield on success.", + "description": "The response to the RunPipeline method, returned in the operation's result field on success.", "id": "RunPipelineResponse", "properties": {}, "type": "object" }, "RuntimeMetadata": { - "description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.", + "description": "Runtime metadata that will be populated in the runtimeMetadata field of the Operation associated with a RunPipeline execution.", "id": "RuntimeMetadata", "properties": { "computeEngine": { @@ -576,7 +576,7 @@ "type": "object" }, "Status": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { @@ -585,7 +585,7 @@ "type": "integer" }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -596,14 +596,14 @@ "type": "array" }, "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "type": "object" }, "UnexpectedExitStatusEvent": { - "description": "An event generated when the execution of a container results in a\nnon-zero exit status that was not otherwise ignored. Execution will\ncontinue, but only actions that are flagged as `ALWAYS_RUN` will be\nexecuted. Other actions will be skipped.", + "description": "An event generated when the execution of a container results in a non-zero exit status that was not otherwise ignored. Execution will continue, but only actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will be skipped.", "id": "UnexpectedExitStatusEvent", "properties": { "actionId": { @@ -620,7 +620,7 @@ "type": "object" }, "WorkerAssignedEvent": { - "description": "An event generated after a worker VM has been assigned to run the\npipeline.", + "description": "An event generated after a worker VM has been assigned to run the pipeline.", "id": "WorkerAssignedEvent", "properties": { "instance": { @@ -639,7 +639,7 @@ "type": "object" }, "WorkerReleasedEvent": { - "description": "An event generated when the worker VM that was assigned to the pipeline\nhas been released (deleted).", + "description": "An event generated when the worker VM that was assigned to the pipeline has been released (deleted).", "id": "WorkerReleasedEvent", "properties": { "instance": { diff --git a/discovery/genomics-v1alpha2.json b/discovery/genomics-v1alpha2.json index d26ec7294a..6d0e42103e 100644 --- a/discovery/genomics-v1alpha2.json +++ b/discovery/genomics-v1alpha2.json @@ -113,7 +113,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation.\nThe server makes a best effort to cancel the operation, but success is not\nguaranteed. Clients may use Operations.GetOperation\nor Operations.ListOperations\nto check whether the cancellation succeeded or the operation completed\ndespite cancellation.\nAuthorization requires the following [Google IAM](https://cloud.google.com/iam) permission:\n\n* `genomics.operations.cancel`", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel`", "flatPath": "v1alpha2/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "genomics.operations.cancel", @@ -142,7 +142,7 @@ ] }, "get": { - "description": "Gets the latest state of a long-running operation.\nClients can use this method to poll the operation result at intervals as\nrecommended by the API service.\nAuthorization requires the following [Google IAM](https://cloud.google.com/iam) permission:\n\n* `genomics.operations.get`", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get`", "flatPath": "v1alpha2/operations/{operationsId}", "httpMethod": "GET", "id": "genomics.operations.get", @@ -168,7 +168,7 @@ ] }, "list": { - "description": "Lists operations that match the specified filter in the request.\nAuthorization requires the following [Google IAM](https://cloud.google.com/iam) permission:\n\n* `genomics.operations.list`", + "description": "Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list`", "flatPath": "v1alpha2/operations", "httpMethod": "GET", "id": "genomics.operations.list", @@ -177,7 +177,7 @@ ], "parameters": { "filter": { - "description": "A string for filtering Operations.\nIn v2alpha1, the following filter fields are supported:\n\n* createTime: The time this job was created\n* events: The set of event (names) that have occurred while running\n the pipeline. The : operator can be used to determine if a\n particular event has occurred.\n* error: If the pipeline is running, this value is NULL. Once the\n pipeline finishes, the value is the standard Google error code.\n* labels.key or labels.\"key with space\" where key is a label key.\n* done: If the pipeline is running, this value is false. Once the\n pipeline finishes, the value is true.\n\nIn v1 and v1alpha2, the following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime >= 1432140000`\n* `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`", + "description": "A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels.\"key with space\" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red`", "location": "query", "type": "string" }, @@ -214,7 +214,7 @@ "pipelines": { "methods": { "create": { - "description": "Creates a pipeline that can be run later. Create takes a Pipeline that\nhas all fields other than `pipelineId` populated, and then returns\nthe same pipeline with `pipelineId` populated. This id can be used\nto run the pipeline.\n\nCaller must have WRITE permission to the project.", + "description": "Creates a pipeline that can be run later. Create takes a Pipeline that has all fields other than `pipelineId` populated, and then returns the same pipeline with `pipelineId` populated. This id can be used to run the pipeline. Caller must have WRITE permission to the project.", "flatPath": "v1alpha2/pipelines", "httpMethod": "POST", "id": "genomics.pipelines.create", @@ -233,7 +233,7 @@ ] }, "delete": { - "description": "Deletes a pipeline based on ID.\n\nCaller must have WRITE permission to the project.", + "description": "Deletes a pipeline based on ID. Caller must have WRITE permission to the project.", "flatPath": "v1alpha2/pipelines/{pipelineId}", "httpMethod": "DELETE", "id": "genomics.pipelines.delete", @@ -242,7 +242,7 @@ ], "parameters": { "pipelineId": { - "description": "Caller must have WRITE access to the project in which this pipeline\nis defined.", + "description": "Caller must have WRITE access to the project in which this pipeline is defined.", "location": "path", "required": true, "type": "string" @@ -258,7 +258,7 @@ ] }, "get": { - "description": "Retrieves a pipeline based on ID.\n\nCaller must have READ permission to the project.", + "description": "Retrieves a pipeline based on ID. Caller must have READ permission to the project.", "flatPath": "v1alpha2/pipelines/{pipelineId}", "httpMethod": "GET", "id": "genomics.pipelines.get", @@ -267,7 +267,7 @@ ], "parameters": { "pipelineId": { - "description": "Caller must have READ access to the project in which this pipeline\nis defined.", + "description": "Caller must have READ access to the project in which this pipeline is defined.", "location": "path", "required": true, "type": "string" @@ -283,7 +283,7 @@ ] }, "getControllerConfig": { - "description": "Gets controller configuration information. Should only be called\nby VMs created by the Pipelines Service and not by end users.", + "description": "Gets controller configuration information. Should only be called by VMs created by the Pipelines Service and not by end users.", "flatPath": "v1alpha2/pipelines:getControllerConfig", "httpMethod": "GET", "id": "genomics.pipelines.getControllerConfig", @@ -310,30 +310,30 @@ ] }, "list": { - "description": "Lists pipelines.\n\nCaller must have READ permission to the project.", + "description": "Lists pipelines. Caller must have READ permission to the project.", "flatPath": "v1alpha2/pipelines", "httpMethod": "GET", "id": "genomics.pipelines.list", "parameterOrder": [], "parameters": { "namePrefix": { - "description": "Pipelines with names that match this prefix should be\nreturned. If unspecified, all pipelines in the project, up to\n`pageSize`, will be returned.", + "description": "Pipelines with names that match this prefix should be returned. If unspecified, all pipelines in the project, up to `pageSize`, will be returned.", "location": "query", "type": "string" }, "pageSize": { - "description": "Number of pipelines to return at once. Defaults to 256, and max\nis 2048.", + "description": "Number of pipelines to return at once. Defaults to 256, and max is 2048.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Token to use to indicate where to start getting results.\nIf unspecified, returns the first page of results.", + "description": "Token to use to indicate where to start getting results. If unspecified, returns the first page of results.", "location": "query", "type": "string" }, "projectId": { - "description": "Required. The name of the project to search for pipelines. Caller\nmust have READ access to this project.", + "description": "Required. The name of the project to search for pipelines. Caller must have READ access to this project.", "location": "query", "type": "string" } @@ -348,7 +348,7 @@ ] }, "run": { - "description": "Runs a pipeline. If `pipelineId` is specified in the request, then\nrun a saved pipeline. If `ephemeralPipeline` is specified, then run\nthat pipeline once without saving a copy.\n\nThe caller must have READ permission to the project where the pipeline\nis stored and WRITE permission to the project where the pipeline will be\nrun, as VMs will be created and storage will be used.\n\nIf a pipeline operation is still running after 6 days, it will be canceled.", + "description": "Runs a pipeline. If `pipelineId` is specified in the request, then run a saved pipeline. If `ephemeralPipeline` is specified, then run that pipeline once without saving a copy. The caller must have READ permission to the project where the pipeline is stored and WRITE permission to the project where the pipeline will be run, as VMs will be created and storage will be used. If a pipeline operation is still running after 6 days, it will be canceled.", "flatPath": "v1alpha2/pipelines:run", "httpMethod": "POST", "id": "genomics.pipelines.run", @@ -368,7 +368,7 @@ ] }, "setOperationStatus": { - "description": "Sets status of a given operation. Any new timestamps (as determined by\ndescription) are appended to TimestampEvents. Should only be called by VMs\ncreated by the Pipelines Service and not by end users.", + "description": "Sets status of a given operation. Any new timestamps (as determined by description) are appended to TimestampEvents. Should only be called by VMs created by the Pipelines Service and not by end users.", "flatPath": "v1alpha2/pipelines:setOperationStatus", "httpMethod": "PUT", "id": "genomics.pipelines.setOperationStatus", @@ -389,7 +389,7 @@ } } }, - "revision": "20200727", + "revision": "20200804", "rootUrl": "https://genomics.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -399,7 +399,7 @@ "type": "object" }, "ComputeEngine": { - "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.", + "description": "Describes a Compute Engine resource that is being managed by a running pipeline.", "id": "ComputeEngine", "properties": { "diskNames": { @@ -425,7 +425,7 @@ "type": "object" }, "ContainerKilledEvent": { - "description": "An event generated when a container is forcibly terminated by the\nworker. Currently, this only occurs when the container outlives the\ntimeout specified by the user.", + "description": "An event generated when a container is forcibly terminated by the worker. Currently, this only occurs when the container outlives the timeout specified by the user.", "id": "ContainerKilledEvent", "properties": { "actionId": { @@ -446,7 +446,7 @@ "type": "integer" }, "ipAddress": { - "description": "The public IP address that can be used to connect to the container. This\nfield is only populated when at least one port mapping is present. If the\ninstance was created with a private address, this field will be empty even\nif port mappings exist.", + "description": "The public IP address that can be used to connect to the container. This field is only populated when at least one port mapping is present. If the instance was created with a private address, this field will be empty even if port mappings exist.", "type": "string" }, "portMappings": { @@ -454,7 +454,7 @@ "format": "int32", "type": "integer" }, - "description": "The container-to-host port mappings installed for this container. This\nset will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag\nas well as any specified in the `Action` definition.", + "description": "The container-to-host port mappings installed for this container. This set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well as any specified in the `Action` definition.", "type": "object" } }, @@ -475,14 +475,14 @@ "type": "integer" }, "stderr": { - "description": "The tail end of any content written to standard error by the container.\nIf the content emits large amounts of debugging noise or contains\nsensitive information, you can prevent the content from being printed by\nsetting the `DISABLE_STANDARD_ERROR_CAPTURE` flag.\n\nNote that only a small amount of the end of the stream is captured here.\nThe entire stream is stored in the `/google/logs` directory mounted into\neach action, and can be copied off the machine as described elsewhere.", + "description": "The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere.", "type": "string" } }, "type": "object" }, "ControllerConfig": { - "description": "Stores the information that the controller will fetch from the\nserver in order to run. Should only be used by VMs created by the\nPipelines Service and not by end users.", + "description": "Stores the information that the controller will fetch from the server in order to run. Should only be used by VMs created by the Pipelines Service and not by end users.", "id": "ControllerConfig", "properties": { "cmd": { @@ -525,15 +525,15 @@ "type": "object" }, "DelayedEvent": { - "description": "An event generated whenever a resource limitation or transient error\ndelays execution of a pipeline that was otherwise ready to run.", + "description": "An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run.", "id": "DelayedEvent", "properties": { "cause": { - "description": "A textual description of the cause of the delay. The string can change\nwithout notice because it is often generated by another service (such as\nCompute Engine).", + "description": "A textual description of the cause of the delay. The string can change without notice because it is often generated by another service (such as Compute Engine).", "type": "string" }, "metrics": { - "description": "If the delay was caused by a resource shortage, this field lists the\nCompute Engine metrics that are preventing this operation from running\n(for example, `CPUS` or `INSTANCES`). If the particular metric is not\nknown, a single `UNKNOWN` metric will be present.", + "description": "If the delay was caused by a resource shortage, this field lists the Compute Engine metrics that are preventing this operation from running (for example, `CPUS` or `INSTANCES`). If the particular metric is not known, a single `UNKNOWN` metric will be present.", "items": { "type": "string" }, @@ -547,28 +547,28 @@ "id": "Disk", "properties": { "autoDelete": { - "description": "Deprecated. Disks created by the Pipelines API will be deleted at the end\nof the pipeline run, regardless of what this field is set to.", + "description": "Deprecated. Disks created by the Pipelines API will be deleted at the end of the pipeline run, regardless of what this field is set to.", "type": "boolean" }, "mountPoint": { - "description": "Required at create time and cannot be overridden at run time.\nSpecifies the path in the docker container where files on\nthis disk should be located. For example, if `mountPoint`\nis `/mnt/disk`, and the parameter has `localPath`\n`inputs/file.txt`, the docker container can access the data at\n`/mnt/disk/inputs/file.txt`.", + "description": "Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.", "type": "string" }, "name": { - "description": "Required. The name of the disk that can be used in the pipeline\nparameters. Must be 1 - 63 characters.\nThe name \"boot\" is reserved for system use.", + "description": "Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name \"boot\" is reserved for system use.", "type": "string" }, "readOnly": { - "description": "Specifies how a sourced-base persistent disk will be mounted. See\nhttps://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances\nfor more details.\nCan only be set at create time.", + "description": "Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.", "type": "boolean" }, "sizeGb": { - "description": "The size of the disk. Defaults to 500 (GB).\nThis field is not applicable for local SSD.", + "description": "The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.", "format": "int32", "type": "integer" }, "source": { - "description": "The full or partial URL of the persistent disk to attach. See\nhttps://cloud.google.com/compute/docs/reference/latest/instances#resource\nand\nhttps://cloud.google.com/compute/docs/disks/persistent-disks#snapshots\nfor more details.", + "description": "The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.", "type": "string" }, "type": { @@ -581,9 +581,9 @@ ], "enumDescriptions": [ "Default disk type. Use one of the other options below.", - "Specifies a Google Compute Engine persistent hard disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.", - "Specifies a Google Compute Engine persistent solid-state disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.", - "Specifies a Google Compute Engine local SSD.\nSee https://cloud.google.com/compute/docs/disks/local-ssd for details." + "Specifies a Google Compute Engine persistent hard disk. See https://cloud.google.com/compute/docs/disks/#pdspecs for details.", + "Specifies a Google Compute Engine persistent solid-state disk. See https://cloud.google.com/compute/docs/disks/#pdspecs for details.", + "Specifies a Google Compute Engine local SSD. See https://cloud.google.com/compute/docs/disks/local-ssd for details." ], "type": "string" } @@ -595,18 +595,18 @@ "id": "DockerExecutor", "properties": { "cmd": { - "description": "Required. The command or newline delimited script to run. The command\nstring will be executed within a bash shell.\n\nIf the command exits with a non-zero exit code, output parameter\nde-localization will be skipped and the pipeline operation's\n`error` field will be populated.\n\nMaximum command string length is 16384.", + "description": "Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.", "type": "string" }, "imageName": { - "description": "Required. Image name from either Docker Hub or Google Container Registry.\nUsers that run pipelines must have READ access to the image.", + "description": "Required. Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.", "type": "string" } }, "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" @@ -616,7 +616,7 @@ "id": "Event", "properties": { "description": { - "description": "A human-readable description of the event. Note that these strings can\nchange at any time without notice. Any application logic must use the\ninformation in the `details` field.", + "description": "A human-readable description of the event. Note that these strings can change at any time without notice. Any application logic must use the information in the `details` field.", "type": "string" }, "details": { @@ -636,7 +636,7 @@ "type": "object" }, "FailedEvent": { - "description": "An event generated when the execution of a pipeline has failed. Note\nthat other events can continue to occur after this event.", + "description": "An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event.", "id": "FailedEvent", "properties": { "cause": { @@ -665,23 +665,23 @@ "DATA_LOSS" ], "enumDescriptions": [ - "Not an error; returned on success\n\nHTTP Mapping: 200 OK", - "The operation was cancelled, typically by the caller.\n\nHTTP Mapping: 499 Client Closed Request", - "Unknown error. For example, this error may be returned when\na `Status` value received from another address space belongs to\nan error space that is not known in this address space. Also\nerrors raised by APIs that do not return enough error information\nmay be converted to this error.\n\nHTTP Mapping: 500 Internal Server Error", - "The client specified an invalid argument. Note that this differs\nfrom `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments\nthat are problematic regardless of the state of the system\n(e.g., a malformed file name).\n\nHTTP Mapping: 400 Bad Request", - "The deadline expired before the operation could complete. For operations\nthat change the state of the system, this error may be returned\neven if the operation has completed successfully. For example, a\nsuccessful response from a server could have been delayed long\nenough for the deadline to expire.\n\nHTTP Mapping: 504 Gateway Timeout", - "Some requested entity (e.g., file or directory) was not found.\n\nNote to server developers: if a request is denied for an entire class\nof users, such as gradual feature rollout or undocumented allowlist,\n`NOT_FOUND` may be used. If a request is denied for some users within\na class of users, such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP Mapping: 404 Not Found", - "The entity that a client attempted to create (e.g., file or directory)\nalready exists.\n\nHTTP Mapping: 409 Conflict", - "The caller does not have permission to execute the specified\noperation. `PERMISSION_DENIED` must not be used for rejections\ncaused by exhausting some resource (use `RESOURCE_EXHAUSTED`\ninstead for those errors). `PERMISSION_DENIED` must not be\nused if the caller can not be identified (use `UNAUTHENTICATED`\ninstead for those errors). This error code does not imply the\nrequest is valid or the requested entity exists or satisfies\nother pre-conditions.\n\nHTTP Mapping: 403 Forbidden", - "The request does not have valid authentication credentials for the\noperation.\n\nHTTP Mapping: 401 Unauthorized", - "Some resource has been exhausted, perhaps a per-user quota, or\nperhaps the entire file system is out of space.\n\nHTTP Mapping: 429 Too Many Requests", - "The operation was rejected because the system is not in a state\nrequired for the operation's execution. For example, the directory\nto be deleted is non-empty, an rmdir operation is applied to\na non-directory, etc.\n\nService implementors can use the following guidelines to decide\nbetween `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:\n (a) Use `UNAVAILABLE` if the client can retry just the failing call.\n (b) Use `ABORTED` if the client should retry at a higher level\n (e.g., when a client-specified test-and-set fails, indicating the\n client should restart a read-modify-write sequence).\n (c) Use `FAILED_PRECONDITION` if the client should not retry until\n the system state has been explicitly fixed. E.g., if an \"rmdir\"\n fails because the directory is non-empty, `FAILED_PRECONDITION`\n should be returned since the client should not retry unless\n the files are deleted from the directory.\n\nHTTP Mapping: 400 Bad Request", - "The operation was aborted, typically due to a concurrency issue such as\na sequencer check failure or transaction abort.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 409 Conflict", - "The operation was attempted past the valid range. E.g., seeking or\nreading past end-of-file.\n\nUnlike `INVALID_ARGUMENT`, this error indicates a problem that may\nbe fixed if the system state changes. For example, a 32-bit file\nsystem will generate `INVALID_ARGUMENT` if asked to read at an\noffset that is not in the range [0,2^32-1], but it will generate\n`OUT_OF_RANGE` if asked to read from an offset past the current\nfile size.\n\nThere is a fair bit of overlap between `FAILED_PRECONDITION` and\n`OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific\nerror) when it applies so that callers who are iterating through\na space can easily look for an `OUT_OF_RANGE` error to detect when\nthey are done.\n\nHTTP Mapping: 400 Bad Request", - "The operation is not implemented or is not supported/enabled in this\nservice.\n\nHTTP Mapping: 501 Not Implemented", - "Internal errors. This means that some invariants expected by the\nunderlying system have been broken. This error code is reserved\nfor serious errors.\n\nHTTP Mapping: 500 Internal Server Error", - "The service is currently unavailable. This is most likely a\ntransient condition, which can be corrected by retrying with\na backoff. Note that it is not always safe to retry\nnon-idempotent operations.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 503 Service Unavailable", - "Unrecoverable data loss or corruption.\n\nHTTP Mapping: 500 Internal Server Error" + "Not an error; returned on success HTTP Mapping: 200 OK", + "The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request", + "Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error", + "The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request", + "The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout", + "Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found", + "The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict", + "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", + "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", + "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", + "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", + "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", + "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", + "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", + "Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error", + "The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable", + "Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error" ], "type": "string" } @@ -707,7 +707,7 @@ "type": "object" }, "ListPipelinesResponse": { - "description": "The response of ListPipelines. Contains at most `pageSize`\npipelines. If it contains `pageSize` pipelines, and more pipelines\nexist, then `nextPageToken` will be populated and should be\nused as the `pageToken` argument to a subsequent ListPipelines\nrequest.", + "description": "The response of ListPipelines. Contains at most `pageSize` pipelines. If it contains `pageSize` pipelines, and more pipelines exist, then `nextPageToken` will be populated and should be used as the `pageToken` argument to a subsequent ListPipelines request.", "id": "ListPipelinesResponse", "properties": { "nextPageToken": { @@ -729,11 +729,11 @@ "id": "LocalCopy", "properties": { "disk": { - "description": "Required. The name of the disk where this parameter is\nlocated. Can be the name of one of the disks specified in the\nResources field, or \"boot\", which represents the Docker\ninstance's boot disk and has a mount point of `/`.", + "description": "Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or \"boot\", which represents the Docker instance's boot disk and has a mount point of `/`.", "type": "string" }, "path": { - "description": "Required. The path within the user's docker container where\nthis input should be localized to and from, relative to the specified\ndisk's mount point. For example: file.txt,", + "description": "Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,", "type": "string" } }, @@ -744,18 +744,18 @@ "id": "LoggingOptions", "properties": { "gcsPath": { - "description": "The location in Google Cloud Storage to which the pipeline logs\nwill be copied. Can be specified as a fully qualified directory\npath, in which case logs will be output with a unique identifier\nas the filename in that directory, or as a fully specified path,\nwhich must end in `.log`, in which case that path will be\nused, and the user must ensure that logs are not\noverwritten. Stdout and stderr logs from the run are also\ngenerated and output as `-stdout.log` and `-stderr.log`.", + "description": "The location in Google Cloud Storage to which the pipeline logs will be copied. Can be specified as a fully qualified directory path, in which case logs will be output with a unique identifier as the filename in that directory, or as a fully specified path, which must end in `.log`, in which case that path will be used, and the user must ensure that logs are not overwritten. Stdout and stderr logs from the run are also generated and output as `-stdout.log` and `-stderr.log`.", "type": "string" } }, "type": "object" }, "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "properties": { "done": { - "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { @@ -771,7 +771,7 @@ "type": "object" }, "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`", + "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`", "type": "string" }, "response": { @@ -794,7 +794,7 @@ "type": "string" }, "endTime": { - "description": "Optional time of when event finished. An event can have a start time and no\nfinish time. If an event has a finish time, there must be a start time.", + "description": "Optional time of when event finished. An event can have a start time and no finish time. If an event has a finish time, there must be a start time.", "format": "google-datetime", "type": "string" }, @@ -811,7 +811,7 @@ "id": "OperationMetadata", "properties": { "clientId": { - "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.", + "description": "This field is deprecated. Use `labels` instead. Optionally provided by the caller when submitting the request that creates the operation.", "type": "string" }, "createTime": { @@ -825,7 +825,7 @@ "type": "string" }, "events": { - "description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.", + "description": "Optional event messages that were generated during the job's execution. This also contains any warnings that were generated during import or export.", "items": { "$ref": "OperationEvent" }, @@ -835,7 +835,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.", + "description": "Optionally provided by the caller when submitting the request that creates the operation.", "type": "object" }, "projectId": { @@ -847,7 +847,7 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.", + "description": "The original request that started the operation. Note that this will be in current version of the API. If the operation was started with v1beta2 API and a GetOperation is performed on v1 API, a v1 request will be returned.", "type": "object" }, "runtimeMetadata": { @@ -867,7 +867,7 @@ "type": "object" }, "Pipeline": { - "description": "The pipeline object. Represents a transformation from a set of input\nparameters to a set of output parameters. The transformation is defined\nas a docker image and command to run within that image. Each pipeline\nis run on a Google Compute Engine VM. A pipeline can be created with the\n`create` method and then later run with the `run` method, or a pipeline can\nbe defined and run all at once with the `run` method.", + "description": "The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method.", "id": "Pipeline", "properties": { "description": { @@ -886,7 +886,7 @@ "type": "array" }, "name": { - "description": "Required. A user specified pipeline name that does not have to be unique.\nThis name can be used for filtering Pipelines in ListPipelines.", + "description": "Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.", "type": "string" }, "outputParameters": { @@ -897,26 +897,26 @@ "type": "array" }, "pipelineId": { - "description": "Unique pipeline id that is generated by the service when CreatePipeline\nis called. Cannot be specified in the Pipeline used in the\nCreatePipelineRequest, and will be populated in the response to\nCreatePipeline and all subsequent Get and List calls. Indicates that the\nservice has registered this pipeline.", + "description": "Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.", "type": "string" }, "projectId": { - "description": "Required. The project in which to create the pipeline. The caller must have\nWRITE access.", + "description": "Required. The project in which to create the pipeline. The caller must have WRITE access.", "type": "string" }, "resources": { "$ref": "PipelineResources", - "description": "Required. Specifies resource requirements for the pipeline run.\nRequired fields:\n\n*\nminimumCpuCores\n\n*\nminimumRamGb" + "description": "Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb" } }, "type": "object" }, "PipelineParameter": { - "description": "Parameters facilitate setting and delivering data into the\npipeline's execution environment. They are defined at create time,\nwith optional defaults, and can be overridden at run time.\n\nIf `localCopy` is unset, then the parameter specifies a string that\nis passed as-is into the pipeline, as the value of the environment\nvariable with the given name. A default value can be optionally\nspecified at create time. The default can be overridden at run time\nusing the inputs map. If no default is given, a value must be\nsupplied at runtime.\n\nIf `localCopy` is defined, then the parameter specifies a data\nsource or sink, both in Google Cloud Storage and on the Docker container\nwhere the pipeline computation is run. The service account associated with\nthe Pipeline (by\ndefault the project's Compute Engine service account) must have access to the\nGoogle Cloud Storage paths.\n\nAt run time, the Google Cloud Storage paths can be overridden if a default\nwas provided at create time, or must be set otherwise. The pipeline runner\nshould add a key/value pair to either the inputs or outputs map. The\nindicated data copies will be carried out before/after pipeline execution,\njust as if the corresponding arguments were provided to `gsutil cp`.\n\nFor example: Given the following `PipelineParameter`, specified\nin the `inputParameters` list:\n\n```\n{name: \"input_file\", localCopy: {path: \"file.txt\", disk: \"pd1\"}}\n```\n\nwhere `disk` is defined in the `PipelineResources` object as:\n\n```\n{name: \"pd1\", mountPoint: \"/mnt/disk/\"}\n```\n\nWe create a disk named `pd1`, mount it on the host VM, and map\n`/mnt/pd1` to `/mnt/disk` in the docker container. At\nruntime, an entry for `input_file` would be required in the inputs\nmap, such as:\n\n```\n inputs[\"input_file\"] = \"gs://my-bucket/bar.txt\"\n```\n\nThis would generate the following gsutil call:\n\n```\n gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt\n```\n\nThe file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the\nDocker container. Acceptable paths are:\n\n\n \n \n \n \n \n \n \n
Google Cloud storage pathLocal path
filefile
globdirectory
\n\nFor outputs, the direction of the copy is reversed:\n\n```\n gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt\n```\n\nAcceptable paths are:\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n
Local pathGoogle Cloud Storage path
filefile
filedirectory - directory must already exist
globdirectory - directory will be created if it doesn't exist
\n\nOne restriction due to docker limitations, is that for outputs that are found\non the boot disk, the local path cannot be a glob and must be a file.", + "description": "Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: \"input_file\", localCopy: {path: \"file.txt\", disk: \"pd1\"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: \"pd1\", mountPoint: \"/mnt/disk/\"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs[\"input_file\"] = \"gs://my-bucket/bar.txt\" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path file file glob directory For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are: Local pathGoogle Cloud Storage path file file file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.", "id": "PipelineParameter", "properties": { "defaultValue": { - "description": "The default value for this parameter. Can be overridden at runtime.\nIf `localCopy` is present, then this must be a Google Cloud Storage path\nbeginning with `gs://`.", + "description": "The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.", "type": "string" }, "description": { @@ -925,10 +925,10 @@ }, "localCopy": { "$ref": "LocalCopy", - "description": "If present, this parameter is marked for copying to and from the VM.\n`LocalCopy` indicates where on the VM the file should be. The value\ngiven to this parameter (either at runtime or using `defaultValue`)\nmust be the remote path where the file should be." + "description": "If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be." }, "name": { - "description": "Required. Name of the parameter - the pipeline runner uses this string\nas the key to the input and output maps in RunPipeline.", + "description": "Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.", "type": "string" } }, @@ -939,12 +939,12 @@ "id": "PipelineResources", "properties": { "acceleratorCount": { - "description": "Optional. The number of accelerators of the specified type to attach.\nBy specifying this parameter, you will download and install the following\nthird-party software onto your managed Compute Engine instances:\nNVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit.", + "description": "Optional. The number of accelerators of the specified type to attach. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit.", "format": "int64", "type": "string" }, "acceleratorType": { - "description": "Optional. The Compute Engine defined accelerator type.\nBy specifying this parameter, you will download and install the following\nthird-party software onto your managed Compute Engine instances: NVIDIA®\nTesla® drivers and NVIDIA® CUDA toolkit.\nPlease see https://cloud.google.com/compute/docs/gpus/ for a list of\navailable accelerator types.", + "description": "Optional. The Compute Engine defined accelerator type. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit. Please see https://cloud.google.com/compute/docs/gpus/ for a list of available accelerator types.", "type": "string" }, "bootDiskSizeGb": { @@ -970,15 +970,15 @@ "type": "number" }, "noAddress": { - "description": "Whether to assign an external IP to the instance. This is an experimental\nfeature that may go away. Defaults to false.\nCorresponds to `--no_address` flag for [gcloud compute instances create]\n(https://cloud.google.com/sdk/gcloud/reference/compute/instances/create).\nIn order to use this, must be true for both create time and run time.\nCannot be true at run time if false at create time. If you need to ssh into\na private IP VM for debugging, you can ssh to a public VM and then ssh into\nthe private VM's Internal IP. If noAddress is set, this pipeline run may\nonly load docker images from Google Container Registry and not Docker Hub.\nBefore using this, you must\n[configure access to Google services from internal\nIPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).", + "description": "Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. Before using this, you must [configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).", "type": "boolean" }, "preemptible": { - "description": "Whether to use preemptible VMs. Defaults to `false`. In order to use this,\nmust be true for both create time and run time. Cannot be true at run time\nif false at create time.", + "description": "Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.", "type": "boolean" }, "zones": { - "description": "List of Google Compute Engine availability zones to which resource\ncreation will restricted. If empty, any zone may be chosen.", + "description": "List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.", "items": { "type": "string" }, @@ -1026,18 +1026,18 @@ "id": "RunPipelineArgs", "properties": { "clientId": { - "description": "This field is deprecated. Use `labels` instead. Client-specified pipeline\noperation identifier.", + "description": "This field is deprecated. Use `labels` instead. Client-specified pipeline operation identifier.", "type": "string" }, "inputs": { "additionalProperties": { "type": "string" }, - "description": "Pipeline input arguments; keys are defined in the pipeline documentation.\nAll input parameters that do not have default values must be specified.\nIf parameters with defaults are specified here, the defaults will be\noverridden.", + "description": "Pipeline input arguments; keys are defined in the pipeline documentation. All input parameters that do not have default values must be specified. If parameters with defaults are specified here, the defaults will be overridden.", "type": "object" }, "keepVmAliveOnFailureDuration": { - "description": "How long to keep the VM up after a failure (for example docker command\nfailed, copying input or output files failed, etc). While the VM is up, one\ncan ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.", + "description": "How long to keep the VM up after a failure (for example docker command failed, copying input or output files failed, etc). While the VM is up, one can ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.", "format": "google-duration", "type": "string" }, @@ -1045,22 +1045,22 @@ "additionalProperties": { "type": "string" }, - "description": "Labels to apply to this pipeline run. Labels will also be applied to\ncompute resources (VM, disks) created by this pipeline run. When listing\noperations, operations can filtered by labels.\nLabel keys may not be empty; label values may be empty. Non-empty labels\nmust be 1-63 characters long, and comply with [RFC1035]\n(https://www.ietf.org/rfc/rfc1035.txt).\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.", + "description": "Labels to apply to this pipeline run. Labels will also be applied to compute resources (VM, disks) created by this pipeline run. When listing operations, operations can filtered by labels. Label keys may not be empty; label values may be empty. Non-empty labels must be 1-63 characters long, and comply with [RFC1035] (https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "type": "object" }, "logging": { "$ref": "LoggingOptions", - "description": "Required. Logging options. Used by the service to communicate results\nto the user." + "description": "Required. Logging options. Used by the service to communicate results to the user." }, "outputs": { "additionalProperties": { "type": "string" }, - "description": "Pipeline output arguments; keys are defined in the pipeline\ndocumentation. All output parameters of without default values\nmust be specified. If parameters with defaults are specified\nhere, the defaults will be overridden.", + "description": "Pipeline output arguments; keys are defined in the pipeline documentation. All output parameters of without default values must be specified. If parameters with defaults are specified here, the defaults will be overridden.", "type": "object" }, "projectId": { - "description": "Required. The project in which to run the pipeline. The caller must have\nWRITER access to all Google Cloud services and resources (e.g. Google\nCompute Engine) will be used.", + "description": "Required. The project in which to run the pipeline. The caller must have WRITER access to all Google Cloud services and resources (e.g. Google Compute Engine) will be used.", "type": "string" }, "resources": { @@ -1069,13 +1069,13 @@ }, "serviceAccount": { "$ref": "ServiceAccount", - "description": "The Google Cloud Service Account that will be used to access data and\nservices. By default, the compute service account associated with\n`projectId` is used." + "description": "The Google Cloud Service Account that will be used to access data and services. By default, the compute service account associated with `projectId` is used." } }, "type": "object" }, "RunPipelineRequest": { - "description": "The request to run a pipeline. If `pipelineId` is specified, it\nrefers to a saved pipeline created with CreatePipeline and set as\nthe `pipelineId` of the returned Pipeline object. If\n`ephemeralPipeline` is specified, that pipeline is run once\nwith the given args and not saved. It is an error to specify both\n`pipelineId` and `ephemeralPipeline`. `pipelineArgs`\nmust be specified.", + "description": "The request to run a pipeline. If `pipelineId` is specified, it refers to a saved pipeline created with CreatePipeline and set as the `pipelineId` of the returned Pipeline object. If `ephemeralPipeline` is specified, that pipeline is run once with the given args and not saved. It is an error to specify both `pipelineId` and `ephemeralPipeline`. `pipelineArgs` must be specified.", "id": "RunPipelineRequest", "properties": { "ephemeralPipeline": { @@ -1094,13 +1094,13 @@ "type": "object" }, "RunPipelineResponse": { - "description": "The response to the RunPipeline method, returned in the operation's result\nfield on success.", + "description": "The response to the RunPipeline method, returned in the operation's result field on success.", "id": "RunPipelineResponse", "properties": {}, "type": "object" }, "RuntimeMetadata": { - "description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.", + "description": "Runtime metadata that will be populated in the runtimeMetadata field of the Operation associated with a RunPipeline execution.", "id": "RuntimeMetadata", "properties": { "computeEngine": { @@ -1115,11 +1115,11 @@ "id": "ServiceAccount", "properties": { "email": { - "description": "Email address of the service account. Defaults to `default`,\nwhich uses the compute service account associated with the project.", + "description": "Email address of the service account. Defaults to `default`, which uses the compute service account associated with the project.", "type": "string" }, "scopes": { - "description": "List of scopes to be enabled for this service account on the VM.\nThe following scopes are automatically included:\n\n* https://www.googleapis.com/auth/compute\n* https://www.googleapis.com/auth/devstorage.full_control\n* https://www.googleapis.com/auth/genomics\n* https://www.googleapis.com/auth/logging.write\n* https://www.googleapis.com/auth/monitoring.write", + "description": "List of scopes to be enabled for this service account on the VM. The following scopes are automatically included: * https://www.googleapis.com/auth/compute * https://www.googleapis.com/auth/devstorage.full_control * https://www.googleapis.com/auth/genomics * https://www.googleapis.com/auth/logging.write * https://www.googleapis.com/auth/monitoring.write", "items": { "type": "string" }, @@ -1129,7 +1129,7 @@ "type": "object" }, "SetOperationStatusRequest": { - "description": "Request to set operation status. Should only be used by VMs\ncreated by the Pipelines Service and not by end users.", + "description": "Request to set operation status. Should only be used by VMs created by the Pipelines Service and not by end users.", "id": "SetOperationStatusRequest", "properties": { "errorCode": { @@ -1153,23 +1153,23 @@ "DATA_LOSS" ], "enumDescriptions": [ - "Not an error; returned on success\n\nHTTP Mapping: 200 OK", - "The operation was cancelled, typically by the caller.\n\nHTTP Mapping: 499 Client Closed Request", - "Unknown error. For example, this error may be returned when\na `Status` value received from another address space belongs to\nan error space that is not known in this address space. Also\nerrors raised by APIs that do not return enough error information\nmay be converted to this error.\n\nHTTP Mapping: 500 Internal Server Error", - "The client specified an invalid argument. Note that this differs\nfrom `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments\nthat are problematic regardless of the state of the system\n(e.g., a malformed file name).\n\nHTTP Mapping: 400 Bad Request", - "The deadline expired before the operation could complete. For operations\nthat change the state of the system, this error may be returned\neven if the operation has completed successfully. For example, a\nsuccessful response from a server could have been delayed long\nenough for the deadline to expire.\n\nHTTP Mapping: 504 Gateway Timeout", - "Some requested entity (e.g., file or directory) was not found.\n\nNote to server developers: if a request is denied for an entire class\nof users, such as gradual feature rollout or undocumented allowlist,\n`NOT_FOUND` may be used. If a request is denied for some users within\na class of users, such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP Mapping: 404 Not Found", - "The entity that a client attempted to create (e.g., file or directory)\nalready exists.\n\nHTTP Mapping: 409 Conflict", - "The caller does not have permission to execute the specified\noperation. `PERMISSION_DENIED` must not be used for rejections\ncaused by exhausting some resource (use `RESOURCE_EXHAUSTED`\ninstead for those errors). `PERMISSION_DENIED` must not be\nused if the caller can not be identified (use `UNAUTHENTICATED`\ninstead for those errors). This error code does not imply the\nrequest is valid or the requested entity exists or satisfies\nother pre-conditions.\n\nHTTP Mapping: 403 Forbidden", - "The request does not have valid authentication credentials for the\noperation.\n\nHTTP Mapping: 401 Unauthorized", - "Some resource has been exhausted, perhaps a per-user quota, or\nperhaps the entire file system is out of space.\n\nHTTP Mapping: 429 Too Many Requests", - "The operation was rejected because the system is not in a state\nrequired for the operation's execution. For example, the directory\nto be deleted is non-empty, an rmdir operation is applied to\na non-directory, etc.\n\nService implementors can use the following guidelines to decide\nbetween `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:\n (a) Use `UNAVAILABLE` if the client can retry just the failing call.\n (b) Use `ABORTED` if the client should retry at a higher level\n (e.g., when a client-specified test-and-set fails, indicating the\n client should restart a read-modify-write sequence).\n (c) Use `FAILED_PRECONDITION` if the client should not retry until\n the system state has been explicitly fixed. E.g., if an \"rmdir\"\n fails because the directory is non-empty, `FAILED_PRECONDITION`\n should be returned since the client should not retry unless\n the files are deleted from the directory.\n\nHTTP Mapping: 400 Bad Request", - "The operation was aborted, typically due to a concurrency issue such as\na sequencer check failure or transaction abort.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 409 Conflict", - "The operation was attempted past the valid range. E.g., seeking or\nreading past end-of-file.\n\nUnlike `INVALID_ARGUMENT`, this error indicates a problem that may\nbe fixed if the system state changes. For example, a 32-bit file\nsystem will generate `INVALID_ARGUMENT` if asked to read at an\noffset that is not in the range [0,2^32-1], but it will generate\n`OUT_OF_RANGE` if asked to read from an offset past the current\nfile size.\n\nThere is a fair bit of overlap between `FAILED_PRECONDITION` and\n`OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific\nerror) when it applies so that callers who are iterating through\na space can easily look for an `OUT_OF_RANGE` error to detect when\nthey are done.\n\nHTTP Mapping: 400 Bad Request", - "The operation is not implemented or is not supported/enabled in this\nservice.\n\nHTTP Mapping: 501 Not Implemented", - "Internal errors. This means that some invariants expected by the\nunderlying system have been broken. This error code is reserved\nfor serious errors.\n\nHTTP Mapping: 500 Internal Server Error", - "The service is currently unavailable. This is most likely a\ntransient condition, which can be corrected by retrying with\na backoff. Note that it is not always safe to retry\nnon-idempotent operations.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 503 Service Unavailable", - "Unrecoverable data loss or corruption.\n\nHTTP Mapping: 500 Internal Server Error" + "Not an error; returned on success HTTP Mapping: 200 OK", + "The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request", + "Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error", + "The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request", + "The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout", + "Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found", + "The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict", + "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", + "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", + "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", + "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", + "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", + "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", + "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", + "Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error", + "The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable", + "Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error" ], "type": "string" }, @@ -1193,7 +1193,7 @@ "type": "object" }, "Status": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { @@ -1202,7 +1202,7 @@ "type": "integer" }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -1213,14 +1213,14 @@ "type": "array" }, "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "type": "object" }, "TimestampEvent": { - "description": "Stores the list of events and times they occured for major events in job\nexecution.", + "description": "Stores the list of events and times they occured for major events in job execution.", "id": "TimestampEvent", "properties": { "description": { @@ -1236,7 +1236,7 @@ "type": "object" }, "UnexpectedExitStatusEvent": { - "description": "An event generated when the execution of a container results in a\nnon-zero exit status that was not otherwise ignored. Execution will\ncontinue, but only actions that are flagged as `ALWAYS_RUN` will be\nexecuted. Other actions will be skipped.", + "description": "An event generated when the execution of a container results in a non-zero exit status that was not otherwise ignored. Execution will continue, but only actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will be skipped.", "id": "UnexpectedExitStatusEvent", "properties": { "actionId": { @@ -1253,7 +1253,7 @@ "type": "object" }, "WorkerAssignedEvent": { - "description": "An event generated after a worker VM has been assigned to run the\npipeline.", + "description": "An event generated after a worker VM has been assigned to run the pipeline.", "id": "WorkerAssignedEvent", "properties": { "instance": { @@ -1272,7 +1272,7 @@ "type": "object" }, "WorkerReleasedEvent": { - "description": "An event generated when the worker VM that was assigned to the pipeline\nhas been released (deleted).", + "description": "An event generated when the worker VM that was assigned to the pipeline has been released (deleted).", "id": "WorkerReleasedEvent", "properties": { "instance": { diff --git a/discovery/genomics-v2alpha1.json b/discovery/genomics-v2alpha1.json index 9a14b6bda6..c5fb0fe790 100644 --- a/discovery/genomics-v2alpha1.json +++ b/discovery/genomics-v2alpha1.json @@ -110,7 +110,7 @@ "pipelines": { "methods": { "run": { - "description": "Runs a pipeline. The returned Operation's metadata field will contain a\ngoogle.genomics.v2alpha1.Metadata object describing the status of the\npipeline execution. The [response] field will contain a\ngoogle.genomics.v2alpha1.RunPipelineResponse object if the pipeline\ncompletes successfully.\n\n**Note:** Before you can use this method, the Genomics Service Agent\nmust have access to your project. This is done automatically when the\nCloud Genomics API is first enabled, but if you delete this permission,\nor if you enabled the Cloud Genomics API before the v2alpha1 API\nlaunch, you must disable and re-enable the API to grant the Genomics\nService Agent the required permissions.\nAuthorization requires the following [Google\nIAM](https://cloud.google.com/iam/) permission:\n\n* `genomics.operations.create`\n\n[1]: /genomics/gsa", + "description": "Runs a pipeline. The returned Operation's metadata field will contain a google.genomics.v2alpha1.Metadata object describing the status of the pipeline execution. The [response] field will contain a google.genomics.v2alpha1.RunPipelineResponse object if the pipeline completes successfully. **Note:** Before you can use this method, the Genomics Service Agent must have access to your project. This is done automatically when the Cloud Genomics API is first enabled, but if you delete this permission, or if you enabled the Cloud Genomics API before the v2alpha1 API launch, you must disable and re-enable the API to grant the Genomics Service Agent the required permissions. Authorization requires the following [Google IAM](https://cloud.google.com/iam/) permission: * `genomics.operations.create` [1]: /genomics/gsa", "flatPath": "v2alpha1/pipelines:run", "httpMethod": "POST", "id": "genomics.pipelines.run", @@ -135,7 +135,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation.\nThe server makes a best effort to cancel the operation, but success is not\nguaranteed. Clients may use Operations.GetOperation\nor Operations.ListOperations\nto check whether the cancellation succeeded or the operation completed\ndespite cancellation.\nAuthorization requires the following [Google IAM](https://cloud.google.com/iam) permission:\n\n* `genomics.operations.cancel`", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel`", "flatPath": "v2alpha1/projects/{projectsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "genomics.projects.operations.cancel", @@ -164,7 +164,7 @@ ] }, "get": { - "description": "Gets the latest state of a long-running operation.\nClients can use this method to poll the operation result at intervals as\nrecommended by the API service.\nAuthorization requires the following [Google IAM](https://cloud.google.com/iam) permission:\n\n* `genomics.operations.get`", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get`", "flatPath": "v2alpha1/projects/{projectsId}/operations/{operationsId}", "httpMethod": "GET", "id": "genomics.projects.operations.get", @@ -190,7 +190,7 @@ ] }, "list": { - "description": "Lists operations that match the specified filter in the request.\nAuthorization requires the following [Google IAM](https://cloud.google.com/iam) permission:\n\n* `genomics.operations.list`", + "description": "Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list`", "flatPath": "v2alpha1/projects/{projectsId}/operations", "httpMethod": "GET", "id": "genomics.projects.operations.list", @@ -199,7 +199,7 @@ ], "parameters": { "filter": { - "description": "A string for filtering Operations.\nIn v2alpha1, the following filter fields are supported:\n\n* createTime: The time this job was created\n* events: The set of event (names) that have occurred while running\n the pipeline. The : operator can be used to determine if a\n particular event has occurred.\n* error: If the pipeline is running, this value is NULL. Once the\n pipeline finishes, the value is the standard Google error code.\n* labels.key or labels.\"key with space\" where key is a label key.\n* done: If the pipeline is running, this value is false. Once the\n pipeline finishes, the value is true.\n\nIn v1 and v1alpha2, the following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime >= 1432140000`\n* `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`", + "description": "A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels.\"key with space\" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red`", "location": "query", "type": "string" }, @@ -236,7 +236,7 @@ "workers": { "methods": { "checkIn": { - "description": "The worker uses this method to retrieve the assigned operation and\nprovide periodic status updates.", + "description": "The worker uses this method to retrieve the assigned operation and provide periodic status updates.", "flatPath": "v2alpha1/projects/{projectsId}/workers/{workersId}:checkIn", "httpMethod": "POST", "id": "genomics.projects.workers.checkIn", @@ -245,7 +245,7 @@ ], "parameters": { "id": { - "description": "The VM identity token for authenticating the VM instance.\nhttps://cloud.google.com/compute/docs/instances/verifying-instance-identity", + "description": "The VM identity token for authenticating the VM instance. https://cloud.google.com/compute/docs/instances/verifying-instance-identity", "location": "path", "pattern": "^projects/[^/]+/workers/[^/]+$", "required": true, @@ -271,7 +271,7 @@ "workers": { "methods": { "checkIn": { - "description": "The worker uses this method to retrieve the assigned operation and\nprovide periodic status updates.", + "description": "The worker uses this method to retrieve the assigned operation and provide periodic status updates.", "flatPath": "v2alpha1/workers/{id}:checkIn", "httpMethod": "POST", "id": "genomics.workers.checkIn", @@ -280,7 +280,7 @@ ], "parameters": { "id": { - "description": "The VM identity token for authenticating the VM instance.\nhttps://cloud.google.com/compute/docs/instances/verifying-instance-identity", + "description": "The VM identity token for authenticating the VM instance. https://cloud.google.com/compute/docs/instances/verifying-instance-identity", "location": "path", "required": true, "type": "string" @@ -301,7 +301,7 @@ } } }, - "revision": "20200727", + "revision": "20200804", "rootUrl": "https://genomics.googleapis.com/", "schemas": { "Accelerator": { @@ -314,7 +314,7 @@ "type": "string" }, "type": { - "description": "The accelerator type string (for example, \"nvidia-tesla-k80\").\n\nOnly NVIDIA GPU accelerators are currently supported. If an NVIDIA GPU is\nattached, the required runtime libraries will be made available to all\ncontainers under `/usr/local/nvidia`. The driver version to install must\nbe specified using the NVIDIA driver version parameter on the virtual\nmachine specification. Note that attaching a GPU increases the worker VM\nstartup time by a few minutes.", + "description": "The accelerator type string (for example, \"nvidia-tesla-k80\"). Only NVIDIA GPU accelerators are currently supported. If an NVIDIA GPU is attached, the required runtime libraries will be made available to all containers under `/usr/local/nvidia`. The driver version to install must be specified using the NVIDIA driver version parameter on the virtual machine specification. Note that attaching a GPU increases the worker VM startup time by a few minutes.", "type": "string" } }, @@ -325,7 +325,7 @@ "id": "Action", "properties": { "commands": { - "description": "If specified, overrides the `CMD` specified in the container. If the\ncontainer also has an `ENTRYPOINT` the values are used as entrypoint\narguments. Otherwise, they are used as a command and arguments to run\ninside the container.", + "description": "If specified, overrides the `CMD` specified in the container. If the container also has an `ENTRYPOINT` the values are used as entrypoint arguments. Otherwise, they are used as a command and arguments to run inside the container.", "items": { "type": "string" }, @@ -333,7 +333,7 @@ }, "credentials": { "$ref": "Secret", - "description": "If the specified image is hosted on a private registry other than Google\nContainer Registry, the credentials required to pull the image must be\nspecified here as an encrypted secret.\n\nThe secret must decrypt to a JSON-encoded dictionary containing both\n`username` and `password` keys." + "description": "If the specified image is hosted on a private registry other than Google Container Registry, the credentials required to pull the image must be specified here as an encrypted secret. The secret must decrypt to a JSON-encoded dictionary containing both `username` and `password` keys." }, "entrypoint": { "description": "If specified, overrides the `ENTRYPOINT` specified in the container.", @@ -343,20 +343,20 @@ "additionalProperties": { "type": "string" }, - "description": "The environment to pass into the container. This environment is merged\nwith values specified in the google.genomics.v2alpha1.Pipeline\nmessage, overwriting any duplicate values.\n\nIn addition to the values passed here, a few other values are\nautomatically injected into the environment. These cannot be hidden or\noverwritten.\n\n`GOOGLE_PIPELINE_FAILED` will be set to \"1\" if the pipeline failed\nbecause an action has exited with a non-zero status (and did not have the\n`IGNORE_EXIT_STATUS` flag set). This can be used to determine if additional\ndebug or logging actions should execute.\n\n`GOOGLE_LAST_EXIT_STATUS` will be set to the exit status of the last\nnon-background action that executed. This can be used by workflow engine\nauthors to determine whether an individual action has succeeded or failed.", + "description": "The environment to pass into the container. This environment is merged with values specified in the google.genomics.v2alpha1.Pipeline message, overwriting any duplicate values. In addition to the values passed here, a few other values are automatically injected into the environment. These cannot be hidden or overwritten. `GOOGLE_PIPELINE_FAILED` will be set to \"1\" if the pipeline failed because an action has exited with a non-zero status (and did not have the `IGNORE_EXIT_STATUS` flag set). This can be used to determine if additional debug or logging actions should execute. `GOOGLE_LAST_EXIT_STATUS` will be set to the exit status of the last non-background action that executed. This can be used by workflow engine authors to determine whether an individual action has succeeded or failed.", "type": "object" }, "flags": { "description": "The set of flags to apply to this action.", "enumDescriptions": [ "Unspecified flag.", - "Normally, a non-zero exit status causes the pipeline to fail. This flag\nallows execution of other actions to continue instead.", - "This flag allows an action to continue running in the background while\nexecuting subsequent actions. This is useful to provide services to\nother actions (or to provide debugging support tools like SSH servers).", - "By default, after an action fails, no further actions are run. This flag\nindicates that this action must be run even if the pipeline has already\nfailed. This is useful for actions that copy output files off of the VM\nor for debugging. Note that no actions will be run if image\nprefetching fails.", - "Enable access to the FUSE device for this action. Filesystems can then\nbe mounted into disks shared with other actions. The other actions do\nnot need the `ENABLE_FUSE` flag to access the mounted filesystem.\n\nThis has the effect of causing the container to be executed with\n`CAP_SYS_ADMIN` and exposes `/dev/fuse` to the container, so use it only\nfor containers you trust.", - "Exposes all ports specified by `EXPOSE` statements in the container. To\ndiscover the host side port numbers, consult the `ACTION_STARTED` event\nin the operation metadata.", - "All container images are typically downloaded before any actions are\nexecuted. This helps prevent typos in URIs or issues like lack of disk\nspace from wasting large amounts of compute resources.\n\nIf set, this flag prevents the worker from downloading the image until\njust before the action is executed.", - "A small portion of the container's standard error stream is typically\ncaptured and returned inside the `ContainerStoppedEvent`. Setting this\nflag disables this functionality." + "Normally, a non-zero exit status causes the pipeline to fail. This flag allows execution of other actions to continue instead.", + "This flag allows an action to continue running in the background while executing subsequent actions. This is useful to provide services to other actions (or to provide debugging support tools like SSH servers).", + "By default, after an action fails, no further actions are run. This flag indicates that this action must be run even if the pipeline has already failed. This is useful for actions that copy output files off of the VM or for debugging. Note that no actions will be run if image prefetching fails.", + "Enable access to the FUSE device for this action. Filesystems can then be mounted into disks shared with other actions. The other actions do not need the `ENABLE_FUSE` flag to access the mounted filesystem. This has the effect of causing the container to be executed with `CAP_SYS_ADMIN` and exposes `/dev/fuse` to the container, so use it only for containers you trust.", + "Exposes all ports specified by `EXPOSE` statements in the container. To discover the host side port numbers, consult the `ACTION_STARTED` event in the operation metadata.", + "All container images are typically downloaded before any actions are executed. This helps prevent typos in URIs or issues like lack of disk space from wasting large amounts of compute resources. If set, this flag prevents the worker from downloading the image until just before the action is executed.", + "A small portion of the container's standard error stream is typically captured and returned inside the `ContainerStoppedEvent`. Setting this flag disables this functionality." ], "items": { "enum": [ @@ -369,34 +369,44 @@ "DISABLE_IMAGE_PREFETCH", "DISABLE_STANDARD_ERROR_CAPTURE" ], + "enumDescriptions": [ + "Unspecified flag.", + "Normally, a non-zero exit status causes the pipeline to fail. This flag allows execution of other actions to continue instead.", + "This flag allows an action to continue running in the background while executing subsequent actions. This is useful to provide services to other actions (or to provide debugging support tools like SSH servers).", + "By default, after an action fails, no further actions are run. This flag indicates that this action must be run even if the pipeline has already failed. This is useful for actions that copy output files off of the VM or for debugging. Note that no actions will be run if image prefetching fails.", + "Enable access to the FUSE device for this action. Filesystems can then be mounted into disks shared with other actions. The other actions do not need the `ENABLE_FUSE` flag to access the mounted filesystem. This has the effect of causing the container to be executed with `CAP_SYS_ADMIN` and exposes `/dev/fuse` to the container, so use it only for containers you trust.", + "Exposes all ports specified by `EXPOSE` statements in the container. To discover the host side port numbers, consult the `ACTION_STARTED` event in the operation metadata.", + "All container images are typically downloaded before any actions are executed. This helps prevent typos in URIs or issues like lack of disk space from wasting large amounts of compute resources. If set, this flag prevents the worker from downloading the image until just before the action is executed.", + "A small portion of the container's standard error stream is typically captured and returned inside the `ContainerStoppedEvent`. Setting this flag disables this functionality." + ], "type": "string" }, "type": "array" }, "imageUri": { - "description": "Required. The URI to pull the container image from. Note that all images referenced\nby actions in the pipeline are pulled before the first action runs. If\nmultiple actions reference the same image, it is only pulled once,\nensuring that the same image is used for all actions in a single pipeline.\n\nThe image URI can be either a complete host and image specification (e.g.,\nquay.io/biocontainers/samtools), a library and image name (e.g.,\ngoogle/cloud-sdk) or a bare image name ('bash') to pull from the default\nlibrary. No schema is required in any of these cases.\n\nIf the specified image is not public, the service account specified for\nthe Virtual Machine must have access to pull the images from GCR, or\nappropriate credentials must be specified in the\ngoogle.genomics.v2alpha1.Action.credentials field.", + "description": "Required. The URI to pull the container image from. Note that all images referenced by actions in the pipeline are pulled before the first action runs. If multiple actions reference the same image, it is only pulled once, ensuring that the same image is used for all actions in a single pipeline. The image URI can be either a complete host and image specification (e.g., quay.io/biocontainers/samtools), a library and image name (e.g., google/cloud-sdk) or a bare image name ('bash') to pull from the default library. No schema is required in any of these cases. If the specified image is not public, the service account specified for the Virtual Machine must have access to pull the images from GCR, or appropriate credentials must be specified in the google.genomics.v2alpha1.Action.credentials field.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Labels to associate with the action. This field is provided to assist\nworkflow engine authors in identifying actions (for example, to indicate\nwhat sort of action they perform, such as localization or debugging).\nThey are returned in the operation metadata, but are otherwise ignored.", + "description": "Labels to associate with the action. This field is provided to assist workflow engine authors in identifying actions (for example, to indicate what sort of action they perform, such as localization or debugging). They are returned in the operation metadata, but are otherwise ignored.", "type": "object" }, "mounts": { - "description": "A list of mounts to make available to the action.\n\nIn addition to the values specified here, every action has a special\nvirtual disk mounted under `/google` that contains log files and other\noperational components.\n\n
    \n
  • /google/logs All logs written during the pipeline\n execution.
    • \n
  • /google/logs/output The combined standard output and\n standard error of all actions run as part of the pipeline\n execution.
    • \n
  • /google/logs/action/*/stdout The complete contents of\n each individual action's standard output.
    • \n
  • /google/logs/action/*/stderr The complete contents of\n each individual action's standard error output.
    • \n
", + "description": "A list of mounts to make available to the action. In addition to the values specified here, every action has a special virtual disk mounted under `/google` that contains log files and other operational components. - /google/logs All logs written during the pipeline execution. - /google/logs/output The combined standard output and standard error of all actions run as part of the pipeline execution. - /google/logs/action/*/stdout The complete contents of each individual action's standard output. - /google/logs/action/*/stderr The complete contents of each individual action's standard error output. ", "items": { "$ref": "Mount" }, "type": "array" }, "name": { - "description": "An optional name for the container. The container hostname will be set to\nthis name, making it useful for inter-container communication. The name\nmust contain only upper and lowercase alphanumeric characters and hypens\nand cannot start with a hyphen.", + "description": "An optional name for the container. The container hostname will be set to this name, making it useful for inter-container communication. The name must contain only upper and lowercase alphanumeric characters and hypens and cannot start with a hyphen.", "type": "string" }, "pidNamespace": { - "description": "An optional identifier for a PID namespace to run the action inside.\nMultiple actions should use the same string to share a namespace. If\nunspecified, a separate isolated namespace is used.", + "description": "An optional identifier for a PID namespace to run the action inside. Multiple actions should use the same string to share a namespace. If unspecified, a separate isolated namespace is used.", "type": "string" }, "portMappings": { @@ -404,11 +414,11 @@ "format": "int32", "type": "integer" }, - "description": "A map of containers to host port mappings for this container. If the\ncontainer already specifies exposed ports, use the\n`PUBLISH_EXPOSED_PORTS` flag instead.\n\nThe host port number must be less than 65536. If it is zero, an unused\nrandom port is assigned. To determine the resulting port number, consult\nthe `ContainerStartedEvent` in the operation metadata.", + "description": "A map of containers to host port mappings for this container. If the container already specifies exposed ports, use the `PUBLISH_EXPOSED_PORTS` flag instead. The host port number must be less than 65536. If it is zero, an unused random port is assigned. To determine the resulting port number, consult the `ContainerStartedEvent` in the operation metadata.", "type": "object" }, "timeout": { - "description": "The maximum amount of time to give the action to complete. If the action\nfails to complete before the timeout, it will be terminated and the exit\nstatus will be non-zero. The pipeline will continue or terminate based\non the rules defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags.", + "description": "The maximum amount of time to give the action to complete. If the action fails to complete before the timeout, it will be terminated and the exit status will be non-zero. The pipeline will continue or terminate based on the rules defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags.", "format": "google-duration", "type": "string" } @@ -448,6 +458,11 @@ "$ref": "Status", "description": "The operation has finished with the given result." }, + "sosReport": { + "description": "An SOS report for an unexpected VM failure.", + "format": "byte", + "type": "string" + }, "workerStatus": { "$ref": "WorkerStatus", "description": "Data about the status of the worker VM." @@ -460,7 +475,7 @@ "id": "CheckInResponse", "properties": { "deadline": { - "description": "The deadline by which the worker must request an extension. The backend\nwill allow for network transmission time and other delays, but the worker\nmust attempt to transmit the extension request no later than the deadline.", + "description": "The deadline by which the worker must request an extension. The backend will allow for network transmission time and other delays, but the worker must attempt to transmit the extension request no later than the deadline.", "format": "google-datetime", "type": "string" }, @@ -476,7 +491,7 @@ "type": "object" }, "ComputeEngine": { - "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.", + "description": "Describes a Compute Engine resource that is being managed by a running pipeline.", "id": "ComputeEngine", "properties": { "diskNames": { @@ -502,7 +517,7 @@ "type": "object" }, "ContainerKilledEvent": { - "description": "An event generated when a container is forcibly terminated by the\nworker. Currently, this only occurs when the container outlives the\ntimeout specified by the user.", + "description": "An event generated when a container is forcibly terminated by the worker. Currently, this only occurs when the container outlives the timeout specified by the user.", "id": "ContainerKilledEvent", "properties": { "actionId": { @@ -523,7 +538,7 @@ "type": "integer" }, "ipAddress": { - "description": "The public IP address that can be used to connect to the container. This\nfield is only populated when at least one port mapping is present. If the\ninstance was created with a private address, this field will be empty even\nif port mappings exist.", + "description": "The public IP address that can be used to connect to the container. This field is only populated when at least one port mapping is present. If the instance was created with a private address, this field will be empty even if port mappings exist.", "type": "string" }, "portMappings": { @@ -531,7 +546,7 @@ "format": "int32", "type": "integer" }, - "description": "The container-to-host port mappings installed for this container. This\nset will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag\nas well as any specified in the `Action` definition.", + "description": "The container-to-host port mappings installed for this container. This set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well as any specified in the `Action` definition.", "type": "object" } }, @@ -552,22 +567,22 @@ "type": "integer" }, "stderr": { - "description": "The tail end of any content written to standard error by the container.\nIf the content emits large amounts of debugging noise or contains\nsensitive information, you can prevent the content from being printed by\nsetting the `DISABLE_STANDARD_ERROR_CAPTURE` flag.\n\nNote that only a small amount of the end of the stream is captured here.\nThe entire stream is stored in the `/google/logs` directory mounted into\neach action, and can be copied off the machine as described elsewhere.", + "description": "The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere.", "type": "string" } }, "type": "object" }, "DelayedEvent": { - "description": "An event generated whenever a resource limitation or transient error\ndelays execution of a pipeline that was otherwise ready to run.", + "description": "An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run.", "id": "DelayedEvent", "properties": { "cause": { - "description": "A textual description of the cause of the delay. The string can change\nwithout notice because it is often generated by another service (such as\nCompute Engine).", + "description": "A textual description of the cause of the delay. The string can change without notice because it is often generated by another service (such as Compute Engine).", "type": "string" }, "metrics": { - "description": "If the delay was caused by a resource shortage, this field lists the\nCompute Engine metrics that are preventing this operation from running\n(for example, `CPUS` or `INSTANCES`). If the particular metric is not\nknown, a single `UNKNOWN` metric will be present.", + "description": "If the delay was caused by a resource shortage, this field lists the Compute Engine metrics that are preventing this operation from running (for example, `CPUS` or `INSTANCES`). If the particular metric is not known, a single `UNKNOWN` metric will be present.", "items": { "type": "string" }, @@ -577,15 +592,15 @@ "type": "object" }, "Disk": { - "description": "Carries information about a disk that can be attached to a VM.\n\nSee https://cloud.google.com/compute/docs/disks/performance for more\ninformation about disk type, size, and performance considerations.", + "description": "Carries information about a disk that can be attached to a VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations.", "id": "Disk", "properties": { "name": { - "description": "A user-supplied name for the disk. Used when mounting the disk into\nactions. The name must contain only upper and lowercase alphanumeric\ncharacters and hypens and cannot start with a hyphen.", + "description": "A user-supplied name for the disk. Used when mounting the disk into actions. The name must contain only upper and lowercase alphanumeric characters and hypens and cannot start with a hyphen.", "type": "string" }, "sizeGb": { - "description": "The size, in GB, of the disk to attach. If the size is not\nspecified, a default is chosen to ensure reasonable I/O performance.\n\nIf the disk type is specified as `local-ssd`, multiple local drives are\nautomatically combined to provide the requested size. Note, however, that\neach physical SSD is 375GB in size, and no more than 8 drives can be\nattached to a single instance.", + "description": "The size, in GB, of the disk to attach. If the size is not specified, a default is chosen to ensure reasonable I/O performance. If the disk type is specified as `local-ssd`, multiple local drives are automatically combined to provide the requested size. Note, however, that each physical SSD is 375GB in size, and no more than 8 drives can be attached to a single instance.", "format": "int32", "type": "integer" }, @@ -618,7 +633,7 @@ "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" @@ -628,7 +643,7 @@ "id": "Event", "properties": { "description": { - "description": "A human-readable description of the event. Note that these strings can\nchange at any time without notice. Any application logic must use the\ninformation in the `details` field.", + "description": "A human-readable description of the event. Note that these strings can change at any time without notice. Any application logic must use the information in the `details` field.", "type": "string" }, "details": { @@ -648,7 +663,7 @@ "type": "object" }, "FailedEvent": { - "description": "An event generated when the execution of a pipeline has failed. Note\nthat other events can continue to occur after this event.", + "description": "An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event.", "id": "FailedEvent", "properties": { "cause": { @@ -677,23 +692,23 @@ "DATA_LOSS" ], "enumDescriptions": [ - "Not an error; returned on success\n\nHTTP Mapping: 200 OK", - "The operation was cancelled, typically by the caller.\n\nHTTP Mapping: 499 Client Closed Request", - "Unknown error. For example, this error may be returned when\na `Status` value received from another address space belongs to\nan error space that is not known in this address space. Also\nerrors raised by APIs that do not return enough error information\nmay be converted to this error.\n\nHTTP Mapping: 500 Internal Server Error", - "The client specified an invalid argument. Note that this differs\nfrom `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments\nthat are problematic regardless of the state of the system\n(e.g., a malformed file name).\n\nHTTP Mapping: 400 Bad Request", - "The deadline expired before the operation could complete. For operations\nthat change the state of the system, this error may be returned\neven if the operation has completed successfully. For example, a\nsuccessful response from a server could have been delayed long\nenough for the deadline to expire.\n\nHTTP Mapping: 504 Gateway Timeout", - "Some requested entity (e.g., file or directory) was not found.\n\nNote to server developers: if a request is denied for an entire class\nof users, such as gradual feature rollout or undocumented allowlist,\n`NOT_FOUND` may be used. If a request is denied for some users within\na class of users, such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP Mapping: 404 Not Found", - "The entity that a client attempted to create (e.g., file or directory)\nalready exists.\n\nHTTP Mapping: 409 Conflict", - "The caller does not have permission to execute the specified\noperation. `PERMISSION_DENIED` must not be used for rejections\ncaused by exhausting some resource (use `RESOURCE_EXHAUSTED`\ninstead for those errors). `PERMISSION_DENIED` must not be\nused if the caller can not be identified (use `UNAUTHENTICATED`\ninstead for those errors). This error code does not imply the\nrequest is valid or the requested entity exists or satisfies\nother pre-conditions.\n\nHTTP Mapping: 403 Forbidden", - "The request does not have valid authentication credentials for the\noperation.\n\nHTTP Mapping: 401 Unauthorized", - "Some resource has been exhausted, perhaps a per-user quota, or\nperhaps the entire file system is out of space.\n\nHTTP Mapping: 429 Too Many Requests", - "The operation was rejected because the system is not in a state\nrequired for the operation's execution. For example, the directory\nto be deleted is non-empty, an rmdir operation is applied to\na non-directory, etc.\n\nService implementors can use the following guidelines to decide\nbetween `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:\n (a) Use `UNAVAILABLE` if the client can retry just the failing call.\n (b) Use `ABORTED` if the client should retry at a higher level\n (e.g., when a client-specified test-and-set fails, indicating the\n client should restart a read-modify-write sequence).\n (c) Use `FAILED_PRECONDITION` if the client should not retry until\n the system state has been explicitly fixed. E.g., if an \"rmdir\"\n fails because the directory is non-empty, `FAILED_PRECONDITION`\n should be returned since the client should not retry unless\n the files are deleted from the directory.\n\nHTTP Mapping: 400 Bad Request", - "The operation was aborted, typically due to a concurrency issue such as\na sequencer check failure or transaction abort.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 409 Conflict", - "The operation was attempted past the valid range. E.g., seeking or\nreading past end-of-file.\n\nUnlike `INVALID_ARGUMENT`, this error indicates a problem that may\nbe fixed if the system state changes. For example, a 32-bit file\nsystem will generate `INVALID_ARGUMENT` if asked to read at an\noffset that is not in the range [0,2^32-1], but it will generate\n`OUT_OF_RANGE` if asked to read from an offset past the current\nfile size.\n\nThere is a fair bit of overlap between `FAILED_PRECONDITION` and\n`OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific\nerror) when it applies so that callers who are iterating through\na space can easily look for an `OUT_OF_RANGE` error to detect when\nthey are done.\n\nHTTP Mapping: 400 Bad Request", - "The operation is not implemented or is not supported/enabled in this\nservice.\n\nHTTP Mapping: 501 Not Implemented", - "Internal errors. This means that some invariants expected by the\nunderlying system have been broken. This error code is reserved\nfor serious errors.\n\nHTTP Mapping: 500 Internal Server Error", - "The service is currently unavailable. This is most likely a\ntransient condition, which can be corrected by retrying with\na backoff. Note that it is not always safe to retry\nnon-idempotent operations.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 503 Service Unavailable", - "Unrecoverable data loss or corruption.\n\nHTTP Mapping: 500 Internal Server Error" + "Not an error; returned on success HTTP Mapping: 200 OK", + "The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request", + "Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error", + "The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request", + "The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout", + "Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found", + "The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict", + "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", + "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", + "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", + "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", + "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", + "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", + "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", + "Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error", + "The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable", + "Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error" ], "type": "string" } @@ -719,7 +734,7 @@ "type": "object" }, "Metadata": { - "description": "Carries information about the pipeline execution that is returned\nin the long running operation's metadata field.", + "description": "Carries information about the pipeline execution that is returned in the long running operation's metadata field.", "id": "Metadata", "properties": { "createTime": { @@ -733,7 +748,7 @@ "type": "string" }, "events": { - "description": "The list of events that have happened so far during the execution of this\noperation.", + "description": "The list of events that have happened so far during the execution of this operation.", "items": { "$ref": "Event" }, @@ -782,26 +797,26 @@ "id": "Network", "properties": { "name": { - "description": "The network name to attach the VM's network interface to. The value will\nbe prefixed with `global/networks/` unless it contains a `/`, in which\ncase it is assumed to be a fully specified network resource URL.\n\nIf unspecified, the global default network is used.", + "description": "The network name to attach the VM's network interface to. The value will be prefixed with `global/networks/` unless it contains a `/`, in which case it is assumed to be a fully specified network resource URL. If unspecified, the global default network is used.", "type": "string" }, "subnetwork": { - "description": "If the specified network is configured for custom subnet creation, the\nname of the subnetwork to attach the instance to must be specified here.\n\nThe value is prefixed with `regions/*/subnetworks/` unless it contains a\n`/`, in which case it is assumed to be a fully specified subnetwork\nresource URL.\n\nIf the `*` character appears in the value, it is replaced with the region\nthat the virtual machine has been allocated in.", + "description": "If the specified network is configured for custom subnet creation, the name of the subnetwork to attach the instance to must be specified here. The value is prefixed with `regions/*/subnetworks/` unless it contains a `/`, in which case it is assumed to be a fully specified subnetwork resource URL. If the `*` character appears in the value, it is replaced with the region that the virtual machine has been allocated in.", "type": "string" }, "usePrivateAddress": { - "description": "If set to true, do not attach a public IP address to the VM. Note that\nwithout a public IP address, additional configuration is required to\nallow the VM to access Google services.\n\nSee https://cloud.google.com/vpc/docs/configure-private-google-access\nfor more information.", + "description": "If set to true, do not attach a public IP address to the VM. Note that without a public IP address, additional configuration is required to allow the VM to access Google services. See https://cloud.google.com/vpc/docs/configure-private-google-access for more information.", "type": "boolean" } }, "type": "object" }, "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "properties": { "done": { - "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { @@ -817,7 +832,7 @@ "type": "object" }, "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`", + "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`", "type": "string" }, "response": { @@ -840,7 +855,7 @@ "type": "string" }, "endTime": { - "description": "Optional time of when event finished. An event can have a start time and no\nfinish time. If an event has a finish time, there must be a start time.", + "description": "Optional time of when event finished. An event can have a start time and no finish time. If an event has a finish time, there must be a start time.", "format": "google-datetime", "type": "string" }, @@ -857,7 +872,7 @@ "id": "OperationMetadata", "properties": { "clientId": { - "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.", + "description": "This field is deprecated. Use `labels` instead. Optionally provided by the caller when submitting the request that creates the operation.", "type": "string" }, "createTime": { @@ -871,7 +886,7 @@ "type": "string" }, "events": { - "description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.", + "description": "Optional event messages that were generated during the job's execution. This also contains any warnings that were generated during import or export.", "items": { "$ref": "OperationEvent" }, @@ -881,7 +896,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.", + "description": "Optionally provided by the caller when submitting the request that creates the operation.", "type": "object" }, "projectId": { @@ -893,7 +908,7 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.", + "description": "The original request that started the operation. Note that this will be in current version of the API. If the operation was started with v1beta2 API and a GetOperation is performed on v1 API, a v1 request will be returned.", "type": "object" }, "runtimeMetadata": { @@ -927,7 +942,7 @@ "additionalProperties": { "type": "string" }, - "description": "The environment to pass into every action. Each action can also specify\nadditional environment variables but cannot delete an entry from this map\n(though they can overwrite it with a different value).", + "description": "The environment to pass into every action. Each action can also specify additional environment variables but cannot delete an entry from this map (though they can overwrite it with a different value).", "type": "object" }, "resources": { @@ -935,7 +950,7 @@ "description": "The resources required for execution." }, "timeout": { - "description": "The maximum amount of time to give the pipeline to complete. This includes\nthe time spent waiting for a worker to be allocated. If the pipeline fails\nto complete before the timeout, it will be cancelled and the error code\nwill be set to DEADLINE_EXCEEDED.\n\nIf unspecified, it will default to 7 days.", + "description": "The maximum amount of time to give the pipeline to complete. This includes the time spent waiting for a worker to be allocated. If the pipeline fails to complete before the timeout, it will be cancelled and the error code will be set to DEADLINE_EXCEEDED. If unspecified, it will default to 7 days.", "format": "google-duration", "type": "string" } @@ -965,7 +980,7 @@ "type": "object" }, "Resources": { - "description": "The system resources for the pipeline run.\n\nAt least one zone or region must be specified or the pipeline run will fail.", + "description": "The system resources for the pipeline run. At least one zone or region must be specified or the pipeline run will fail.", "id": "Resources", "properties": { "projectId": { @@ -973,7 +988,7 @@ "type": "string" }, "regions": { - "description": "The list of regions allowed for VM allocation. If set, the `zones` field\nmust not be set.", + "description": "The list of regions allowed for VM allocation. If set, the `zones` field must not be set.", "items": { "type": "string" }, @@ -984,7 +999,7 @@ "description": "The virtual machine specification." }, "zones": { - "description": "The list of zones allowed for VM allocation. If set, the `regions` field\nmust not be set.", + "description": "The list of zones allowed for VM allocation. If set, the `regions` field must not be set.", "items": { "type": "string" }, @@ -994,14 +1009,14 @@ "type": "object" }, "RunPipelineRequest": { - "description": "The arguments to the `RunPipeline` method. The requesting user must have\nthe `iam.serviceAccounts.actAs` permission for the Cloud Genomics service\naccount or the request will fail.", + "description": "The arguments to the `RunPipeline` method. The requesting user must have the `iam.serviceAccounts.actAs` permission for the Cloud Genomics service account or the request will fail.", "id": "RunPipelineRequest", "properties": { "labels": { "additionalProperties": { "type": "string" }, - "description": "User-defined labels to associate with the returned operation. These\nlabels are not propagated to any Google Cloud Platform resources used by\nthe operation, and can be modified at any time.\n\nTo associate labels with resources created while executing the operation,\nsee the appropriate resource message (for example, `VirtualMachine`).", + "description": "User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time. To associate labels with resources created while executing the operation, see the appropriate resource message (for example, `VirtualMachine`).", "type": "object" }, "pipeline": { @@ -1012,13 +1027,13 @@ "type": "object" }, "RunPipelineResponse": { - "description": "The response to the RunPipeline method, returned in the operation's result\nfield on success.", + "description": "The response to the RunPipeline method, returned in the operation's result field on success.", "id": "RunPipelineResponse", "properties": {}, "type": "object" }, "RuntimeMetadata": { - "description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.", + "description": "Runtime metadata that will be populated in the runtimeMetadata field of the Operation associated with a RunPipeline execution.", "id": "RuntimeMetadata", "properties": { "computeEngine": { @@ -1029,15 +1044,15 @@ "type": "object" }, "Secret": { - "description": "Holds encrypted information that is only decrypted and stored in RAM\nby the worker VM when running the pipeline.", + "description": "Holds encrypted information that is only decrypted and stored in RAM by the worker VM when running the pipeline.", "id": "Secret", "properties": { "cipherText": { - "description": "The value of the cipherText response from the `encrypt` method. This field\nis intentionally unaudited.", + "description": "The value of the cipherText response from the `encrypt` method. This field is intentionally unaudited.", "type": "string" }, "keyName": { - "description": "The name of the Cloud KMS key that will be used to decrypt the secret\nvalue. The VM service account must have the required permissions and\nauthentication scopes to invoke the `decrypt` method on the specified key.", + "description": "The name of the Cloud KMS key that will be used to decrypt the secret value. The VM service account must have the required permissions and authentication scopes to invoke the `decrypt` method on the specified key.", "type": "string" } }, @@ -1048,11 +1063,11 @@ "id": "ServiceAccount", "properties": { "email": { - "description": "Email address of the service account. If not specified, the default\nCompute Engine service account for the project will be used.", + "description": "Email address of the service account. If not specified, the default Compute Engine service account for the project will be used.", "type": "string" }, "scopes": { - "description": "List of scopes to be enabled for this service account on the VM, in\naddition to the cloud-platform API scope that will be added by default.", + "description": "List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default.", "items": { "type": "string" }, @@ -1062,7 +1077,7 @@ "type": "object" }, "Status": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { @@ -1071,7 +1086,7 @@ "type": "integer" }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -1082,14 +1097,14 @@ "type": "array" }, "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "type": "object" }, "TimestampedEvent": { - "description": "An event that occured in the operation assigned to the\nworker and the time of occurance.", + "description": "An event that occured in the operation assigned to the worker and the time of occurance.", "id": "TimestampedEvent", "properties": { "data": { @@ -1109,7 +1124,7 @@ "type": "object" }, "UnexpectedExitStatusEvent": { - "description": "An event generated when the execution of a container results in a\nnon-zero exit status that was not otherwise ignored. Execution will\ncontinue, but only actions that are flagged as `ALWAYS_RUN` will be\nexecuted. Other actions will be skipped.", + "description": "An event generated when the execution of a container results in a non-zero exit status that was not otherwise ignored. Execution will continue, but only actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will be skipped.", "id": "UnexpectedExitStatusEvent", "properties": { "actionId": { @@ -1137,16 +1152,16 @@ "type": "array" }, "bootDiskSizeGb": { - "description": "The size of the boot disk, in GB. The boot disk must be large\nenough to accommodate all of the Docker images from each action in the\npipeline at the same time. If not specified, a small but reasonable\ndefault value is used.", + "description": "The size of the boot disk, in GB. The boot disk must be large enough to accommodate all of the Docker images from each action in the pipeline at the same time. If not specified, a small but reasonable default value is used.", "format": "int32", "type": "integer" }, "bootImage": { - "description": "The host operating system image to use.\n\nCurrently, only Container-Optimized OS images can be used.\n\nThe default value is `projects/cos-cloud/global/images/family/cos-stable`,\nwhich selects the latest stable release of Container-Optimized OS.\n\nThis option is provided to allow testing against the beta release of the\noperating system to ensure that the new version does not interact\nnegatively with production pipelines.\n\nTo test a pipeline against the beta release of Container-Optimized OS,\nuse the value `projects/cos-cloud/global/images/family/cos-beta`.", + "description": "The host operating system image to use. Currently, only Container-Optimized OS images can be used. The default value is `projects/cos-cloud/global/images/family/cos-stable`, which selects the latest stable release of Container-Optimized OS. This option is provided to allow testing against the beta release of the operating system to ensure that the new version does not interact negatively with production pipelines. To test a pipeline against the beta release of Container-Optimized OS, use the value `projects/cos-cloud/global/images/family/cos-beta`.", "type": "string" }, "cpuPlatform": { - "description": "The CPU platform to request. An instance based on a newer platform can be\nallocated, but never one with fewer capabilities. The value of this\nparameter must be a valid Compute Engine CPU platform name (such as \"Intel\nSkylake\"). This parameter is only useful for carefully optimized work\nloads where the CPU platform has a significant impact.\n\nFor more information about the effect of this parameter, see\nhttps://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.", + "description": "The CPU platform to request. An instance based on a newer platform can be allocated, but never one with fewer capabilities. The value of this parameter must be a valid Compute Engine CPU platform name (such as \"Intel Skylake\"). This parameter is only useful for carefully optimized work loads where the CPU platform has a significant impact. For more information about the effect of this parameter, see https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.", "type": "string" }, "disks": { @@ -1157,7 +1172,7 @@ "type": "array" }, "dockerCacheImages": { - "description": "The Compute Engine Disk Images to use as a Docker cache. The disks will be\nmounted into the Docker folder in a way that the images present in the\ncache will not need to be pulled. The digests of the cached images must\nmatch those of the tags used or the latest version will still be pulled.\nThe root directory of the ext4 image must contain `image` and `overlay2`\ndirectories copied from the Docker directory of a VM where the desired\nDocker images have already been pulled. Only a single image is supported.", + "description": "The Compute Engine Disk Images to use as a Docker cache. The disks will be mounted into the Docker folder in a way that the images present in the cache will not need to be pulled. The digests of the cached images must match those of the tags used or the latest version will still be pulled. The root directory of the ext4 image must contain `image` and `overlay2` directories copied from the Docker directory of a VM where the desired Docker images have already been pulled. Only a single image is supported.", "items": { "type": "string" }, @@ -1171,11 +1186,11 @@ "additionalProperties": { "type": "string" }, - "description": "Optional set of labels to apply to the VM and any attached disk resources.\nThese labels must adhere to the [name and value\nrestrictions](https://cloud.google.com/compute/docs/labeling-resources) on\nVM labels imposed by Compute Engine.\n\nLabels keys with the prefix 'google-' are reserved for use by Google.\n\nLabels applied at creation time to the VM. Applied on a best-effort basis\nto attached disk resources shortly after VM creation.", + "description": "Optional set of labels to apply to the VM and any attached disk resources. These labels must adhere to the [name and value restrictions](https://cloud.google.com/compute/docs/labeling-resources) on VM labels imposed by Compute Engine. Labels keys with the prefix 'google-' are reserved for use by Google. Labels applied at creation time to the VM. Applied on a best-effort basis to attached disk resources shortly after VM creation.", "type": "object" }, "machineType": { - "description": "Required. The machine type of the virtual machine to create. Must be the short name\nof a standard machine type (such as \"n1-standard-1\") or a custom machine\ntype (such as \"custom-1-4096\", where \"1\" indicates the number of vCPUs and\n\"4096\" indicates the memory in MB). See\n[Creating an instance with a custom machine\ntype](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type#create)\nfor more specifications on creating a custom machine type.", + "description": "Required. The machine type of the virtual machine to create. Must be the short name of a standard machine type (such as \"n1-standard-1\") or a custom machine type (such as \"custom-1-4096\", where \"1\" indicates the number of vCPUs and \"4096\" indicates the memory in MB). See [Creating an instance with a custom machine type](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type#create) for more specifications on creating a custom machine type.", "type": "string" }, "network": { @@ -1183,7 +1198,7 @@ "description": "The VM network configuration." }, "nvidiaDriverVersion": { - "description": "The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator.\nThe version specified here must be compatible with the GPU libraries\ncontained in the container being executed, and must be one of the drivers\nhosted in the `nvidia-drivers-us-public` bucket on Google Cloud Storage.", + "description": "The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator. The version specified here must be compatible with the GPU libraries contained in the container being executed, and must be one of the drivers hosted in the `nvidia-drivers-us-public` bucket on Google Cloud Storage.", "type": "string" }, "preemptible": { @@ -1192,13 +1207,13 @@ }, "serviceAccount": { "$ref": "ServiceAccount", - "description": "The service account to install on the VM. This account does not need\nany permissions other than those required by the pipeline." + "description": "The service account to install on the VM. This account does not need any permissions other than those required by the pipeline." } }, "type": "object" }, "WorkerAssignedEvent": { - "description": "An event generated after a worker VM has been assigned to run the\npipeline.", + "description": "An event generated after a worker VM has been assigned to run the pipeline.", "id": "WorkerAssignedEvent", "properties": { "instance": { @@ -1217,7 +1232,7 @@ "type": "object" }, "WorkerReleasedEvent": { - "description": "An event generated when the worker VM that was assigned to the pipeline\nhas been released (deleted).", + "description": "An event generated when the worker VM that was assigned to the pipeline has been released (deleted).", "id": "WorkerReleasedEvent", "properties": { "instance": { diff --git a/discovery/gmail-v1.json b/discovery/gmail-v1.json index 7f81ae44d2..99723ea5e1 100644 --- a/discovery/gmail-v1.json +++ b/discovery/gmail-v1.json @@ -51,7 +51,7 @@ "baseUrl": "https://www.googleapis.com/", "batchPath": "batch/gmail/v1", "canonicalName": "Gmail", - "description": "The Gmail API lets you view and manage Gmail mailbox data like\n threads, messages, and labels.", + "description": "The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/gmail/api/", "icons": { @@ -156,7 +156,7 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -185,7 +185,7 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -210,7 +210,7 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -261,7 +261,7 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -283,7 +283,7 @@ "supportsMediaUpload": true }, "delete": { - "description": "Immediately and permanently deletes the specified draft.\nDoes not simply trash it.", + "description": "Immediately and permanently deletes the specified draft. Does not simply trash it.", "flatPath": "gmail/v1/users/{userId}/drafts/{id}", "httpMethod": "DELETE", "id": "gmail.users.drafts.delete", @@ -300,7 +300,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -333,6 +333,12 @@ "raw", "metadata" ], + "enumDescriptions": [ + "Returns only email message ID and labels; does not return the email headers, body, or payload.", + "Returns the full email message data with body content parsed in the `payload` field; the `raw` field is not used. Format cannot be used when accessing the api using the gmail.metadata scope.", + "Returns the full email message data with body content in the `raw` field as a base64url encoded string; the `payload` field is not used. Format cannot be used when accessing the api using the gmail.metadata scope.", + "Returns only email message ID, labels, and email headers." + ], "location": "query", "type": "string" }, @@ -344,7 +350,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -372,7 +378,7 @@ "parameters": { "includeSpamTrash": { "default": "false", - "description": "Include drafts from `SPAM` and `TRASH`\nin the results.", + "description": "Include drafts from `SPAM` and `TRASH` in the results.", "location": "query", "type": "boolean" }, @@ -389,13 +395,13 @@ "type": "string" }, "q": { - "description": "Only return draft messages matching the specified query. Supports the same\nquery format as the Gmail search box. For example,\n`\"from:someuser@example.com rfc822msgid:\nis:unread\"`.", + "description": "Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`.", "location": "query", "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -413,7 +419,7 @@ ] }, "send": { - "description": "Sends the specified, existing draft to the recipients in the\n`To`, `Cc`, and `Bcc` headers.", + "description": "Sends the specified, existing draft to the recipients in the `To`, `Cc`, and `Bcc` headers.", "flatPath": "gmail/v1/users/{userId}/drafts/send", "httpMethod": "POST", "id": "gmail.users.drafts.send", @@ -439,7 +445,7 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -494,7 +500,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -520,7 +526,7 @@ "history": { "methods": { "list": { - "description": "Lists the history of all changes to the given mailbox. History results are\nreturned in chronological order (increasing `historyId`).", + "description": "Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing `historyId`).", "flatPath": "gmail/v1/users/{userId}/history", "httpMethod": "GET", "id": "gmail.users.history.list", @@ -536,6 +542,12 @@ "labelAdded", "labelRemoved" ], + "enumDescriptions": [ + "", + "", + "", + "" + ], "location": "query", "repeated": true, "type": "string" @@ -558,14 +570,14 @@ "type": "string" }, "startHistoryId": { - "description": "Required. Returns history records after the specified\n`startHistoryId`. The supplied `startHistoryId`\nshould be obtained from the `historyId` of a message, thread, or\nprevious `list` response. History IDs increase\nchronologically but are not contiguous with random gaps in between valid\nIDs. Supplying an invalid or out of date `startHistoryId`\ntypically returns an `HTTP 404` error code. A\n`historyId` is typically valid for at least a week, but in some\nrare circumstances may be valid for only a few hours. If you receive an\n`HTTP 404` error response, your application should perform a\nfull sync. If you receive no `nextPageToken` in the response,\nthere are no updates to retrieve and you can store the returned\n`historyId` for a future request.", + "description": "Required. Returns history records after the specified `startHistoryId`. The supplied `startHistoryId` should be obtained from the `historyId` of a message, thread, or previous `list` response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date `startHistoryId` typically returns an `HTTP 404` error code. A `historyId` is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an `HTTP 404` error response, your application should perform a full sync. If you receive no `nextPageToken` in the response, there are no updates to retrieve and you can store the returned `historyId` for a future request.", "format": "uint64", "location": "query", "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -597,7 +609,7 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -617,7 +629,7 @@ ] }, "delete": { - "description": "Immediately and permanently deletes the specified label and removes it from\nany messages and threads that it is applied to.", + "description": "Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to.", "flatPath": "gmail/v1/users/{userId}/labels/{id}", "httpMethod": "DELETE", "id": "gmail.users.labels.delete", @@ -634,7 +646,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -665,7 +677,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -694,7 +706,7 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -730,7 +742,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -767,7 +779,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -791,7 +803,7 @@ "messages": { "methods": { "batchDelete": { - "description": "Deletes many messages by message ID. Provides no guarantees that messages\nwere not already deleted or even existed at all.", + "description": "Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.", "flatPath": "gmail/v1/users/{userId}/messages/batchDelete", "httpMethod": "POST", "id": "gmail.users.messages.batchDelete", @@ -801,7 +813,7 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -826,7 +838,7 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -842,7 +854,7 @@ ] }, "delete": { - "description": "Immediately and permanently deletes the specified message. This operation\ncannot be undone. Prefer `messages.trash` instead.", + "description": "Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer `messages.trash` instead.", "flatPath": "gmail/v1/users/{userId}/messages/{id}", "httpMethod": "DELETE", "id": "gmail.users.messages.delete", @@ -859,7 +871,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -889,6 +901,12 @@ "raw", "metadata" ], + "enumDescriptions": [ + "Returns only email message ID and labels; does not return the email headers, body, or payload.", + "Returns the full email message data with body content parsed in the `payload` field; the `raw` field is not used. Format cannot be used when accessing the api using the gmail.metadata scope.", + "Returns the full email message data with body content in the `raw` field as a base64url encoded string; the `payload` field is not used. Format cannot be used when accessing the api using the gmail.metadata scope.", + "Returns only email message ID, labels, and email headers." + ], "location": "query", "type": "string" }, @@ -899,14 +917,14 @@ "type": "string" }, "metadataHeaders": { - "description": "When given and format is `METADATA`, only include headers\nspecified.", + "description": "When given and format is `METADATA`, only include headers specified.", "location": "query", "repeated": true, "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -927,7 +945,7 @@ ] }, "import": { - "description": "Imports a message into only this user's mailbox, with standard\nemail delivery scanning and classification similar to receiving via SMTP.\nDoes not send a message.", + "description": "Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message.", "flatPath": "gmail/v1/users/{userId}/messages/import", "httpMethod": "POST", "id": "gmail.users.messages.import", @@ -953,7 +971,7 @@ "parameters": { "deleted": { "default": "false", - "description": "Mark the email as permanently deleted (not TRASH) and\nonly visible in\nGoogle Vault to\na Vault administrator. Only used for G Suite accounts.", + "description": "Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.", "location": "query", "type": "boolean" }, @@ -964,24 +982,28 @@ "receivedTime", "dateHeader" ], + "enumDescriptions": [ + "Internal message date set to current time when received by Gmail.", + "Internal message time based on 'Date' header in email, when valid." + ], "location": "query", "type": "string" }, "neverMarkSpam": { "default": "false", - "description": "Ignore the Gmail spam classifier decision and never mark\nthis email as SPAM in the mailbox.", + "description": "Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.", "location": "query", "type": "boolean" }, "processForCalendar": { "default": "false", - "description": "Process calendar invites in the email and add any extracted\nmeetings to the Google Calendar for this user.", + "description": "Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.", "location": "query", "type": "boolean" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1002,7 +1024,7 @@ "supportsMediaUpload": true }, "insert": { - "description": "Directly inserts a message into only this user's mailbox similar to\n`IMAP APPEND`, bypassing most scanning and classification.\nDoes not send a message.", + "description": "Directly inserts a message into only this user's mailbox similar to `IMAP APPEND`, bypassing most scanning and classification. Does not send a message.", "flatPath": "gmail/v1/users/{userId}/messages", "httpMethod": "POST", "id": "gmail.users.messages.insert", @@ -1028,7 +1050,7 @@ "parameters": { "deleted": { "default": "false", - "description": "Mark the email as permanently deleted (not TRASH) and\nonly visible in\nGoogle Vault to\na Vault administrator. Only used for G Suite accounts.", + "description": "Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.", "location": "query", "type": "boolean" }, @@ -1039,12 +1061,16 @@ "receivedTime", "dateHeader" ], + "enumDescriptions": [ + "Internal message date set to current time when received by Gmail.", + "Internal message time based on 'Date' header in email, when valid." + ], "location": "query", "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1075,7 +1101,7 @@ "parameters": { "includeSpamTrash": { "default": "false", - "description": "Include messages from `SPAM` and `TRASH`\nin the results.", + "description": "Include messages from `SPAM` and `TRASH` in the results.", "location": "query", "type": "boolean" }, @@ -1098,13 +1124,13 @@ "type": "string" }, "q": { - "description": "Only return messages matching the specified query. Supports the same\nquery format as the Gmail search box. For example,\n`\"from:someuser@example.com rfc822msgid:\nis:unread\"`. Parameter cannot be used when accessing the api\nusing the gmail.metadata scope.", + "description": "Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`. Parameter cannot be used when accessing the api using the gmail.metadata scope.", "location": "query", "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1139,7 +1165,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1158,7 +1184,7 @@ ] }, "send": { - "description": "Sends the specified message to the recipients in the\n`To`, `Cc`, and `Bcc` headers.", + "description": "Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers.", "flatPath": "gmail/v1/users/{userId}/messages/send", "httpMethod": "POST", "id": "gmail.users.messages.send", @@ -1184,7 +1210,7 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1224,7 +1250,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1257,7 +1283,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1301,7 +1327,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1336,7 +1362,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1364,7 +1390,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1392,7 +1418,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1420,7 +1446,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1448,7 +1474,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1466,7 +1492,7 @@ ] }, "updateAutoForwarding": { - "description": "Updates the auto-forwarding setting for the specified account. A verified\nforwarding address must be specified when auto-forwarding is enabled.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "description": "Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority.", "flatPath": "gmail/v1/users/{userId}/settings/autoForwarding", "httpMethod": "PUT", "id": "gmail.users.settings.updateAutoForwarding", @@ -1476,7 +1502,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1504,7 +1530,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1522,7 +1548,7 @@ ] }, "updateLanguage": { - "description": "Updates language settings.\n\nIf successful, the return object contains the `displayLanguage`\nthat was saved for the user, which may differ from the value passed into\nthe request. This is because the requested `displayLanguage` may\nnot be directly supported by Gmail but have a close variant that is, and so\nthe variant may be chosen and saved instead.", + "description": "Updates language settings. If successful, the return object contains the `displayLanguage` that was saved for the user, which may differ from the value passed into the request. This is because the requested `displayLanguage` may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead.", "flatPath": "gmail/v1/users/{userId}/settings/language", "httpMethod": "PUT", "id": "gmail.users.settings.updateLanguage", @@ -1532,7 +1558,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1560,7 +1586,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1588,7 +1614,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1610,7 +1636,7 @@ "delegates": { "methods": { "create": { - "description": "Adds a delegate with its verification status set directly to\n`accepted`, without sending any verification email. The\ndelegate user must be a member of the same G Suite organization as the\ndelegator user.\n\nGmail imposes limitations on the number of delegates and delegators each\nuser in a G Suite organization can have. These limits depend on your\norganization, but in general each user can have up to 25 delegates and\nup to 10 delegators.\n\nNote that a delegate user must be referred to by their primary email\naddress, and not an email alias.\n\nAlso note that when a new delegate is created, there may be up to a one\nminute delay before the new delegate is available for use.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "description": "Adds a delegate with its verification status set directly to `accepted`, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority.", "flatPath": "gmail/v1/users/{userId}/settings/delegates", "httpMethod": "POST", "id": "gmail.users.settings.delegates.create", @@ -1620,7 +1646,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1638,7 +1664,7 @@ ] }, "delete": { - "description": "Removes the specified delegate (which can be of any verification status),\nand revokes any verification that may have been required for using it.\n\nNote that a delegate user must be referred to by their primary email\naddress, and not an email alias.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "description": "Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority.", "flatPath": "gmail/v1/users/{userId}/settings/delegates/{delegateEmail}", "httpMethod": "DELETE", "id": "gmail.users.settings.delegates.delete", @@ -1655,7 +1681,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1667,7 +1693,7 @@ ] }, "get": { - "description": "Gets the specified delegate.\n\nNote that a delegate user must be referred to by their primary email\naddress, and not an email alias.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "description": "Gets the specified delegate. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority.", "flatPath": "gmail/v1/users/{userId}/settings/delegates/{delegateEmail}", "httpMethod": "GET", "id": "gmail.users.settings.delegates.get", @@ -1677,14 +1703,14 @@ ], "parameters": { "delegateEmail": { - "description": "The email address of the user whose delegate relationship is to be\nretrieved.", + "description": "The email address of the user whose delegate relationship is to be retrieved.", "location": "path", "required": true, "type": "string" }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1702,7 +1728,7 @@ ] }, "list": { - "description": "Lists the delegates for the specified account.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "description": "Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.", "flatPath": "gmail/v1/users/{userId}/settings/delegates", "httpMethod": "GET", "id": "gmail.users.settings.delegates.list", @@ -1712,7 +1738,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1744,7 +1770,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1779,7 +1805,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1808,7 +1834,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1836,7 +1862,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1858,7 +1884,7 @@ "forwardingAddresses": { "methods": { "create": { - "description": "Creates a forwarding address. If ownership verification is required, a\nmessage will be sent to the recipient and the resource's verification\nstatus will be set to `pending`; otherwise, the resource will be\ncreated with verification status set to `accepted`.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "description": "Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to `pending`; otherwise, the resource will be created with verification status set to `accepted`. This method is only available to service account clients that have been delegated domain-wide authority.", "flatPath": "gmail/v1/users/{userId}/settings/forwardingAddresses", "httpMethod": "POST", "id": "gmail.users.settings.forwardingAddresses.create", @@ -1868,7 +1894,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1886,7 +1912,7 @@ ] }, "delete": { - "description": "Deletes the specified forwarding address and revokes any verification that\nmay have been required.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "description": "Deletes the specified forwarding address and revokes any verification that may have been required. This method is only available to service account clients that have been delegated domain-wide authority.", "flatPath": "gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}", "httpMethod": "DELETE", "id": "gmail.users.settings.forwardingAddresses.delete", @@ -1903,7 +1929,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1932,7 +1958,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1960,7 +1986,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1982,7 +2008,7 @@ "sendAs": { "methods": { "create": { - "description": "Creates a custom \"from\" send-as alias. If an SMTP MSA is specified, Gmail\nwill attempt to connect to the SMTP service to validate the configuration\nbefore creating the alias. If ownership verification is required for the\nalias, a message will be sent to the email address and the resource's\nverification status will be set to `pending`; otherwise, the\nresource will be created with verification status set to\n`accepted`. If a signature is provided, Gmail will sanitize the\nHTML before saving it with the alias.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "description": "Creates a custom \"from\" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to `pending`; otherwise, the resource will be created with verification status set to `accepted`. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method is only available to service account clients that have been delegated domain-wide authority.", "flatPath": "gmail/v1/users/{userId}/settings/sendAs", "httpMethod": "POST", "id": "gmail.users.settings.sendAs.create", @@ -1992,7 +2018,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2010,7 +2036,7 @@ ] }, "delete": { - "description": "Deletes the specified send-as alias. Revokes any verification that may\nhave been required for using it.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "description": "Deletes the specified send-as alias. Revokes any verification that may have been required for using it. This method is only available to service account clients that have been delegated domain-wide authority.", "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}", "httpMethod": "DELETE", "id": "gmail.users.settings.sendAs.delete", @@ -2027,7 +2053,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2039,7 +2065,7 @@ ] }, "get": { - "description": "Gets the specified send-as alias. Fails with an HTTP 404 error if the\nspecified address is not a member of the collection.", + "description": "Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.", "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}", "httpMethod": "GET", "id": "gmail.users.settings.sendAs.get", @@ -2056,7 +2082,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2074,7 +2100,7 @@ ] }, "list": { - "description": "Lists the send-as aliases for the specified account. The result includes\nthe primary send-as address associated with the account as well as any\ncustom \"from\" aliases.", + "description": "Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom \"from\" aliases.", "flatPath": "gmail/v1/users/{userId}/settings/sendAs", "httpMethod": "GET", "id": "gmail.users.settings.sendAs.list", @@ -2084,7 +2110,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2119,7 +2145,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2138,7 +2164,7 @@ ] }, "update": { - "description": "Updates a send-as alias. If a signature is provided, Gmail will sanitize\nthe HTML before saving it with the alias.\n\nAddresses other than the primary address for the account can only be\nupdated by service account clients that have been delegated domain-wide\nauthority.", + "description": "Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority.", "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}", "httpMethod": "PUT", "id": "gmail.users.settings.sendAs.update", @@ -2155,7 +2181,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2174,7 +2200,7 @@ ] }, "verify": { - "description": "Sends a verification email to the specified send-as alias address.\nThe verification status must be `pending`.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "description": "Sends a verification email to the specified send-as alias address. The verification status must be `pending`. This method is only available to service account clients that have been delegated domain-wide authority.", "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify", "httpMethod": "POST", "id": "gmail.users.settings.sendAs.verify", @@ -2191,7 +2217,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2224,14 +2250,14 @@ "type": "string" }, "sendAsEmail": { - "description": "The email address that appears in the \"From:\" header for mail sent using\nthis alias.", + "description": "The email address that appears in the \"From:\" header for mail sent using this alias.", "location": "path", "required": true, "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2261,14 +2287,14 @@ "type": "string" }, "sendAsEmail": { - "description": "The email address that appears in the \"From:\" header for mail sent using\nthis alias.", + "description": "The email address that appears in the \"From:\" header for mail sent using this alias.", "location": "path", "required": true, "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2287,7 +2313,7 @@ ] }, "insert": { - "description": "Insert (upload) the given S/MIME config for the specified send-as alias.\nNote that pkcs12 format is required for the key.", + "description": "Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.", "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo", "httpMethod": "POST", "id": "gmail.users.settings.sendAs.smimeInfo.insert", @@ -2297,14 +2323,14 @@ ], "parameters": { "sendAsEmail": { - "description": "The email address that appears in the \"From:\" header for mail sent using\nthis alias.", + "description": "The email address that appears in the \"From:\" header for mail sent using this alias.", "location": "path", "required": true, "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2333,14 +2359,14 @@ ], "parameters": { "sendAsEmail": { - "description": "The email address that appears in the \"From:\" header for mail sent using\nthis alias.", + "description": "The email address that appears in the \"From:\" header for mail sent using this alias.", "location": "path", "required": true, "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2376,14 +2402,14 @@ "type": "string" }, "sendAsEmail": { - "description": "The email address that appears in the \"From:\" header for mail sent using\nthis alias.", + "description": "The email address that appears in the \"From:\" header for mail sent using this alias.", "location": "path", "required": true, "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2404,7 +2430,7 @@ "threads": { "methods": { "delete": { - "description": "Immediately and permanently deletes the specified thread. This operation\ncannot be undone. Prefer `threads.trash` instead.", + "description": "Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer `threads.trash` instead.", "flatPath": "gmail/v1/users/{userId}/threads/{id}", "httpMethod": "DELETE", "id": "gmail.users.threads.delete", @@ -2421,7 +2447,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2450,6 +2476,11 @@ "metadata", "minimal" ], + "enumDescriptions": [ + "Returns the full email message data with body content parsed in the `payload` field; the `raw` field is not used. Format cannot be used when accessing the api using the gmail.metadata scope.", + "Returns only email message IDs, labels, and email headers.", + "Returns only email message IDs and labels; does not return the email headers, body, or payload." + ], "location": "query", "type": "string" }, @@ -2467,7 +2498,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2498,7 +2529,7 @@ "parameters": { "includeSpamTrash": { "default": "false", - "description": "Include threads from `SPAM` and `TRASH`\nin the results.", + "description": "Include threads from `SPAM` and `TRASH` in the results.", "location": "query", "type": "boolean" }, @@ -2521,13 +2552,13 @@ "type": "string" }, "q": { - "description": "Only return threads matching the specified query. Supports the same\nquery format as the Gmail search box. For example,\n`\"from:someuser@example.com rfc822msgid:\nis:unread\"`. Parameter cannot be used when accessing the api\nusing the gmail.metadata scope.", + "description": "Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`. Parameter cannot be used when accessing the api using the gmail.metadata scope.", "location": "query", "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2545,7 +2576,7 @@ ] }, "modify": { - "description": "Modifies the labels applied to the thread. This applies to all messages\nin the thread.", + "description": "Modifies the labels applied to the thread. This applies to all messages in the thread.", "flatPath": "gmail/v1/users/{userId}/threads/{id}/modify", "httpMethod": "POST", "id": "gmail.users.threads.modify", @@ -2562,7 +2593,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2598,7 +2629,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2631,7 +2662,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2651,7 +2682,7 @@ } } }, - "revision": "20200720", + "revision": "20200803", "rootUrl": "https://www.googleapis.com/", "schemas": { "AutoForwarding": { @@ -2677,7 +2708,7 @@ "type": "string" }, "emailAddress": { - "description": "Email address to which all incoming messages are forwarded. This email\naddress must be a verified member of the forwarding addresses.", + "description": "Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.", "type": "string" }, "enabled": { @@ -2711,7 +2742,7 @@ "type": "array" }, "ids": { - "description": "The IDs of the messages to modify. There is a limit of 1000 ids per\nrequest.", + "description": "The IDs of the messages to modify. There is a limit of 1000 ids per request.", "items": { "type": "string" }, @@ -2728,7 +2759,7 @@ "type": "object" }, "Delegate": { - "description": "Settings for a delegate. Delegates can read, send, and delete messages, as\nwell as view and add contacts, for the delegator's account. See\n\"Set up\nmail delegation\" for more information about delegates.", + "description": "Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See \"Set up mail delegation\" for more information about delegates.", "id": "Delegate", "properties": { "delegateEmail": { @@ -2736,7 +2767,7 @@ "type": "string" }, "verificationStatus": { - "description": "Indicates whether this address has been verified and can act as a delegate\nfor the account. Read-only.", + "description": "Indicates whether this address has been verified and can act as a delegate for the account. Read-only.", "enum": [ "verificationStatusUnspecified", "accepted", @@ -2747,9 +2778,9 @@ "enumDescriptions": [ "Unspecified verification status.", "The address can act a delegate for the account.", - "A verification request was mailed to the address, and the owner has not\nyet accepted it.", - "A verification request was mailed to the address, and the owner rejected\nit.", - "A verification request was mailed to the address, and it expired without\nverification." + "A verification request was mailed to the address, and the owner has not yet accepted it.", + "A verification request was mailed to the address, and the owner rejected it.", + "A verification request was mailed to the address, and it expired without verification." ], "type": "string" } @@ -2777,7 +2808,7 @@ "type": "object" }, "Filter": { - "description": "Resource definition for Gmail filters. Filters apply to specific messages\ninstead of an entire email thread.", + "description": "Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.", "id": "Filter", "properties": { "action": { @@ -2837,15 +2868,15 @@ "type": "boolean" }, "negatedQuery": { - "description": "Only return messages not matching the specified query. Supports the same\nquery format as the Gmail search box. For example,\n`\"from:someuser@example.com rfc822msgid:\nis:unread\"`.", + "description": "Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`.", "type": "string" }, "query": { - "description": "Only return messages matching the specified query. Supports the same\nquery format as the Gmail search box. For example,\n`\"from:someuser@example.com rfc822msgid:\nis:unread\"`.", + "description": "Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`.", "type": "string" }, "size": { - "description": "The size of the entire RFC822 message in bytes, including all headers and\nattachments.", + "description": "The size of the entire RFC822 message in bytes, including all headers and attachments.", "format": "int32", "type": "integer" }, @@ -2864,11 +2895,11 @@ "type": "string" }, "subject": { - "description": "Case-insensitive phrase found in the message's subject. Trailing and\nleading whitespace are be trimmed and adjacent spaces are collapsed.", + "description": "Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.", "type": "string" }, "to": { - "description": "The recipient's display name or email address. Includes recipients in the\n\"to\", \"cc\", and \"bcc\" header fields. You can use simply the local part of\nthe email address. For example, \"example\" and \"example@\" both match\n\"example@gmail.com\". This field is case-insensitive.", + "description": "The recipient's display name or email address. Includes recipients in the \"to\", \"cc\", and \"bcc\" header fields. You can use simply the local part of the email address. For example, \"example\" and \"example@\" both match \"example@gmail.com\". This field is case-insensitive.", "type": "string" } }, @@ -2883,7 +2914,7 @@ "type": "string" }, "verificationStatus": { - "description": "Indicates whether this address has been verified and is usable for\nforwarding. Read-only.", + "description": "Indicates whether this address has been verified and is usable for forwarding. Read-only.", "enum": [ "verificationStatusUnspecified", "accepted", @@ -2900,7 +2931,7 @@ "type": "object" }, "History": { - "description": "A record of a change to the user's mailbox. Each history change may affect\nmultiple messages in multiple ways.", + "description": "A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways.", "id": "History", "properties": { "id": { @@ -2923,7 +2954,7 @@ "type": "array" }, "messages": { - "description": "List of messages changed in this history record. The fields for specific\nchange types, such as `messagesAdded` may duplicate messages in\nthis field. We recommend using the specific change-type fields instead\nof this.", + "description": "List of messages changed in this history record. The fields for specific change types, such as `messagesAdded` may duplicate messages in this field. We recommend using the specific change-type fields instead of this.", "items": { "$ref": "Message" }, @@ -3001,7 +3032,7 @@ "id": "ImapSettings", "properties": { "autoExpunge": { - "description": "If this value is true, Gmail will immediately expunge a message when it is\nmarked as deleted in IMAP. Otherwise, Gmail will wait for an update from\nthe client before expunging messages marked as deleted.", + "description": "If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.", "type": "boolean" }, "enabled": { @@ -3009,7 +3040,7 @@ "type": "boolean" }, "expungeBehavior": { - "description": "The action that will be executed on a message when it is marked as deleted\nand expunged from the last visible IMAP folder.", + "description": "The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.", "enum": [ "expungeBehaviorUnspecified", "archive", @@ -3020,12 +3051,12 @@ "Unspecified behavior.", "Archive messages marked as deleted.", "Move messages marked as deleted to the trash.", - "Immediately and permanently delete messages marked as deleted. The\nexpunged messages cannot be recovered." + "Immediately and permanently delete messages marked as deleted. The expunged messages cannot be recovered." ], "type": "string" }, "maxFolderSize": { - "description": "An optional limit on the number of messages that an IMAP folder may\ncontain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero\nis interpreted to mean that there is no limit.", + "description": "An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.", "format": "int32", "type": "integer" } @@ -3033,12 +3064,12 @@ "type": "object" }, "Label": { - "description": "Labels are used to categorize messages and threads within the\nuser's mailbox.", + "description": "Labels are used to categorize messages and threads within the user's mailbox.", "id": "Label", "properties": { "color": { "$ref": "LabelColor", - "description": "The color to assign to the label. Color is only available for labels that\nhave their `type` set to `user`.\n@mutable gmail.users.labels.create gmail.users.labels.update" + "description": "The color to assign to the label. Color is only available for labels that have their `type` set to `user`. @mutable gmail.users.labels.create gmail.users.labels.update" }, "id": { "annotations": { @@ -3056,7 +3087,7 @@ "gmail.users.labels.update" ] }, - "description": "The visibility of the label in the label list in the Gmail web interface.\n@mutable gmail.users.labels.create gmail.users.labels.update", + "description": "The visibility of the label in the label list in the Gmail web interface. @mutable gmail.users.labels.create gmail.users.labels.update", "enum": [ "labelShow", "labelShowIfUnread", @@ -3076,7 +3107,7 @@ "gmail.users.labels.update" ] }, - "description": "The visibility of messages with this label in the message list\nin the Gmail web interface.\n@mutable gmail.users.labels.create gmail.users.labels.update", + "description": "The visibility of messages with this label in the message list in the Gmail web interface. @mutable gmail.users.labels.create gmail.users.labels.update", "enum": [ "show", "hide" @@ -3104,7 +3135,7 @@ "gmail.users.labels.update" ] }, - "description": "The display name of the label.\n@mutable gmail.users.labels.create gmail.users.labels.update", + "description": "The display name of the label. @mutable gmail.users.labels.create gmail.users.labels.update", "type": "string" }, "threadsTotal": { @@ -3118,7 +3149,7 @@ "type": "integer" }, "type": { - "description": "The owner type for the label. User labels are created by the user and\ncan be modified and deleted by the user and can be applied to any\nmessage or thread. System labels are internally created and cannot be\nadded, modified, or deleted. System labels may be able to be applied to or\nremoved from messages and threads under some circumstances but this is\nnot guaranteed. For example, users can apply and remove the\n`INBOX` and `UNREAD` labels from messages and\nthreads, but cannot apply or remove the `DRAFTS` or\n`SENT` labels from messages or threads.", + "description": "The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the `INBOX` and `UNREAD` labels from messages and threads, but cannot apply or remove the `DRAFTS` or `SENT` labels from messages or threads.", "enum": [ "system", "user" @@ -3136,22 +3167,22 @@ "id": "LabelColor", "properties": { "backgroundColor": { - "description": "The background color represented as hex string #RRGGBB (ex #000000).\nThis field is required in order to set the color of a label.\nOnly the following predefined set of color values are allowed:\n
\n# 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,\n\n# fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,\n\n# f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,\n\n# efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,\n\n# e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,\n\n# cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,\n\n# ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,\n\n# 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c\n\n# 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,\n\n# 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,\n\n# 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,\n\n# c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,\n\n# 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765\n\n@mutable gmail.users.labels.create gmail.users.labels.update", + "description": "The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 @mutable gmail.users.labels.create gmail.users.labels.update", "type": "string" }, "textColor": { - "description": "The text color of the label, represented as hex string.\nThis field is required in order to set the color of a label.\nOnly the following predefined set of color values are allowed:\n
\n# 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,\n\n# fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,\n\n# f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,\n\n# efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,\n\n# e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,\n\n# cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,\n\n# ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,\n\n# 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c\n\n# 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,\n\n# 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,\n\n# 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,\n\n# c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,\n\n# 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765\n\n@mutable gmail.users.labels.create gmail.users.labels.update", + "description": "The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 @mutable gmail.users.labels.create gmail.users.labels.update", "type": "string" } }, "type": "object" }, "LanguageSettings": { - "description": "Language settings for an account. These settings correspond to\nthe \"Language\nsettings\" feature in the web interface.", + "description": "Language settings for an account. These settings correspond to the \"Language settings\" feature in the web interface.", "id": "LanguageSettings", "properties": { "displayLanguage": { - "description": "The language to display Gmail in, formatted as an\nRFC 3066\nLanguage Tag (for example `en-GB`, `fr` or\n`ja` for British English, French, or Japanese respectively).\n\nThe set of languages supported by Gmail evolves over time, so please refer\nto the \"Language\" dropdown in the\nGmail settings\n for all available options, as described in the\nlanguage settings\nhelp article. A table of sample values is also provided in the\nManaging\nLanguage Settings guide\n\nNot all Gmail clients can display the same set of languages. In the case\nthat a user's display language is not available for use on a particular\nclient, said client automatically chooses to display in the closest\nsupported variant (or a reasonable default).", + "description": "The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example `en-GB`, `fr` or `ja` for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the \"Language\" dropdown in the Gmail settings for all available options, as described in the language settings help article. A table of sample values is also provided in the Managing Language Settings guide Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default).", "type": "string" } }, @@ -3175,7 +3206,7 @@ "id": "ListDraftsResponse", "properties": { "drafts": { - "description": "List of drafts. Note that the `Message` property in each\n`Draft` resource only contains an `id` and a\n`threadId`. The\nmessages.get\nmethod can fetch additional message details.", + "description": "List of drafts. Note that the `Message` property in each `Draft` resource only contains an `id` and a `threadId`. The messages.get method can fetch additional message details.", "items": { "$ref": "Draft" }, @@ -3225,7 +3256,7 @@ "id": "ListHistoryResponse", "properties": { "history": { - "description": "List of history records. Any `messages` contained in the\nresponse will typically only have `id` and\n`threadId` fields populated.", + "description": "List of history records. Any `messages` contained in the response will typically only have `id` and `threadId` fields populated.", "items": { "$ref": "History" }, @@ -3247,7 +3278,7 @@ "id": "ListLabelsResponse", "properties": { "labels": { - "description": "List of labels. Note that each label resource only contains an\n`id`, `name`, `messageListVisibility`,\n`labelListVisibility`, and `type`. The\nlabels.get method\ncan fetch additional label details.", + "description": "List of labels. Note that each label resource only contains an `id`, `name`, `messageListVisibility`, `labelListVisibility`, and `type`. The labels.get method can fetch additional label details.", "items": { "$ref": "Label" }, @@ -3260,7 +3291,7 @@ "id": "ListMessagesResponse", "properties": { "messages": { - "description": "List of messages. Note that each message resource contains only an\n`id` and a `threadId`. Additional message details can\nbe fetched using the\nmessages.get\nmethod.", + "description": "List of messages. Note that each message resource contains only an `id` and a `threadId`. Additional message details can be fetched using the messages.get method.", "items": { "$ref": "Message" }, @@ -3318,7 +3349,7 @@ "type": "integer" }, "threads": { - "description": "List of threads. Note that each thread resource does not contain a list of\n`messages`. The list of `messages` for a given thread\ncan be fetched using the\nthreads.get method.", + "description": "List of threads. Note that each thread resource does not contain a list of `messages`. The list of `messages` for a given thread can be fetched using the threads.get method.", "items": { "$ref": "Thread" }, @@ -3341,12 +3372,12 @@ "type": "string" }, "internalDate": { - "description": "The internal message creation timestamp (epoch ms), which determines\nordering in the inbox. For normal SMTP-received email, this represents the\ntime the message was originally accepted by Google, which is more reliable\nthan the `Date` header. However, for API-migrated mail, it can\nbe configured by client to be based on the `Date` header.", + "description": "The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the `Date` header. However, for API-migrated mail, it can be configured by client to be based on the `Date` header.", "format": "int64", "type": "string" }, "labelIds": { - "description": "List of IDs of labels applied to this message.\n@mutable gmail.users.messages.insert gmail.users.messages.modify", + "description": "List of IDs of labels applied to this message. @mutable gmail.users.messages.insert gmail.users.messages.modify", "items": { "type": "string" }, @@ -3365,7 +3396,7 @@ "gmail.users.messages.send" ] }, - "description": "The entire email message in an RFC 2822 formatted and base64url\nencoded string. Returned in `messages.get` and\n`drafts.get` responses when the `format=RAW`\nparameter is supplied.\n@mutable gmail.users.messages.insert gmail.users.messages.send\n@mutable gmail.users.drafts.create gmail.users.drafts.update", + "description": "The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @mutable gmail.users.messages.insert gmail.users.messages.send @mutable gmail.users.drafts.create gmail.users.drafts.update", "format": "byte", "type": "string" }, @@ -3379,7 +3410,7 @@ "type": "string" }, "threadId": { - "description": "The ID of the thread the message belongs to. To add a message or draft to\na thread, the following criteria must be met:\n
  1. The requested `threadId` must be specified on the\n`Message` or `Draft.Message` you supply with your\nrequest.
    2. \n
  2. The `References` and `In-Reply-To` headers must\nbe set in compliance with the\nRFC 2822 standard.
    3. \n
  3. The `Subject` headers must match.\n@mutable gmail.users.messages.insert gmail.users.messages.send\n@mutable gmail.users.drafts.create gmail.users.drafts.update", + "description": "The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the RFC 2822 standard. 3. The `Subject` headers must match. @mutable gmail.users.messages.insert gmail.users.messages.send @mutable gmail.users.drafts.create gmail.users.drafts.update", "type": "string" } }, @@ -3391,14 +3422,14 @@ "properties": { "body": { "$ref": "MessagePartBody", - "description": "The message part body for this part, which may be empty for\ncontainer MIME message parts." + "description": "The message part body for this part, which may be empty for container MIME message parts." }, "filename": { - "description": "The filename of the attachment. Only present if this message part\nrepresents an attachment.", + "description": "The filename of the attachment. Only present if this message part represents an attachment.", "type": "string" }, "headers": { - "description": "List of headers on this message part. For the top-level message part,\nrepresenting the entire message payload, it will contain the standard\nRFC 2822 email headers such as `To`, `From`, and\n`Subject`.", + "description": "List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.", "items": { "$ref": "MessagePartHeader" }, @@ -3413,7 +3444,7 @@ "type": "string" }, "parts": { - "description": "The child MIME message parts of this part. This only applies to container\nMIME message parts, for example `multipart/*`. For non-\ncontainer MIME message part types, such as `text/plain`, this\nfield is empty. For more information, see\nRFC 1521.", + "description": "The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.", "items": { "$ref": "MessagePart" }, @@ -3427,11 +3458,11 @@ "id": "MessagePartBody", "properties": { "attachmentId": { - "description": "When present, contains the ID of an external attachment that can be\nretrieved in a separate `messages.attachments.get` request.\nWhen not present, the entire content of the message part body is\ncontained in the data field.", + "description": "When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.", "type": "string" }, "data": { - "description": "The body data of a MIME message part as a base64url encoded string.\nMay be empty for MIME container\ntypes that have no message body or when the body data is sent as a\nseparate attachment. An attachment ID is present if the body data is\ncontained in a separate attachment.", + "description": "The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.", "format": "byte", "type": "string" }, @@ -3447,11 +3478,11 @@ "id": "MessagePartHeader", "properties": { "name": { - "description": "The name of the header before the `:` separator. For\nexample, `To`.", + "description": "The name of the header before the `:` separator. For example, `To`.", "type": "string" }, "value": { - "description": "The value of the header after the `:` separator. For example,\n`someuser@example.com`.", + "description": "The value of the header after the `:` separator. For example, `someuser@example.com`.", "type": "string" } }, @@ -3512,13 +3543,13 @@ "enumDescriptions": [ "Unspecified range.", "Indicates that no messages are accessible via POP.", - "Indicates that unfetched messages received after some past point in\ntime are accessible via POP.", + "Indicates that unfetched messages received after some past point in time are accessible via POP.", "Indicates that all unfetched messages are accessible via POP." ], "type": "string" }, "disposition": { - "description": "The action that will be executed on a message after it has been fetched via\nPOP.", + "description": "The action that will be executed on a message after it has been fetched via POP.", "enum": [ "dispositionUnspecified", "leaveInInbox", @@ -3565,43 +3596,43 @@ "type": "object" }, "SendAs": { - "description": "Settings associated with a send-as alias, which can be either the primary\nlogin address associated with the account or a custom \"from\" address.\nSend-as aliases correspond to the\n\"Send Mail As\"\nfeature in the web interface.", + "description": "Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom \"from\" address. Send-as aliases correspond to the \"Send Mail As\" feature in the web interface.", "id": "SendAs", "properties": { "displayName": { - "description": "A name that appears in the \"From:\" header for mail sent using this alias.\nFor custom \"from\" addresses, when this is empty, Gmail will populate the\n\"From:\" header with the name that is used for the primary address\nassociated with the account.\nIf the admin has disabled the ability for users to update their name\nformat, requests to update this field for the primary login will silently\nfail.", + "description": "A name that appears in the \"From:\" header for mail sent using this alias. For custom \"from\" addresses, when this is empty, Gmail will populate the \"From:\" header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.", "type": "string" }, "isDefault": { - "description": "Whether this address is selected as the default \"From:\" address in\nsituations such as composing a new message or sending a vacation\nauto-reply. Every Gmail account has exactly one default send-as address,\nso the only legal value that clients may write to this field is\n`true`. Changing this from `false` to\n`true` for an address will result in this field becoming\n`false` for the other previous default address.", + "description": "Whether this address is selected as the default \"From:\" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is `true`. Changing this from `false` to `true` for an address will result in this field becoming `false` for the other previous default address.", "type": "boolean" }, "isPrimary": { - "description": "Whether this address is the primary address used to login to the account.\nEvery Gmail account has exactly one primary address, and it cannot be\ndeleted from the collection of send-as aliases. This field is read-only.", + "description": "Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.", "type": "boolean" }, "replyToAddress": { - "description": "An optional email address that is included in a \"Reply-To:\" header for mail\nsent using this alias. If this is empty, Gmail will not generate a\n\"Reply-To:\" header.", + "description": "An optional email address that is included in a \"Reply-To:\" header for mail sent using this alias. If this is empty, Gmail will not generate a \"Reply-To:\" header.", "type": "string" }, "sendAsEmail": { - "description": "The email address that appears in the \"From:\" header for mail sent using\nthis alias. This is read-only for all operations except create.", + "description": "The email address that appears in the \"From:\" header for mail sent using this alias. This is read-only for all operations except create.", "type": "string" }, "signature": { - "description": "An optional HTML signature that is included in messages composed with this\nalias in the Gmail web UI.", + "description": "An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.", "type": "string" }, "smtpMsa": { "$ref": "SmtpMsa", - "description": "An optional SMTP service that will be used as an outbound relay for mail\nsent using this alias. If this is empty, outbound mail will be sent\ndirectly from Gmail's servers to the destination SMTP service. This\nsetting only applies to custom \"from\" aliases." + "description": "An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom \"from\" aliases." }, "treatAsAlias": { - "description": "Whether Gmail should \ntreat this address as an alias for the user's primary email address.\nThis setting only applies to custom \"from\" aliases.", + "description": "Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom \"from\" aliases.", "type": "boolean" }, "verificationStatus": { - "description": "Indicates whether this address has been verified for use as a send-as\nalias. Read-only. This setting only applies to custom \"from\" aliases.", + "description": "Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom \"from\" aliases.", "enum": [ "verificationStatusUnspecified", "accepted", @@ -3643,11 +3674,11 @@ "type": "string" }, "pem": { - "description": "PEM formatted X509 concatenated certificate string (standard base64\nencoding). Format used for returning key, which includes public key\nas well as certificate chain (not private key).", + "description": "PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key).", "type": "string" }, "pkcs12": { - "description": "PKCS#12 format containing a single private/public key pair and\ncertificate chain. This format is only accepted from client\nfor creating a new SmimeInfo and is never returned, because the\nprivate key is not intended to be exported. PKCS#12 may be encrypted,\nin which case encryptedKeyPassword should be set appropriately.", + "description": "PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately.", "format": "byte", "type": "string" } @@ -3659,20 +3690,20 @@ "id": "SmtpMsa", "properties": { "host": { - "description": "The hostname of the SMTP service. Required.", + "description": "The hostname of the SMTP service. Required.", "type": "string" }, "password": { - "description": "The password that will be used for authentication with the SMTP service.\nThis is a write-only field that can be specified in requests to create or\nupdate SendAs settings; it is never populated in responses.", + "description": "The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.", "type": "string" }, "port": { - "description": "The port of the SMTP service. Required.", + "description": "The port of the SMTP service. Required.", "format": "int32", "type": "integer" }, "securityMode": { - "description": "The protocol that will be used to secure communication with the SMTP\nservice. Required.", + "description": "The protocol that will be used to secure communication with the SMTP service. Required.", "enum": [ "securityModeUnspecified", "none", @@ -3681,14 +3712,14 @@ ], "enumDescriptions": [ "Unspecified security mode.", - "Communication with the remote SMTP service is unsecured. Requires port\n25.", + "Communication with the remote SMTP service is unsecured. Requires port 25.", "Communication with the remote SMTP service is secured using SSL.", "Communication with the remote SMTP service is secured using STARTTLS." ], "type": "string" }, "username": { - "description": "The username that will be used for authentication with the SMTP service.\nThis is a write-only field that can be specified in requests to create or\nupdate SendAs settings; it is never populated in responses.", + "description": "The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.", "type": "string" } }, @@ -3722,7 +3753,7 @@ "type": "object" }, "VacationSettings": { - "description": "Vacation auto-reply settings for an account. These settings correspond to\nthe \"Vacation\nresponder\" feature in the web interface.", + "description": "Vacation auto-reply settings for an account. These settings correspond to the \"Vacation responder\" feature in the web interface.", "id": "VacationSettings", "properties": { "enableAutoReply": { @@ -3730,32 +3761,32 @@ "type": "boolean" }, "endTime": { - "description": "An optional end time for sending auto-replies (epoch ms).\nWhen this is specified, Gmail will automatically reply only to messages\nthat it receives before the end time. If both `startTime` and\n`endTime` are specified, `startTime` must precede\n`endTime`.", + "description": "An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`.", "format": "int64", "type": "string" }, "responseBodyHtml": { - "description": "Response body in HTML format. Gmail will sanitize the HTML before\nstoring it. If both `response_body_plain_text` and\n`response_body_html` are specified,\n`response_body_html` will be used.", + "description": "Response body in HTML format. Gmail will sanitize the HTML before storing it. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.", "type": "string" }, "responseBodyPlainText": { - "description": "Response body in plain text format. If both\n`response_body_plain_text` and `response_body_html`\nare specified, `response_body_html` will be used.", + "description": "Response body in plain text format. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.", "type": "string" }, "responseSubject": { - "description": "Optional text to prepend to the subject line in vacation responses. In\norder to enable auto-replies, either the response subject or the response\nbody must be nonempty.", + "description": "Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.", "type": "string" }, "restrictToContacts": { - "description": "Flag that determines whether responses are sent to recipients who are not\nin the user's list of contacts.", + "description": "Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.", "type": "boolean" }, "restrictToDomain": { - "description": "Flag that determines whether responses are sent to recipients who are\noutside of the user's domain. This feature is only available for G Suite\nusers.", + "description": "Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for G Suite users.", "type": "boolean" }, "startTime": { - "description": "An optional start time for sending auto-replies (epoch ms).\nWhen this is specified, Gmail will automatically reply only to messages\nthat it receives after the start time. If both `startTime` and\n`endTime` are specified, `startTime` must precede\n`endTime`.", + "description": "An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`.", "format": "int64", "type": "string" } @@ -3773,20 +3804,20 @@ "exclude" ], "enumDescriptions": [ - "Only get push notifications for message changes relating to labelIds\nspecified.", - "Get push notifications for all message changes except those relating\nto labelIds specified." + "Only get push notifications for message changes relating to labelIds specified.", + "Get push notifications for all message changes except those relating to labelIds specified." ], "type": "string" }, "labelIds": { - "description": "List of label_ids to restrict notifications about. By default,\nif unspecified, all changes are pushed out. If specified then\ndictates which labels are required for a push notification to\nbe generated.", + "description": "List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated.", "items": { "type": "string" }, "type": "array" }, "topicName": { - "description": "A fully qualified Google Cloud Pub/Sub API topic name to publish the\nevents to. This topic name **must** already exist in Cloud Pub/Sub and\nyou **must** have already granted gmail \"publish\" permission on it.\nFor example, \"projects/my-project-identifier/topics/my-topic-name\"\n(using the Cloud Pub/Sub \"v1\" topic naming format).\n\nNote that the \"my-project-identifier\" portion must exactly match your\nGoogle developer project id (the one executing this watch request).", + "description": "A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name **must** already exist in Cloud Pub/Sub and you **must** have already granted gmail \"publish\" permission on it. For example, \"projects/my-project-identifier/topics/my-topic-name\" (using the Cloud Pub/Sub \"v1\" topic naming format). Note that the \"my-project-identifier\" portion must exactly match your Google developer project id (the one executing this watch request).", "type": "string" } }, @@ -3797,7 +3828,7 @@ "id": "WatchResponse", "properties": { "expiration": { - "description": "When Gmail will stop sending notifications for mailbox updates\n(epoch millis). Call `watch` again before this time to renew\nthe watch.", + "description": "When Gmail will stop sending notifications for mailbox updates (epoch millis). Call `watch` again before this time to renew the watch.", "format": "int64", "type": "string" }, diff --git a/discovery/osconfig-v1.json b/discovery/osconfig-v1.json index 281b7ebadb..f88984b197 100644 --- a/discovery/osconfig-v1.json +++ b/discovery/osconfig-v1.json @@ -406,7 +406,7 @@ } } }, - "revision": "20200714", + "revision": "20200731", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { @@ -456,6 +456,67 @@ "properties": {}, "type": "object" }, + "ExecResource": { + "description": "A resource that contains custom validation and enforcement steps.", + "id": "ExecResource", + "properties": { + "enforce": { + "$ref": "ExecResourceExec", + "description": "What to run to bring this resource into the desired state.\nOptional if policy is in validate only mode." + }, + "validate": { + "$ref": "ExecResourceExec", + "description": "What to run to validate this resource is in the desired state.\nA successful exit code indicates resource is in the desired state." + } + }, + "type": "object" + }, + "ExecResourceExec": { + "description": "A file or script to execute.", + "id": "ExecResourceExec", + "properties": { + "allowedSuccessCodes": { + "description": "Exit codes that indicate success.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "args": { + "description": "Arguments to use.", + "items": { + "type": "string" + }, + "type": "array" + }, + "file": { + "$ref": "File", + "description": "A remote or local file." + }, + "interpreter": { + "description": "The script interpreter to use.", + "enum": [ + "INTERPRETER_UNSPECIFIED", + "NONE", + "SHELL", + "POWERSHELL" + ], + "enumDescriptions": [ + "Defaults to NONE.", + "If no interpreter is specified the\nsource will be executed directly, which will likely only succeed for\nexecutables and scripts with shebang lines.\n[Wikipedia shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)).", + "Indicates that the script will be run with /bin/sh on Linux and cmd.exe\non windows.", + "Indicates that the script will be run with powershell." + ], + "type": "string" + }, + "script": { + "description": "An inline script.", + "type": "string" + } + }, + "type": "object" + }, "ExecStep": { "description": "A step that runs an executable for a PatchJob.", "id": "ExecStep", @@ -544,6 +605,148 @@ }, "type": "object" }, + "ExtractArchiveResource": { + "description": "A resource that extracts an archive", + "id": "ExtractArchiveResource", + "properties": { + "creates": { + "description": "Local file path that signals this resource is in the desired state.\nThe absence of this file will indicate whether the archive needs to be\nextracted.", + "type": "string" + }, + "destination": { + "description": "Directory to extract archive to.", + "type": "string" + }, + "overwrite": { + "description": "Whether to overwrite existing files during extraction. If this is set to\ntrue, any existing files in the destination location will be overwritten by\nthe extraction.", + "type": "boolean" + }, + "source": { + "$ref": "File", + "description": "The source archive to extract." + }, + "type": { + "description": "The type of the archive to extract.", + "enum": [ + "ARCHIVE_TYPE_UNSPECIFIED", + "TAR", + "TAR_GZIP", + "TAR_BZIP", + "TAR_LZMA", + "TAR_XZ", + "ZIP" + ], + "enumDescriptions": [ + "Unspecified is invalid.", + "Indicates that the archive is a tar archive with no encryption.", + "Indicates that the archive is a tar archive with gzip encryption.", + "Indicates that the archive is a tar archive with bzip encryption.", + "Indicates that the archive is a tar archive with lzma encryption.", + "Indicates that the archive is a tar archive with xz encryption.", + "Indicates that the archive is a zip archive." + ], + "type": "string" + } + }, + "type": "object" + }, + "File": { + "description": "A remote or local file.", + "id": "File", + "properties": { + "allowInsecure": { + "description": "Defaults to false. When false, files will be subject to validations\nbased on the file type:\n\nRemote: A checksum must be specified.\nGCS: An object generation number must be specified.", + "type": "boolean" + }, + "gcs": { + "$ref": "FileGcs", + "description": "A GCS object." + }, + "localPath": { + "description": "A local path to use.", + "type": "string" + }, + "remote": { + "$ref": "FileRemote", + "description": "A generic remote file." + } + }, + "type": "object" + }, + "FileGcs": { + "description": "Specifies a file available as a GCS Object.", + "id": "FileGcs", + "properties": { + "bucket": { + "description": "Bucket of the GCS object.", + "type": "string" + }, + "generation": { + "description": "Generation number of the GCS object.", + "format": "int64", + "type": "string" + }, + "object": { + "description": "Name of the GCS object.", + "type": "string" + } + }, + "type": "object" + }, + "FileRemote": { + "description": "Specifies a file available via some URI.", + "id": "FileRemote", + "properties": { + "sha256Checksum": { + "description": "SHA256 checksum of the remote file.", + "type": "string" + }, + "uri": { + "description": "URI from which to fetch the object. It should contain both the protocol\nand path following the format {protocol}://{location}.", + "type": "string" + } + }, + "type": "object" + }, + "FileResource": { + "description": "A resource that manages the state of a file.", + "id": "FileResource", + "properties": { + "content": { + "description": "A a file with this content.", + "type": "string" + }, + "file": { + "$ref": "File", + "description": "A remote or local source." + }, + "path": { + "description": "The absolute path of the file.", + "type": "string" + }, + "permissions": { + "description": "Consists of three octal digits which represent, in\norder, the permissions of the owner, group, and other users for the\nfile (similarly to the numeric mode used in the linux chmod utility).\nEach digit represents a three bit number with the 4 bit\ncorresponding to the read permissions, the 2 bit corresponds to the\nwrite bit, and the one bit corresponds to the execute permission.\nDefault behavior is 755.\n\nBelow are some examples of permissions and their associated values:\nread, write, and execute: 7\nread and execute: 5\nread and write: 6\nread only: 4", + "type": "string" + }, + "state": { + "description": "Desired state of the file.", + "enum": [ + "DESIRED_STATE_UNSPECIFIED", + "PRESENT", + "ABSENT", + "CONTENTS_MATCH" + ], + "enumDescriptions": [ + "Unspecified is invalid.", + "Ensure file at path is present.", + "Ensure file at path is absent.", + "Ensure the contents of the file at path matches. If the file does not\nexist it will be created." + ], + "type": "string" + } + }, + "type": "object" + }, "FixedOrPercent": { "description": "Message encapsulating a value that can be either absolute (\"fixed\") or\nrelative (\"percent\") to a value.", "id": "FixedOrPercent", @@ -669,6 +872,155 @@ }, "type": "object" }, + "PackageResource": { + "description": "A resource that manages a system package.", + "id": "PackageResource", + "properties": { + "apt": { + "$ref": "PackageResourceAPT", + "description": "A package managed by Apt." + }, + "deb": { + "$ref": "PackageResourceDeb", + "description": "A deb package file." + }, + "desiredState": { + "description": "The desired_state the agent should maintain for this package. The\ndefault is to ensure the package is installed.", + "enum": [ + "DESIRED_STATE_UNSPECIFIED", + "INSTALLED", + "REMOVED" + ], + "enumDescriptions": [ + "Unspecified is invalid.", + "Ensure that the package is installed.", + "The agent will ensure that the package is not installed and uninstall it\nif detected." + ], + "type": "string" + }, + "googet": { + "$ref": "PackageResourceGooGet", + "description": "A package managed by GooGet." + }, + "msi": { + "$ref": "PackageResourceMSI", + "description": "An MSI package." + }, + "rpm": { + "$ref": "PackageResourceRPM", + "description": "An rpm package file." + }, + "yum": { + "$ref": "PackageResourceYUM", + "description": "A package managed by YUM." + }, + "zypper": { + "$ref": "PackageResourceZypper", + "description": "A package managed by Zypper." + } + }, + "type": "object" + }, + "PackageResourceAPT": { + "description": "A package managed by APT.\ninstall: `apt-get update && apt-get -y install [name]`\nremove: `apt-get -y remove [name]`", + "id": "PackageResourceAPT", + "properties": { + "name": { + "description": "Package name.", + "type": "string" + } + }, + "type": "object" + }, + "PackageResourceDeb": { + "description": "A deb package file. dpkg packages only support INSTALLED state.", + "id": "PackageResourceDeb", + "properties": { + "pullDeps": { + "description": "Whether dependencies should also be installed.\ninstall when false: `dpkg -i package`\ninstall when true: `apt-get update && apt-get -y install package.deb`", + "type": "boolean" + }, + "source": { + "$ref": "File", + "description": "A deb package." + } + }, + "type": "object" + }, + "PackageResourceGooGet": { + "description": "A package managed by GooGet.\ninstall: `googet -noconfirm install package`\nremove: `googet -noconfirm remove package`", + "id": "PackageResourceGooGet", + "properties": { + "name": { + "description": "Package name.", + "type": "string" + } + }, + "type": "object" + }, + "PackageResourceMSI": { + "description": "An MSI package. MSI packages only support INSTALLED state.\nInstall msiexec /i /qn /norestart", + "id": "PackageResourceMSI", + "properties": { + "allowedSuccessCodes": { + "description": "Return codes that indicate that the software installed or updated\nsuccessfully. Behaviour defaults to [0]", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "flags": { + "description": "Flags to use during package install.\nAppended to the defalts of \"/i /qn /norestart\"", + "items": { + "type": "string" + }, + "type": "array" + }, + "source": { + "$ref": "File", + "description": "The MSI package." + } + }, + "type": "object" + }, + "PackageResourceRPM": { + "description": "An RPM package file. RPM packages only support INSTALLED state.", + "id": "PackageResourceRPM", + "properties": { + "pullDeps": { + "description": "Whether dependencies should also be installed.\ninstall when false: `rpm --upgrade --replacepkgs package.rpm`\ninstall when true: `yum -y install package.rpm` or\n`zypper -y install package.rpm`", + "type": "boolean" + }, + "source": { + "$ref": "File", + "description": "An rpm package." + } + }, + "type": "object" + }, + "PackageResourceYUM": { + "description": "A package managed by YUM.\ninstall: `yum -y install package`\nremove: `yum -y remove package`", + "id": "PackageResourceYUM", + "properties": { + "name": { + "description": "Package name.", + "type": "string" + } + }, + "type": "object" + }, + "PackageResourceZypper": { + "description": "A package managed by Zypper.\ninstall: `zypper -y install package`\nremove: `zypper -y rm package`", + "id": "PackageResourceZypper", + "properties": { + "name": { + "description": "Package name.", + "type": "string" + } + }, + "type": "object" + }, "PatchConfig": { "description": "Patch configuration specifications. Contains details on how to apply the\npatch(es) to a VM instance.", "id": "PatchConfig", @@ -1147,6 +1499,142 @@ }, "type": "object" }, + "RepositoryResource": { + "description": "A resource that manages a package repository.", + "id": "RepositoryResource", + "properties": { + "apt": { + "$ref": "RepositoryResourceAptRepository", + "description": "An Apt Repository." + }, + "goo": { + "$ref": "RepositoryResourceGooRepository", + "description": "A Goo Repository." + }, + "yum": { + "$ref": "RepositoryResourceYumRepository", + "description": "A Yum Repository." + }, + "zypper": { + "$ref": "RepositoryResourceZypperRepository", + "description": "A Zypper Repository." + } + }, + "type": "object" + }, + "RepositoryResourceAptRepository": { + "description": "Represents a single apt package repository. These will be added to a repo\nfile that will be managed at /etc/apt/sources.list.d/google_osconfig.list.", + "id": "RepositoryResourceAptRepository", + "properties": { + "archiveType": { + "description": "Type of archive files in this repository. The default behavior is DEB.", + "enum": [ + "ARCHIVE_TYPE_UNSPECIFIED", + "DEB", + "DEB_SRC" + ], + "enumDescriptions": [ + "Unspecified is invalid.", + "Deb indicates that the archive contains binary files.", + "Deb-src indicates that the archive contains source files." + ], + "type": "string" + }, + "components": { + "description": "List of components for this repository. Must contain at least one item.", + "items": { + "type": "string" + }, + "type": "array" + }, + "distribution": { + "description": "Distribution of this repository.", + "type": "string" + }, + "gpgKey": { + "description": "URI of the key file for this repository. The agent will maintain\na keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg.", + "type": "string" + }, + "uri": { + "description": "URI for this repository.", + "type": "string" + } + }, + "type": "object" + }, + "RepositoryResourceGooRepository": { + "description": "Represents a Goo package repository. These will be added to a repo file\nthat will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo.", + "id": "RepositoryResourceGooRepository", + "properties": { + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "url": { + "description": "The url of the repository.", + "type": "string" + } + }, + "type": "object" + }, + "RepositoryResourceYumRepository": { + "description": "Represents a single yum package repository. These will be added to a repo\nfile that will be managed at /etc/yum.repos.d/google_osconfig.repo.", + "id": "RepositoryResourceYumRepository", + "properties": { + "baseUrl": { + "description": "The location of the repository directory.", + "type": "string" + }, + "displayName": { + "description": "The display name of the repository.", + "type": "string" + }, + "gpgKeys": { + "description": "URIs of GPG keys.", + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "A one word, unique name for this repository. This will be\nthe `repo id` in the yum config file and also the `display_name` if\n`display_name` is omitted. This id is also used as the unique identifier\nwhen checking for resource conflicts.", + "type": "string" + } + }, + "type": "object" + }, + "RepositoryResourceZypperRepository": { + "description": "Represents a single zypper package repository. These will be added to a\nrepo file that will be managed at /etc/zypp/repos.d/google_osconfig.repo.", + "id": "RepositoryResourceZypperRepository", + "properties": { + "baseUrl": { + "description": "The location of the repository directory.", + "type": "string" + }, + "displayName": { + "description": "The display name of the repository.", + "type": "string" + }, + "gpgKeys": { + "description": "URIs of GPG keys.", + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "A one word, unique name for this repository. This will be\nthe `repo id` in the zypper config file and also the `display_name` if\n`display_name` is omitted. This id is also used as the unique identifier\nwhen checking for GuestPolicy conflicts.", + "type": "string" + } + }, + "type": "object" + }, + "ServiceResource": { + "description": "A resource that manages a system service.", + "id": "ServiceResource", + "properties": {}, + "type": "object" + }, "TimeOfDay": { "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay", diff --git a/discovery/osconfig-v1beta.json b/discovery/osconfig-v1beta.json index b7f41f671e..ebd3771d90 100644 --- a/discovery/osconfig-v1beta.json +++ b/discovery/osconfig-v1beta.json @@ -599,7 +599,7 @@ } } }, - "revision": "20200714", + "revision": "20200731", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptRepository": { @@ -837,6 +837,67 @@ "properties": {}, "type": "object" }, + "ExecResource": { + "description": "A resource that contains custom validation and enforcement steps.", + "id": "ExecResource", + "properties": { + "enforce": { + "$ref": "ExecResourceExec", + "description": "What to run to bring this resource into the desired state.\nOptional if policy is in validate only mode." + }, + "validate": { + "$ref": "ExecResourceExec", + "description": "What to run to validate this resource is in the desired state.\nA successful exit code indicates resource is in the desired state." + } + }, + "type": "object" + }, + "ExecResourceExec": { + "description": "A file or script to execute.", + "id": "ExecResourceExec", + "properties": { + "allowedSuccessCodes": { + "description": "Exit codes that indicate success.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "args": { + "description": "Arguments to use.", + "items": { + "type": "string" + }, + "type": "array" + }, + "file": { + "$ref": "File", + "description": "A remote or local file." + }, + "interpreter": { + "description": "The script interpreter to use.", + "enum": [ + "INTERPRETER_UNSPECIFIED", + "NONE", + "SHELL", + "POWERSHELL" + ], + "enumDescriptions": [ + "Defaults to NONE.", + "If no interpreter is specified the\nsource will be executed directly, which will likely only succeed for\nexecutables and scripts with shebang lines.\n[Wikipedia shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)).", + "Indicates that the script will be run with /bin/sh on Linux and cmd.exe\non windows.", + "Indicates that the script will be run with powershell." + ], + "type": "string" + }, + "script": { + "description": "An inline script.", + "type": "string" + } + }, + "type": "object" + }, "ExecStep": { "description": "A step that runs an executable for a PatchJob.", "id": "ExecStep", @@ -925,6 +986,148 @@ }, "type": "object" }, + "ExtractArchiveResource": { + "description": "A resource that extracts an archive", + "id": "ExtractArchiveResource", + "properties": { + "creates": { + "description": "Local file path that signals this resource is in the desired state.\nThe absence of this file will indicate whether the archive needs to be\nextracted.", + "type": "string" + }, + "destination": { + "description": "Directory to extract archive to.", + "type": "string" + }, + "overwrite": { + "description": "Whether to overwrite existing files during extraction. If this is set to\ntrue, any existing files in the destination location will be overwritten by\nthe extraction.", + "type": "boolean" + }, + "source": { + "$ref": "File", + "description": "The source archive to extract." + }, + "type": { + "description": "The type of the archive to extract.", + "enum": [ + "ARCHIVE_TYPE_UNSPECIFIED", + "TAR", + "TAR_GZIP", + "TAR_BZIP", + "TAR_LZMA", + "TAR_XZ", + "ZIP" + ], + "enumDescriptions": [ + "Unspecified is invalid.", + "Indicates that the archive is a tar archive with no encryption.", + "Indicates that the archive is a tar archive with gzip encryption.", + "Indicates that the archive is a tar archive with bzip encryption.", + "Indicates that the archive is a tar archive with lzma encryption.", + "Indicates that the archive is a tar archive with xz encryption.", + "Indicates that the archive is a zip archive." + ], + "type": "string" + } + }, + "type": "object" + }, + "File": { + "description": "A remote or local file.", + "id": "File", + "properties": { + "allowInsecure": { + "description": "Defaults to false. When false, files will be subject to validations\nbased on the file type:\n\nRemote: A checksum must be specified.\nGCS: An object generation number must be specified.", + "type": "boolean" + }, + "gcs": { + "$ref": "FileGcs", + "description": "A GCS object." + }, + "localPath": { + "description": "A local path to use.", + "type": "string" + }, + "remote": { + "$ref": "FileRemote", + "description": "A generic remote file." + } + }, + "type": "object" + }, + "FileGcs": { + "description": "Specifies a file available as a GCS Object.", + "id": "FileGcs", + "properties": { + "bucket": { + "description": "Bucket of the GCS object.", + "type": "string" + }, + "generation": { + "description": "Generation number of the GCS object.", + "format": "int64", + "type": "string" + }, + "object": { + "description": "Name of the GCS object.", + "type": "string" + } + }, + "type": "object" + }, + "FileRemote": { + "description": "Specifies a file available via some URI.", + "id": "FileRemote", + "properties": { + "sha256Checksum": { + "description": "SHA256 checksum of the remote file.", + "type": "string" + }, + "uri": { + "description": "URI from which to fetch the object. It should contain both the protocol\nand path following the format {protocol}://{location}.", + "type": "string" + } + }, + "type": "object" + }, + "FileResource": { + "description": "A resource that manages the state of a file.", + "id": "FileResource", + "properties": { + "content": { + "description": "A a file with this content.", + "type": "string" + }, + "file": { + "$ref": "File", + "description": "A remote or local source." + }, + "path": { + "description": "The absolute path of the file.", + "type": "string" + }, + "permissions": { + "description": "Consists of three octal digits which represent, in\norder, the permissions of the owner, group, and other users for the\nfile (similarly to the numeric mode used in the linux chmod utility).\nEach digit represents a three bit number with the 4 bit\ncorresponding to the read permissions, the 2 bit corresponds to the\nwrite bit, and the one bit corresponds to the execute permission.\nDefault behavior is 755.\n\nBelow are some examples of permissions and their associated values:\nread, write, and execute: 7\nread and execute: 5\nread and write: 6\nread only: 4", + "type": "string" + }, + "state": { + "description": "Desired state of the file.", + "enum": [ + "DESIRED_STATE_UNSPECIFIED", + "PRESENT", + "ABSENT", + "CONTENTS_MATCH" + ], + "enumDescriptions": [ + "Unspecified is invalid.", + "Ensure file at path is present.", + "Ensure file at path is absent.", + "Ensure the contents of the file at path matches. If the file does not\nexist it will be created." + ], + "type": "string" + } + }, + "type": "object" + }, "FixedOrPercent": { "description": "Message encapsulating a value that can be either absolute (\"fixed\") or\nrelative (\"percent\") to a value.", "id": "FixedOrPercent", @@ -1226,6 +1429,155 @@ }, "type": "object" }, + "PackageResource": { + "description": "A resource that manages a system package.", + "id": "PackageResource", + "properties": { + "apt": { + "$ref": "PackageResourceAPT", + "description": "A package managed by Apt." + }, + "deb": { + "$ref": "PackageResourceDeb", + "description": "A deb package file." + }, + "desiredState": { + "description": "The desired_state the agent should maintain for this package. The\ndefault is to ensure the package is installed.", + "enum": [ + "DESIRED_STATE_UNSPECIFIED", + "INSTALLED", + "REMOVED" + ], + "enumDescriptions": [ + "Unspecified is invalid.", + "Ensure that the package is installed.", + "The agent will ensure that the package is not installed and uninstall it\nif detected." + ], + "type": "string" + }, + "googet": { + "$ref": "PackageResourceGooGet", + "description": "A package managed by GooGet." + }, + "msi": { + "$ref": "PackageResourceMSI", + "description": "An MSI package." + }, + "rpm": { + "$ref": "PackageResourceRPM", + "description": "An rpm package file." + }, + "yum": { + "$ref": "PackageResourceYUM", + "description": "A package managed by YUM." + }, + "zypper": { + "$ref": "PackageResourceZypper", + "description": "A package managed by Zypper." + } + }, + "type": "object" + }, + "PackageResourceAPT": { + "description": "A package managed by APT.\ninstall: `apt-get update && apt-get -y install [name]`\nremove: `apt-get -y remove [name]`", + "id": "PackageResourceAPT", + "properties": { + "name": { + "description": "Package name.", + "type": "string" + } + }, + "type": "object" + }, + "PackageResourceDeb": { + "description": "A deb package file. dpkg packages only support INSTALLED state.", + "id": "PackageResourceDeb", + "properties": { + "pullDeps": { + "description": "Whether dependencies should also be installed.\ninstall when false: `dpkg -i package`\ninstall when true: `apt-get update && apt-get -y install package.deb`", + "type": "boolean" + }, + "source": { + "$ref": "File", + "description": "A deb package." + } + }, + "type": "object" + }, + "PackageResourceGooGet": { + "description": "A package managed by GooGet.\ninstall: `googet -noconfirm install package`\nremove: `googet -noconfirm remove package`", + "id": "PackageResourceGooGet", + "properties": { + "name": { + "description": "Package name.", + "type": "string" + } + }, + "type": "object" + }, + "PackageResourceMSI": { + "description": "An MSI package. MSI packages only support INSTALLED state.\nInstall msiexec /i /qn /norestart", + "id": "PackageResourceMSI", + "properties": { + "allowedSuccessCodes": { + "description": "Return codes that indicate that the software installed or updated\nsuccessfully. Behaviour defaults to [0]", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "flags": { + "description": "Flags to use during package install.\nAppended to the defalts of \"/i /qn /norestart\"", + "items": { + "type": "string" + }, + "type": "array" + }, + "source": { + "$ref": "File", + "description": "The MSI package." + } + }, + "type": "object" + }, + "PackageResourceRPM": { + "description": "An RPM package file. RPM packages only support INSTALLED state.", + "id": "PackageResourceRPM", + "properties": { + "pullDeps": { + "description": "Whether dependencies should also be installed.\ninstall when false: `rpm --upgrade --replacepkgs package.rpm`\ninstall when true: `yum -y install package.rpm` or\n`zypper -y install package.rpm`", + "type": "boolean" + }, + "source": { + "$ref": "File", + "description": "An rpm package." + } + }, + "type": "object" + }, + "PackageResourceYUM": { + "description": "A package managed by YUM.\ninstall: `yum -y install package`\nremove: `yum -y remove package`", + "id": "PackageResourceYUM", + "properties": { + "name": { + "description": "Package name.", + "type": "string" + } + }, + "type": "object" + }, + "PackageResourceZypper": { + "description": "A package managed by Zypper.\ninstall: `zypper -y install package`\nremove: `zypper -y rm package`", + "id": "PackageResourceZypper", + "properties": { + "name": { + "description": "Package name.", + "type": "string" + } + }, + "type": "object" + }, "PatchConfig": { "description": "Patch configuration specifications. Contains details on how to apply the\npatch(es) to a VM instance.", "id": "PatchConfig", @@ -1704,6 +2056,142 @@ }, "type": "object" }, + "RepositoryResource": { + "description": "A resource that manages a package repository.", + "id": "RepositoryResource", + "properties": { + "apt": { + "$ref": "RepositoryResourceAptRepository", + "description": "An Apt Repository." + }, + "goo": { + "$ref": "RepositoryResourceGooRepository", + "description": "A Goo Repository." + }, + "yum": { + "$ref": "RepositoryResourceYumRepository", + "description": "A Yum Repository." + }, + "zypper": { + "$ref": "RepositoryResourceZypperRepository", + "description": "A Zypper Repository." + } + }, + "type": "object" + }, + "RepositoryResourceAptRepository": { + "description": "Represents a single apt package repository. These will be added to a repo\nfile that will be managed at /etc/apt/sources.list.d/google_osconfig.list.", + "id": "RepositoryResourceAptRepository", + "properties": { + "archiveType": { + "description": "Type of archive files in this repository. The default behavior is DEB.", + "enum": [ + "ARCHIVE_TYPE_UNSPECIFIED", + "DEB", + "DEB_SRC" + ], + "enumDescriptions": [ + "Unspecified is invalid.", + "Deb indicates that the archive contains binary files.", + "Deb-src indicates that the archive contains source files." + ], + "type": "string" + }, + "components": { + "description": "List of components for this repository. Must contain at least one item.", + "items": { + "type": "string" + }, + "type": "array" + }, + "distribution": { + "description": "Distribution of this repository.", + "type": "string" + }, + "gpgKey": { + "description": "URI of the key file for this repository. The agent will maintain\na keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg.", + "type": "string" + }, + "uri": { + "description": "URI for this repository.", + "type": "string" + } + }, + "type": "object" + }, + "RepositoryResourceGooRepository": { + "description": "Represents a Goo package repository. These will be added to a repo file\nthat will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo.", + "id": "RepositoryResourceGooRepository", + "properties": { + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "url": { + "description": "The url of the repository.", + "type": "string" + } + }, + "type": "object" + }, + "RepositoryResourceYumRepository": { + "description": "Represents a single yum package repository. These will be added to a repo\nfile that will be managed at /etc/yum.repos.d/google_osconfig.repo.", + "id": "RepositoryResourceYumRepository", + "properties": { + "baseUrl": { + "description": "The location of the repository directory.", + "type": "string" + }, + "displayName": { + "description": "The display name of the repository.", + "type": "string" + }, + "gpgKeys": { + "description": "URIs of GPG keys.", + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "A one word, unique name for this repository. This will be\nthe `repo id` in the yum config file and also the `display_name` if\n`display_name` is omitted. This id is also used as the unique identifier\nwhen checking for resource conflicts.", + "type": "string" + } + }, + "type": "object" + }, + "RepositoryResourceZypperRepository": { + "description": "Represents a single zypper package repository. These will be added to a\nrepo file that will be managed at /etc/zypp/repos.d/google_osconfig.repo.", + "id": "RepositoryResourceZypperRepository", + "properties": { + "baseUrl": { + "description": "The location of the repository directory.", + "type": "string" + }, + "displayName": { + "description": "The display name of the repository.", + "type": "string" + }, + "gpgKeys": { + "description": "URIs of GPG keys.", + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "A one word, unique name for this repository. This will be\nthe `repo id` in the zypper config file and also the `display_name` if\n`display_name` is omitted. This id is also used as the unique identifier\nwhen checking for GuestPolicy conflicts.", + "type": "string" + } + }, + "type": "object" + }, + "ServiceResource": { + "description": "A resource that manages a system service.", + "id": "ServiceResource", + "properties": {}, + "type": "object" + }, "SoftwareRecipe": { "description": "A software recipe is a set of instructions for installing and configuring a\npiece of software. It consists of a set of artifacts that are\ndownloaded, and a set of steps that install, configure, and/or update the\nsoftware.\n\nRecipes support installing and updating software from artifacts in the\nfollowing formats:\nZip archive, Tar archive, Windows MSI, Debian package, and RPM package.\n\nAdditionally, recipes support executing a script (either defined in a file or\ndirectly in this api) in bash, sh, cmd, and powershell.\n\nUpdating a software recipe\n\nIf a recipe is assigned to an instance and there is a recipe with the same\nname but a lower version already installed and the assigned state\nof the recipe is `UPDATED`, then the recipe is updated to\nthe new version.\n\nScript Working Directories\n\nEach script or execution step is run in its own temporary directory which\nis deleted after completing the step.", "id": "SoftwareRecipe", diff --git a/discovery/pubsub-v1.json b/discovery/pubsub-v1.json index 7599742902..04a0bbd222 100644 --- a/discovery/pubsub-v1.json +++ b/discovery/pubsub-v1.json @@ -1119,7 +1119,7 @@ } } }, - "revision": "20200726", + "revision": "20200731", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -1634,6 +1634,10 @@ "$ref": "DeadLetterPolicy", "description": "A policy that specifies the conditions for dead lettering messages in\nthis subscription. If dead_letter_policy is not set, dead lettering\nis disabled.\n\nThe Cloud Pub/Sub service account associated with this subscriptions's\nparent project (i.e.,\nservice-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have\npermission to Acknowledge() messages on this subscription." }, + "detached": { + "description": "Indicates whether the subscription is detached from its topic. Detached\nsubscriptions don't receive messages from their topic and don't retain any\nbacklog. `Pull` and `StreamingPull` requests will return\nFAILED_PRECONDITION. If the subscription is a push subscription, pushes to\nthe endpoint will not be made.", + "type": "boolean" + }, "enableMessageOrdering": { "description": "If true, messages published with the same `ordering_key` in `PubsubMessage`\nwill be delivered to the subscribers in the order in which they\nare received by the Pub/Sub system. Otherwise, they may be delivered in\nany order.", "type": "boolean" diff --git a/discovery/recommendationengine-v1beta1.json b/discovery/recommendationengine-v1beta1.json index bb56e78e6e..8c2bed3a22 100644 --- a/discovery/recommendationengine-v1beta1.json +++ b/discovery/recommendationengine-v1beta1.json @@ -121,13 +121,13 @@ ], "parameters": { "pageSize": { - "description": "Optional. Maximum number of results to return. If unspecified, defaults\nto 50. Max allowed value is 1000.", + "description": "Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A page token, received from a previous `ListCatalogs`\ncall. Provide this to retrieve the subsequent page.", + "description": "Optional. A page token, received from a previous `ListCatalogs` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, @@ -164,7 +164,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. Indicates which fields in the provided 'recommendation_model' to\nupdate. If not set, will only update the catalog_item_level_config field.", + "description": "Optional. Indicates which fields in the provided 'recommendation_model' to update. If not set, will only update the catalog_item_level_config field.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -195,7 +195,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent catalog resource name, such as\n\"projects/*/locations/global/catalogs/default_catalog\".", + "description": "Required. The parent catalog resource name, such as \"projects/*/locations/global/catalogs/default_catalog\".", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", "required": true, @@ -223,7 +223,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of catalog item, such as\n\"projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id\".", + "description": "Required. Full resource name of catalog item, such as \"projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id\".", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/catalogItems/.*$", "required": true, @@ -248,7 +248,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of catalog item, such as\n\"projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id\".", + "description": "Required. Full resource name of catalog item, such as \"projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id\".", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/catalogItems/.*$", "required": true, @@ -263,38 +263,8 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getGroupIdItems": { - "description": "Method for getting the catalog items associated with item group id.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/catalogItems:groupIdItems", - "httpMethod": "GET", - "id": "recommendationengine.projects.locations.catalogs.catalogItems.getGroupIdItems", - "parameterOrder": [ - "parent" - ], - "parameters": { - "itemGroupId": { - "description": "Required. Catalog item identifier for prediction results.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Parent resource name of group id item, such as\n\"projects/*/locations/global/catalogs/default_catalog\".", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/catalogItems:groupIdItems", - "response": { - "$ref": "GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "import": { - "description": "Bulk import of multiple catalog items. Request processing may be\nsynchronous. No partial updating supported. Non-existing items will be\ncreated.\n\nOperation.response is of type ImportResponse. Note that it is\npossible for a subset of the items to be successfully updated.", + "description": "Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/catalogItems:import", "httpMethod": "POST", "id": "recommendationengine.projects.locations.catalogs.catalogItems.import", @@ -303,7 +273,7 @@ ], "parameters": { "parent": { - "description": "Required. \"projects/1234/locations/global/catalogs/default_catalog\"\n\nIf no updateMask is specified, requires catalogItems.create permission.\nIf updateMask is specified, requires catalogItems.update permission.", + "description": "Required. \"projects/1234/locations/global/catalogs/default_catalog\" If no updateMask is specified, requires catalogItems.create permission. If updateMask is specified, requires catalogItems.update permission.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", "required": true, @@ -336,7 +306,7 @@ "type": "string" }, "pageSize": { - "description": "Optional. Maximum number of results to return per page. If zero, the\nservice will choose a reasonable default.", + "description": "Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.", "format": "int32", "location": "query", "type": "integer" @@ -347,7 +317,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent catalog resource name, such as\n\"projects/*/locations/global/catalogs/default_catalog\".", + "description": "Required. The parent catalog resource name, such as \"projects/*/locations/global/catalogs/default_catalog\".", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", "required": true, @@ -363,7 +333,7 @@ ] }, "patch": { - "description": "Updates a catalog item. Partial updating is supported. Non-existing\nitems will be created.", + "description": "Updates a catalog item. Partial updating is supported. Non-existing items will be created.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/catalogItems/{catalogItemsId}", "httpMethod": "PATCH", "id": "recommendationengine.projects.locations.catalogs.catalogItems.patch", @@ -372,14 +342,14 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of catalog item, such as\n\"projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id\".", + "description": "Required. Full resource name of catalog item, such as \"projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id\".", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/catalogItems/.*$", "required": true, "type": "string" }, "updateMask": { - "description": "Optional. Indicates which fields in the provided 'item' to update. If not\nset, will by default update all fields.", + "description": "Optional. Indicates which fields in the provided 'item' to update. If not set, will by default update all fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -403,7 +373,7 @@ "operations": { "methods": { "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/operations/{operationsId}", "httpMethod": "GET", "id": "recommendationengine.projects.locations.catalogs.eventStores.operations.get", @@ -428,7 +398,7 @@ ] }, "list": { - "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/operations", "httpMethod": "GET", "id": "recommendationengine.projects.locations.catalogs.eventStores.operations.list", @@ -473,7 +443,7 @@ "placements": { "methods": { "predict": { - "description": "Makes a recommendation prediction. If using API Key based authentication,\nthe API Key must be registered using the\nPredictionApiKeyRegistry\nservice. [Learn more](/recommendations-ai/docs/setting-up#register-key).", + "description": "Makes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. [Learn more](/recommendations-ai/docs/setting-up#register-key).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/placements/{placementsId}:predict", "httpMethod": "POST", "id": "recommendationengine.projects.locations.catalogs.eventStores.placements.predict", @@ -482,7 +452,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of the format:\n{name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}\nThe id of the recommendation engine placement. This id is used to identify\nthe set of models that will be used to make the prediction.\n\nWe currently support three placements with the following IDs by default:\n\n* `shopping_cart`: Predicts items frequently bought together with one or\n more catalog items in the same shopping session. Commonly displayed after\n `add-to-cart` events, on product detail pages, or on the shopping cart\n page.\n\n* `home_page`: Predicts the next product that a user will most likely\n engage with or purchase based on the shopping or viewing history of the\n specified `userId` or `visitorId`. For example - Recommendations for you.\n\n* `product_detail`: Predicts the next product that a user will most likely\n engage with or purchase. The prediction is based on the shopping or\n viewing history of the specified `userId` or `visitorId` and its\n relevance to a specified `CatalogItem`. Typically used on product detail\n pages. For example - More items like this.\n\n* `recently_viewed_default`: Returns up to 75 items recently viewed by the\n specified `userId` or `visitorId`, most recent ones first. Returns\n nothing if neither of them has viewed any items yet. For example -\n Recently viewed.\n\nThe full list of available placements can be seen at\nhttps://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard", + "description": "Required. Full resource name of the format: {name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*} The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default: * `shopping_cart`: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after `add-to-cart` events, on product detail pages, or on the shopping cart page. * `home_page`: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified `userId` or `visitorId`. For example - Recommendations for you. * `product_detail`: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified `userId` or `visitorId` and its relevance to a specified `CatalogItem`. Typically used on product detail pages. For example - More items like this. * `recently_viewed_default`: Returns up to 75 items recently viewed by the specified `userId` or `visitorId`, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+/placements/[^/]+$", "required": true, @@ -514,7 +484,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource path.\n\"projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store\".", + "description": "Required. The parent resource path. \"projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store\".", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", "required": true, @@ -542,7 +512,7 @@ ], "parameters": { "name": { - "description": "Required. The API key to unregister including full resource path.\n\"projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/\"", + "description": "Required. The API key to unregister including full resource path. \"projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/\"", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+/predictionApiKeyRegistrations/[^/]+$", "required": true, @@ -567,7 +537,7 @@ ], "parameters": { "pageSize": { - "description": "Optional. Maximum number of results to return per page. If unset, the\nservice will choose a reasonable default.", + "description": "Optional. Maximum number of results to return per page. If unset, the service will choose a reasonable default.", "format": "int32", "location": "query", "type": "integer" @@ -578,7 +548,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent placement resource name such as\n\"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store\"", + "description": "Required. The parent placement resource name such as \"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store\"", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", "required": true, @@ -598,7 +568,7 @@ "userEvents": { "methods": { "collect": { - "description": "Writes a single user event from the browser. This uses a GET request to\ndue to browser restriction of POST-ing to a 3rd party domain.\n\nThis method is used only by the Recommendations AI JavaScript pixel.\nUsers should not call this method directly.", + "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Recommendations AI JavaScript pixel. Users should not call this method directly.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/userEvents:collect", "httpMethod": "GET", "id": "recommendationengine.projects.locations.catalogs.eventStores.userEvents.collect", @@ -607,20 +577,20 @@ ], "parameters": { "ets": { - "description": "Optional. The event timestamp in milliseconds. This prevents browser caching of\notherwise identical get requests. The name is abbreviated to reduce the\npayload bytes.", + "description": "Optional. The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", "format": "int64", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent eventStore name, such as\n\"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store\".", + "description": "Required. The parent eventStore name, such as \"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store\".", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", "required": true, "type": "string" }, "uri": { - "description": "Optional. The url including cgi-parameters but excluding the hash fragment. The URL\nmust be truncated to 1.5K bytes to conservatively be under the 2K bytes.\nThis is often more useful than the referer url, because many browsers only\nsend the domain for 3rd party requests.", + "description": "Optional. The url including cgi-parameters but excluding the hash fragment. The URL must be truncated to 1.5K bytes to conservatively be under the 2K bytes. This is often more useful than the referer url, because many browsers only send the domain for 3rd party requests.", "location": "query", "type": "string" }, @@ -639,7 +609,7 @@ ] }, "import": { - "description": "Bulk import of User events. Request processing might be\nsynchronous. Events that already exist are skipped.\nUse this method for backfilling historical user events.\n\nOperation.response is of type ImportResponse. Note that it is\npossible for a subset of the items to be successfully inserted.\nOperation.metadata is of type ImportMetadata.", + "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/userEvents:import", "httpMethod": "POST", "id": "recommendationengine.projects.locations.catalogs.eventStores.userEvents.import", @@ -667,7 +637,7 @@ ] }, "list": { - "description": "Gets a list of user events within a time range, with potential filtering.\nThe method does not list unjoined user events.\n\nUnjoined user event definition: when a user event is ingested from\nRecommendations AI User Event APIs, the catalog item included in the user\nevent is connected with the current catalog. If a catalog item of the\ningested event is not in the current catalog, it could lead to degraded\nmodel quality. This is called an unjoined event.", + "description": "Gets a list of user events within a time range, with potential filtering. The method does not list unjoined user events. Unjoined user event definition: when a user event is ingested from Recommendations AI User Event APIs, the catalog item included in the user event is connected with the current catalog. If a catalog item of the ingested event is not in the current catalog, it could lead to degraded model quality. This is called an unjoined event.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/userEvents", "httpMethod": "GET", "id": "recommendationengine.projects.locations.catalogs.eventStores.userEvents.list", @@ -676,12 +646,12 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering expression to specify restrictions over\nreturned events. This is a sequence of terms, where each term applies some\nkind of a restriction to the returned user events. Use this expression to\nrestrict results to a specific time range, or filter events by eventType.\n eg: eventTime > \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems\n eventTime<\"2012-04-23T18:25:43.511Z\" eventType=search\n\n We expect only 3 types of fields:\n\n * eventTime: this can be specified a maximum of 2 times, once with a\n less than operator and once with a greater than operator. The\n eventTime restrict should result in one contiguous valid eventTime\n range.\n\n * eventType: only 1 eventType restriction can be specified.\n\n * eventsMissingCatalogItems: specififying this will restrict results\n to events for which catalog items were not found in the catalog. The\n default behavior is to return only those events for which catalog\n items were found.\n\n Some examples of valid filters expressions:\n\n * Example 1: eventTime > \"2012-04-23T18:25:43.511Z\"\n eventTime < \"2012-04-23T18:30:43.511Z\"\n * Example 2: eventTime > \"2012-04-23T18:25:43.511Z\"\n eventType = detail-page-view\n * Example 3: eventsMissingCatalogItems\n eventType = search eventTime < \"2018-04-23T18:30:43.511Z\"\n * Example 4: eventTime > \"2012-04-23T18:25:43.511Z\"\n * Example 5: eventType = search\n * Example 6: eventsMissingCatalogItems", + "description": "Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems eventTime<\"2012-04-23T18:25:43.511Z\" eventType=search We expect only 3 types of fields: * eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range. * eventType: only 1 eventType restriction can be specified. * eventsMissingCatalogItems: specififying this will restrict results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\" * Example 2: eventTime > \"2012-04-23T18:25:43.511Z\" eventType = detail-page-view * Example 3: eventsMissingCatalogItems eventType = search eventTime < \"2018-04-23T18:30:43.511Z\" * Example 4: eventTime > \"2012-04-23T18:25:43.511Z\" * Example 5: eventType = search * Example 6: eventsMissingCatalogItems", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. Maximum number of results to return per page. If zero, the\nservice will choose a reasonable default.", + "description": "Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.", "format": "int32", "location": "query", "type": "integer" @@ -692,7 +662,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent eventStore resource name, such as\n\"projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store\".", + "description": "Required. The parent eventStore resource name, such as \"projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store\".", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", "required": true, @@ -708,7 +678,7 @@ ] }, "purge": { - "description": "Deletes permanently all user events specified by the filter provided.\nDepending on the number of events specified by the filter, this operation\ncould take hours or days to complete. To test a filter, use the list\ncommand first.", + "description": "Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/userEvents:purge", "httpMethod": "POST", "id": "recommendationengine.projects.locations.catalogs.eventStores.userEvents.purge", @@ -717,7 +687,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the event_store under which the events are\ncreated. The format is\n\"projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}\"", + "description": "Required. The resource name of the event_store under which the events are created. The format is \"projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}\"", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", "required": true, @@ -736,7 +706,7 @@ ] }, "rejoin": { - "description": "Triggers a user event rejoin operation with latest catalog data. Events\nwill not be annotated with detailed catalog information if catalog item is\nmissing at the time the user event is ingested, and these events are stored\nas unjoined events with a limited usage on training and serving. This API\ncan be used to trigger a 'join' operation on specified events with latest\nversion of catalog items. It can also be used to correct events joined with\nwrong catalog items.", + "description": "Triggers a user event rejoin operation with latest catalog data. Events will not be annotated with detailed catalog information if catalog item is missing at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This API can be used to trigger a 'join' operation on specified events with latest version of catalog items. It can also be used to correct events joined with wrong catalog items.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/userEvents:rejoin", "httpMethod": "POST", "id": "recommendationengine.projects.locations.catalogs.eventStores.userEvents.rejoin", @@ -745,7 +715,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of user event, such as\n\"projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store\".", + "description": "Required. Full resource name of user event, such as \"projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store\".", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", "required": true, @@ -773,7 +743,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent eventStore resource name, such as\n\"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store\".", + "description": "Required. The parent eventStore resource name, such as \"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store\".", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", "required": true, @@ -798,7 +768,7 @@ "operations": { "methods": { "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/operations/{operationsId}", "httpMethod": "GET", "id": "recommendationengine.projects.locations.catalogs.operations.get", @@ -823,7 +793,7 @@ ] }, "list": { - "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/operations", "httpMethod": "GET", "id": "recommendationengine.projects.locations.catalogs.operations.list", @@ -872,11 +842,11 @@ } } }, - "revision": "20200728", + "revision": "20200803", "rootUrl": "https://recommendationengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { - "description": "Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n message GetResourceRequest {\n // A unique request id.\n string request_id = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody) returns\n (google.protobuf.Empty);\n }\n\nExample with streaming methods:\n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.", + "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", "id": "GoogleApiHttpBody", "properties": { "contentType": { @@ -889,7 +859,7 @@ "type": "string" }, "extensions": { - "description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs.", + "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -925,7 +895,7 @@ "id": "GoogleCloudRecommendationengineV1alphaTuningMetadata", "properties": { "recommendationModel": { - "description": "The resource name of the recommendation model that this tune applies to.\nFormat:\nprojects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/eventStores/{event_store_id}/recommendationModels/{recommendation_model_id}", + "description": "The resource name of the recommendation model that this tune applies to. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/eventStores/{event_store_id}/recommendationModels/{recommendation_model_id}", "type": "string" } }, @@ -942,7 +912,7 @@ "id": "GoogleCloudRecommendationengineV1beta1BigQuerySource", "properties": { "dataSchema": { - "description": "Optional. The schema to use when parsing the data from the source.\n\nSupported values for catalog imports:\n\n 1: \"catalog_recommendations_ai\" using\n https://cloud.google.com/recommendations-ai/docs/upload-catalog#json\n (Default for catalogItems.import)\n\n 2: \"catalog_merchant_center\" using\n https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc\n\nSupported values for user event imports:\n\n 1: \"user_events_recommendations_ai\" using\n https://cloud.google.com/recommendations-ai/docs/manage-user-events#import\n (Default for userEvents.import)", + "description": "Optional. The schema to use when parsing the data from the source. Supported values for catalog imports: 1: \"catalog_recommendations_ai\" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#json (Default for catalogItems.import) 2: \"catalog_merchant_center\" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc Supported values for user event imports: 1: \"user_events_recommendations_ai\" using https://cloud.google.com/recommendations-ai/docs/manage-user-events#import (Default for userEvents.import)", "type": "string" }, "datasetId": { @@ -950,11 +920,11 @@ "type": "string" }, "gcsStagingDir": { - "description": "Optional. Intermediate Cloud Storage directory used for the import. Can be specified\nif one wants to have the BigQuery export to a specific Cloud Storage\ndirectory.", + "description": "Optional. Intermediate Cloud Storage directory used for the import. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.", "type": "string" }, "projectId": { - "description": "Optional. The project id (can be project # or id) that the BigQuery source is in. If\nnot specified, inherits the project id from the parent request.", + "description": "Optional. The project id (can be project # or id) that the BigQuery source is in. If not specified, inherits the project id from the parent request.", "type": "string" }, "tableId": { @@ -965,7 +935,7 @@ "type": "object" }, "GoogleCloudRecommendationengineV1beta1Catalog": { - "description": "The catalog configuration.\nNext ID: 5.", + "description": "The catalog configuration. Next ID: 5.", "id": "GoogleCloudRecommendationengineV1beta1Catalog", "properties": { "catalogItemLevelConfig": { @@ -973,7 +943,7 @@ "description": "Required. The catalog item level configuration." }, "defaultEventStoreId": { - "description": "Required. The id of the default event store.", + "description": "Required. The ID of the default event store.", "type": "string" }, "displayName": { @@ -992,7 +962,7 @@ "id": "GoogleCloudRecommendationengineV1beta1CatalogInlineSource", "properties": { "catalogItems": { - "description": "Optional. A list of catalog items to update/create. Recommended max of 10k\nitems.", + "description": "Optional. A list of catalog items to update/create. Recommended max of 10k items.", "items": { "$ref": "GoogleCloudRecommendationengineV1beta1CatalogItem" }, @@ -1006,30 +976,30 @@ "id": "GoogleCloudRecommendationengineV1beta1CatalogItem", "properties": { "categoryHierarchies": { - "description": "Required. Catalog item categories. This field is repeated for supporting\none catalog item belonging to several parallel category hierarchies.\n\nFor example, if a shoes product belongs to both\n[\"Shoes & Accessories\" -> \"Shoes\"] and\n[\"Sports & Fitness\" -> \"Athletic Clothing\" -> \"Shoes\"], it could be\nrepresented as:\n\n \"categoryHierarchies\": [\n { \"categories\": [\"Shoes & Accessories\", \"Shoes\"]},\n { \"categories\": [\"Sports & Fitness\", \"Athletic Clothing\", \"Shoes\"] }\n ]", + "description": "Required. Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both [\"Shoes & Accessories\" -> \"Shoes\"] and [\"Sports & Fitness\" -> \"Athletic Clothing\" -> \"Shoes\"], it could be represented as: \"categoryHierarchies\": [ { \"categories\": [\"Shoes & Accessories\", \"Shoes\"]}, { \"categories\": [\"Sports & Fitness\", \"Athletic Clothing\", \"Shoes\"] } ]", "items": { "$ref": "GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy" }, "type": "array" }, "description": { - "description": "Optional. Catalog item description. UTF-8 encoded string with a length\nlimit of 5 KiB.", + "description": "Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.", "type": "string" }, "id": { - "description": "Required. Catalog item identifier. UTF-8 encoded string with a length limit\nof 128 bytes.\n\nThis id must be unique among all catalog items within the same catalog. It\nshould also be used when logging user events in order for the user events\nto be joined with the Catalog.", + "description": "Required. Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog.", "type": "string" }, "itemAttributes": { "$ref": "GoogleCloudRecommendationengineV1beta1FeatureMap", - "description": "Optional. Highly encouraged. Extra catalog item attributes to be\nincluded in the recommendation model. For example, for retail products,\nthis could include the store name, vendor, style, color, etc. These are\nvery strong signals for recommendation model, thus we highly recommend\nproviding the item attributes here." + "description": "Optional. Highly encouraged. Extra catalog item attributes to be included in the recommendation model. For example, for retail products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the item attributes here." }, "itemGroupId": { - "description": "Optional. Variant group identifier for prediction results. UTF-8 encoded\nstring with a length limit of 128 bytes.\n\nThis field must be enabled before it can be used. [Learn\nmore](/recommendations-ai/docs/catalog#item-group-id).", + "description": "Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id).", "type": "string" }, "languageCode": { - "description": "Optional. Deprecated. The model automatically detects the text language. Your\ncatalog can include text in different languages, but duplicating\ncatalog items to provide text in multiple languages can result in\ndegraded model performance.", + "description": "Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance.", "type": "string" }, "productMetadata": { @@ -1037,14 +1007,14 @@ "description": "Optional. Metadata specific to retail products." }, "tags": { - "description": "Optional. Filtering tags associated with the catalog item. Each tag should\nbe a UTF-8 encoded string with a length limit of 1 KiB.\n\nThis tag can be used for filtering recommendation results by passing the\ntag as part of the predict request filter.", + "description": "Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter.", "items": { "type": "string" }, "type": "array" }, "title": { - "description": "Required. Catalog item title. UTF-8 encoded string with a length limit of 1\nKiB.", + "description": "Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.", "type": "string" } }, @@ -1055,7 +1025,7 @@ "id": "GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy", "properties": { "categories": { - "description": "Required. Catalog item categories. Each category should be a UTF-8\nencoded string with a length limit of 2 KiB.\n\nNote that the order in the list denotes the specificity (from least to\nmost specific).", + "description": "Required. Catalog item categories. Each category should be a UTF-8 encoded string with a length limit of 2 KiB. Note that the order in the list denotes the specificity (from least to most specific).", "items": { "type": "string" }, @@ -1065,11 +1035,11 @@ "type": "object" }, "GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig": { - "description": "Configures what level the catalog should be uploaded with regards to\nhow users will be send events and how predictions will be made.", + "description": "Configures the catalog level that users send events to, and the level at which predictions are made.", "id": "GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig", "properties": { "eventItemLevel": { - "description": "Optional. What level of the catalog are events uploaded at.\nSee https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels\nfor more details.", + "description": "Optional. Level of the catalog at which events are uploaded. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.", "enum": [ "CATALOG_ITEM_LEVEL_UNSPECIFIED", "VARIANT", @@ -1083,7 +1053,7 @@ "type": "string" }, "predictItemLevel": { - "description": "Optional. What level of the catalog are predictions made at.\nSee https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels\nfor more details.", + "description": "Optional. Level of the catalog at which predictions are made. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.", "enum": [ "CATALOG_ITEM_LEVEL_UNSPECIFIED", "VARIANT", @@ -1116,50 +1086,50 @@ "properties": { "eventAttributes": { "$ref": "GoogleCloudRecommendationengineV1beta1FeatureMap", - "description": "Optional. Extra user event features to include in the recommendation\nmodel.\n\nFor product recommendation, an example of extra user information is\ntraffic_channel, i.e. how user arrives at the site. Users can arrive\nat the site by coming to the site directly, or coming through Google\nsearch, and etc." + "description": "Optional. Extra user event features to include in the recommendation model. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc." }, "experimentIds": { - "description": "Optional. A list of identifiers for the independent experiment groups\nthis user event belongs to. This is used to distinguish between user events\nassociated with different experiment setups (e.g. using Recommendation\nEngine system, using different recommendation models).", + "description": "Optional. A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Recommendation Engine system, using different recommendation models).", "items": { "type": "string" }, "type": "array" }, "pageViewId": { - "description": "Optional. A unique id of a web page view.\nThis should be kept the same for all user events triggered from the same\npageview. For example, an item detail page view could trigger multiple\nevents as the user is browsing the page.\nThe `pageViewId` property should be kept the same for all these events so\nthat they can be grouped together properly. This `pageViewId` will be\nautomatically generated if using the JavaScript pixel.", + "description": "Optional. A unique id of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The `pageViewId` property should be kept the same for all these events so that they can be grouped together properly. This `pageViewId` will be automatically generated if using the JavaScript pixel.", "type": "string" }, "recommendationToken": { - "description": "Optional. Recommendation token included in the recommendation prediction\nresponse.\n\nThis field enables accurate attribution of recommendation model\nperformance.\n\nThis token enables us to accurately attribute page view or purchase back to\nthe event and the particular predict response containing this\nclicked/purchased item. If user clicks on product K in the recommendation\nresults, pass the `PredictResponse.recommendationToken` property as a url\nparameter to product K's page. When recording events on product K's page,\nlog the PredictResponse.recommendation_token to this field.\n\nOptional, but highly encouraged for user events that are the result of a\nrecommendation prediction query.", + "description": "Optional. Recommendation token included in the recommendation prediction response. This field enables accurate attribution of recommendation model performance. This token enables us to accurately attribute page view or purchase back to the event and the particular predict response containing this clicked/purchased item. If user clicks on product K in the recommendation results, pass the `PredictResponse.recommendationToken` property as a url parameter to product K's page. When recording events on product K's page, log the PredictResponse.recommendation_token to this field. Optional, but highly encouraged for user events that are the result of a recommendation prediction query.", "type": "string" }, "referrerUri": { - "description": "Optional. The referrer url of the current page. When using\nthe JavaScript pixel, this value is filled in automatically.", + "description": "Optional. The referrer url of the current page. When using the JavaScript pixel, this value is filled in automatically.", "type": "string" }, "uri": { - "description": "Optional. Complete url (window.location.href) of the user's current page.\nWhen using the JavaScript pixel, this value is filled in automatically.\nMaximum length 5KB.", + "description": "Optional. Complete url (window.location.href) of the user's current page. When using the JavaScript pixel, this value is filled in automatically. Maximum length 5KB.", "type": "string" } }, "type": "object" }, "GoogleCloudRecommendationengineV1beta1FeatureMap": { - "description": "FeatureMap represents extra features that customers want to include in the\nrecommendation model for catalogs/user events as categorical/numerical\nfeatures.", + "description": "FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features.", "id": "GoogleCloudRecommendationengineV1beta1FeatureMap", "properties": { "categoricalFeatures": { "additionalProperties": { "$ref": "GoogleCloudRecommendationengineV1beta1FeatureMapStringList" }, - "description": "Categorical features that can take on one of a limited number of possible\nvalues. Some examples would be the brand/maker of a product, or country of\na customer.\n\nFeature names and values must be UTF-8 encoded strings.\n\nFor example: `{ \"colors\": {\"value\": [\"yellow\", \"green\"]},\n \"sizes\": {\"value\":[\"S\", \"M\"]}`", + "description": "Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer. Feature names and values must be UTF-8 encoded strings. For example: `{ \"colors\": {\"value\": [\"yellow\", \"green\"]}, \"sizes\": {\"value\":[\"S\", \"M\"]}`", "type": "object" }, "numericalFeatures": { "additionalProperties": { "$ref": "GoogleCloudRecommendationengineV1beta1FeatureMapFloatList" }, - "description": "Numerical features. Some examples would be the height/weight of a product,\nor age of a customer.\n\nFeature names must be UTF-8 encoded strings.\n\nFor example: `{ \"lengths_cm\": {\"value\":[2.3, 15.4]},\n \"heights_cm\": {\"value\":[8.1, 6.4]} }`", + "description": "Numerical features. Some examples would be the height/weight of a product, or age of a customer. Feature names must be UTF-8 encoded strings. For example: `{ \"lengths_cm\": {\"value\":[2.3, 15.4]}, \"heights_cm\": {\"value\":[8.1, 6.4]} }`", "type": "object" } }, @@ -1195,41 +1165,23 @@ "type": "object" }, "GoogleCloudRecommendationengineV1beta1GcsSource": { - "description": "Google Cloud Storage location for input content.\nformat.", + "description": "Google Cloud Storage location for input content. format.", "id": "GoogleCloudRecommendationengineV1beta1GcsSource", "properties": { "inputUris": { - "description": "Required. Google Cloud Storage URIs to input files. URI can be up to\n2000 characters long. URIs can match the full object path (for example,\ngs://bucket/directory/object.json) or a pattern matching one or more\nfiles, such as gs://bucket/directory/*.json. A request can\ncontain at most 100 files, and each file can be up to 2 GB. See\n[Importing catalog information](/recommendations-ai/docs/upload-catalog)\nfor the expected file format and setup instructions.", + "description": "Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, gs://bucket/directory/object.json) or a pattern matching one or more files, such as gs://bucket/directory/*.json. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing catalog information](/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions.", "items": { "type": "string" }, "type": "array" }, "jsonSchema": { - "description": "Optional. The schema to use when parsing the data from the source.\n\nSupported values for catalog imports:\n\n 1: \"catalog_recommendations_ai\" using\n https://cloud.google.com/recommendations-ai/docs/upload-catalog#json\n (Default for catalogItems.import)\n\n 2: \"catalog_merchant_center\" using\n https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc\n\nSupported values for user events imports:\n\n 1: \"user_events_recommendations_ai\" using\n https://cloud.google.com/recommendations-ai/docs/manage-user-events#import\n (Default for userEvents.import)", + "description": "Optional. The schema to use when parsing the data from the source. Supported values for catalog imports: 1: \"catalog_recommendations_ai\" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#json (Default for catalogItems.import) 2: \"catalog_merchant_center\" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc Supported values for user events imports: 1: \"user_events_recommendations_ai\" using https://cloud.google.com/recommendations-ai/docs/manage-user-events#import (Default for userEvents.import)", "type": "string" } }, "type": "object" }, - "GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse": { - "description": "Response message for GetCatalogItemsWithItemGroupId method.", - "id": "GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse", - "properties": { - "canonicalCatalogItem": { - "$ref": "GoogleCloudRecommendationengineV1beta1CatalogItem", - "description": "The canonical catalog item representing all items associated with the item\ngroup id." - }, - "catalogItems": { - "description": "The list of catalog items associated with the item group id.", - "items": { - "$ref": "GoogleCloudRecommendationengineV1beta1CatalogItem" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudRecommendationengineV1beta1Image": { "description": "Catalog item thumbnail/detail image.", "id": "GoogleCloudRecommendationengineV1beta1Image", @@ -1264,11 +1216,11 @@ "description": "Required. The desired input location of the data." }, "requestId": { - "description": "Optional. Unique identifier provided by client, within the ancestor\ndataset scope. Ensures idempotency and used for request deduplication.\nServer-generated if unspecified. Up to 128 characters long. This is\nreturned as google.longrunning.Operation.name in the response.", + "description": "Optional. Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency and used for request deduplication. Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response.", "type": "string" }, "updateMask": { - "description": "Optional. Indicates which fields in the provided imported 'items' to update. If not\nset, will by default update all fields.", + "description": "Optional. Indicates which fields in the provided imported 'items' to update. If not set, will by default update all fields.", "format": "google-fieldmask", "type": "string" } @@ -1276,7 +1228,7 @@ "type": "object" }, "GoogleCloudRecommendationengineV1beta1ImportCatalogItemsResponse": { - "description": "Response of the ImportCatalogItemsRequest. If the long running\noperation is done, then this message is returned by the\ngoogle.longrunning.Operations.response field if the operation was successful.", + "description": "Response of the ImportCatalogItemsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "id": "GoogleCloudRecommendationengineV1beta1ImportCatalogItemsResponse", "properties": { "errorSamples": { @@ -1298,14 +1250,14 @@ "id": "GoogleCloudRecommendationengineV1beta1ImportErrorsConfig", "properties": { "gcsPrefix": { - "description": "Google Cloud Storage path for import errors. This must be an empty,\nexisting Cloud Storage bucket. Import errors will be written to a file in\nthis bucket, one per line, as a JSON-encoded\n`google.rpc.Status` message.", + "description": "Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Import errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object" }, "GoogleCloudRecommendationengineV1beta1ImportMetadata": { - "description": "Metadata related to the progress of the Import operation. This will be\nreturned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudRecommendationengineV1beta1ImportMetadata", "properties": { "createTime": { @@ -1323,7 +1275,7 @@ "type": "string" }, "requestId": { - "description": "Id of the request / operation. This is parroting back the requestId that\nwas passed in the request.", + "description": "Id of the request / operation. This is parroting back the requestId that was passed in the request.", "type": "string" }, "successCount": { @@ -1332,7 +1284,7 @@ "type": "string" }, "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the\nfinish time.", + "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } @@ -1352,14 +1304,14 @@ "description": "Required. The desired input location of the data." }, "requestId": { - "description": "Optional. Unique identifier provided by client, within the ancestor\ndataset scope. Ensures idempotency for expensive long running operations.\nServer-generated if unspecified. Up to 128 characters long. This is\nreturned as google.longrunning.Operation.name in the response. Note that\nthis field must not be set if the desired input config is\ncatalog_inline_source.", + "description": "Optional. Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency for expensive long running operations. Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response. Note that this field must not be set if the desired input config is catalog_inline_source.", "type": "string" } }, "type": "object" }, "GoogleCloudRecommendationengineV1beta1ImportUserEventsResponse": { - "description": "Response of the ImportUserEventsRequest. If the long running\noperation was successful, then this message is returned by the\ngoogle.longrunning.Operations.response field if the operation was successful.", + "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "id": "GoogleCloudRecommendationengineV1beta1ImportUserEventsResponse", "properties": { "errorSamples": { @@ -1371,7 +1323,7 @@ }, "errorsConfig": { "$ref": "GoogleCloudRecommendationengineV1beta1ImportErrorsConfig", - "description": "Echoes the destination for the complete errors if this field was set in\nthe request." + "description": "Echoes the destination for the complete errors if this field was set in the request." }, "importSummary": { "$ref": "GoogleCloudRecommendationengineV1beta1UserEventImportSummary", @@ -1415,7 +1367,7 @@ "type": "array" }, "nextPageToken": { - "description": "If empty, the list is complete. If nonempty, the token to pass to the next\nrequest's ListCatalogItemRequest.page_token.", + "description": "If empty, the list is complete. If nonempty, the token to pass to the next request's ListCatalogItemRequest.page_token.", "type": "string" } }, @@ -1430,6 +1382,7 @@ "items": { "$ref": "GoogleCloudRecommendationengineV1beta1Catalog" }, + "readOnly": true, "type": "array" }, "nextPageToken": { @@ -1444,7 +1397,7 @@ "id": "GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse", "properties": { "nextPageToken": { - "description": "If empty, the list is complete. If nonempty, pass the token to the next\nrequest's `ListPredictionApiKeysRegistrationsRequest.pageToken`.", + "description": "If empty, the list is complete. If nonempty, pass the token to the next request's `ListPredictionApiKeysRegistrationsRequest.pageToken`.", "type": "string" }, "predictionApiKeyRegistrations": { @@ -1462,7 +1415,7 @@ "id": "GoogleCloudRecommendationengineV1beta1ListUserEventsResponse", "properties": { "nextPageToken": { - "description": "If empty, the list is complete. If nonempty, the token to pass to the next\nrequest's ListUserEvents.page_token.", + "description": "If empty, the list is complete. If nonempty, the token to pass to the next request's ListUserEvents.page_token.", "type": "string" }, "userEvents": { @@ -1480,22 +1433,22 @@ "id": "GoogleCloudRecommendationengineV1beta1PredictRequest", "properties": { "dryRun": { - "description": "Optional. Use dryRun mode for this prediction query. If set to true, a\ndummy model will be used that returns arbitrary catalog items.\nNote that the dryRun mode should only be used for testing the API, or if\nthe model is not ready.", + "description": "Optional. Use dryRun mode for this prediction query. If set to true, a dummy model will be used that returns arbitrary catalog items. Note that the dryRun mode should only be used for testing the API, or if the model is not ready.", "type": "boolean" }, "filter": { - "description": "Optional. Filter for restricting prediction results. Accepts values for\ntags and the `filterOutOfStockItems` flag.\n\n * Tag expressions. Restricts predictions to items that match all of the\n specified tags. Boolean operators `OR` and `NOT` are supported if the\n expression is enclosed in parentheses, and must be separated from the\n tag values by a space. `-\"tagA\"` is also supported and is equivalent to\n `NOT \"tagA\"`. Tag values must be double quoted UTF-8 encoded strings\n with a size limit of 1 KiB.\n\n * filterOutOfStockItems. Restricts predictions to items that do not have a\n stockState value of OUT_OF_STOCK.\n\nExamples:\n\n * tag=(\"Red\" OR \"Blue\") tag=\"New-Arrival\" tag=(NOT \"promotional\")\n * filterOutOfStockItems tag=(-\"promotional\")\n * filterOutOfStockItems\n\nIf your filter blocks all prediction results, nothing will be returned. If\nyou want generic (unfiltered) popular items to be returned instead, set\n`strictFiltering` to false in `PredictRequest.params`.", + "description": "Optional. Filter for restricting prediction results. Accepts values for tags and the `filterOutOfStockItems` flag. * Tag expressions. Restricts predictions to items that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. `-\"tagA\"` is also supported and is equivalent to `NOT \"tagA\"`. Tag values must be double quoted UTF-8 encoded strings with a size limit of 1 KiB. * filterOutOfStockItems. Restricts predictions to items that do not have a stockState value of OUT_OF_STOCK. Examples: * tag=(\"Red\" OR \"Blue\") tag=\"New-Arrival\" tag=(NOT \"promotional\") * filterOutOfStockItems tag=(-\"promotional\") * filterOutOfStockItems If your filter blocks all prediction results, nothing will be returned. If you want generic (unfiltered) popular items to be returned instead, set `strictFiltering` to false in `PredictRequest.params`.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Optional. The labels for the predict request.\n\n * Label keys can contain lowercase letters, digits and hyphens, must start\n with a letter, and must end with a letter or digit.\n * Non-zero label values can contain lowercase letters, digits and hyphens,\n must start with a letter, and must end with a letter or digit.\n * No more than 64 labels can be associated with a given request.\n\nSee https://goo.gl/xmQnxf for more information on and examples of labels.", + "description": "Optional. The labels for the predict request. * Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels.", "type": "object" }, "pageSize": { - "description": "Optional. Maximum number of results to return per page. Set this property\nto the number of prediction results required. If zero, the service will\nchoose a reasonable default.", + "description": "Optional. Maximum number of results to return per page. Set this property to the number of prediction results required. If zero, the service will choose a reasonable default.", "format": "int32", "type": "integer" }, @@ -1507,12 +1460,12 @@ "additionalProperties": { "type": "any" }, - "description": "Optional. Additional domain specific parameters for the predictions.\n\nAllowed values:\n\n* `returnCatalogItem`: Boolean. If set to true, the associated catalogItem\n object will be returned in the\n `PredictResponse.PredictionResult.itemMetadata` object in the method\n response.\n* `returnItemScore`: Boolean. If set to true, the prediction 'score'\n corresponding to each returned item will be set in the `metadata`\n field in the prediction response. The given 'score' indicates the\n probability of an item being clicked/purchased given the user's context\n and history.\n* `strictFiltering`: Boolean. True by default. If set to false, the service\n will return generic (unfiltered) popular items instead of empty if your\n filter blocks all prediction results.", + "description": "Optional. Additional domain specific parameters for the predictions. Allowed values: * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem object will be returned in the `PredictResponse.PredictionResult.itemMetadata` object in the method response. * `returnItemScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in the `metadata` field in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular items instead of empty if your filter blocks all prediction results.", "type": "object" }, "userEvent": { "$ref": "GoogleCloudRecommendationengineV1beta1UserEvent", - "description": "Required. Context about the user, what they are looking at and what action\nthey took to trigger the predict request. Note that this user event detail\nwon't be ingested to userEvent logs. Thus, a separate userEvent write\nrequest is required for event logging." + "description": "Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging." } }, "type": "object" @@ -1540,15 +1493,15 @@ "type": "object" }, "nextPageToken": { - "description": "If empty, the list is complete. If nonempty, the token to pass to the next\nrequest's PredictRequest.page_token.", + "description": "If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token.", "type": "string" }, "recommendationToken": { - "description": "A unique recommendation token. This should be included in the user event\nlogs resulting from this recommendation, which enables accurate attribution\nof recommendation model performance.", + "description": "A unique recommendation token. This should be included in the user event logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.", "type": "string" }, "results": { - "description": "A list of recommended items. The order represents the ranking (from the\nmost relevant item to the least).", + "description": "A list of recommended items. The order represents the ranking (from the most relevant item to the least).", "items": { "$ref": "GoogleCloudRecommendationengineV1beta1PredictResponsePredictionResult" }, @@ -1569,7 +1522,7 @@ "additionalProperties": { "type": "any" }, - "description": "Additional item metadata / annotations.\n\nPossible values:\n\n* `catalogItem`: JSON representation of the catalogItem. Will be set if\n `returnCatalogItem` is set to true in `PredictRequest.params`.\n* `score`: Prediction score in double value. Will be set if\n `returnItemScore` is set to true in `PredictRequest.params`.", + "description": "Additional item metadata / annotations. Possible values: * `catalogItem`: JSON representation of the catalogItem. Will be set if `returnCatalogItem` is set to true in `PredictRequest.params`. * `score`: Prediction score in double value. Will be set if `returnItemScore` is set to true in `PredictRequest.params`.", "type": "object" } }, @@ -1596,7 +1549,7 @@ "type": "string" }, "canonicalProductUri": { - "description": "Optional. Canonical URL directly linking to the item detail page with a\nlength limit of 5 KiB..", + "description": "Optional. Canonical URL directly linking to the item detail page with a length limit of 5 KiB..", "type": "string" }, "costs": { @@ -1604,11 +1557,11 @@ "format": "float", "type": "number" }, - "description": "Optional. A map to pass the costs associated with the product.\n\nFor example:\n{\"manufacturing\": 45.5} The profit of selling this item is computed like\nso:\n\n* If 'exactPrice' is provided, profit = displayPrice - sum(costs)\n* If 'priceRange' is provided, profit = minPrice - sum(costs)", + "description": "Optional. A map to pass the costs associated with the product. For example: {\"manufacturing\": 45.5} The profit of selling this item is computed like so: * If 'exactPrice' is provided, profit = displayPrice - sum(costs) * If 'priceRange' is provided, profit = minPrice - sum(costs)", "type": "object" }, "currencyCode": { - "description": "Optional. Only required if the price is set. Currency code for price/costs. Use\nthree-character ISO-4217 code.", + "description": "Optional. Only required if the price is set. Currency code for price/costs. Use three-character ISO-4217 code.", "type": "string" }, "exactPrice": { @@ -1657,7 +1610,7 @@ "type": "number" }, "originalPrice": { - "description": "Optional. Price of the product without any discount. If zero, by default\nset to be the 'displayPrice'.", + "description": "Optional. Price of the product without any discount. If zero, by default set to be the 'displayPrice'.", "format": "float", "type": "number" } @@ -1665,7 +1618,7 @@ "type": "object" }, "GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange": { - "description": "Product price range when there are a range of prices for different\nvariations of the same product.", + "description": "Product price range when there are a range of prices for different variations of the same product.", "id": "GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange", "properties": { "max": { @@ -1686,21 +1639,21 @@ "id": "GoogleCloudRecommendationengineV1beta1ProductDetail", "properties": { "availableQuantity": { - "description": "Optional. Quantity of the products in stock when a user event happens.\nOptional. If provided, this overrides the available quantity in Catalog for\nthis event. and can only be set if `stock_status` is set to `IN_STOCK`.\n\nNote that if an item is out of stock, you must set the `stock_state` field\nto be `OUT_OF_STOCK`. Leaving this field unspecified / as zero is not\nsufficient to mark the item out of stock.", + "description": "Optional. Quantity of the products in stock when a user event happens. Optional. If provided, this overrides the available quantity in Catalog for this event. and can only be set if `stock_status` is set to `IN_STOCK`. Note that if an item is out of stock, you must set the `stock_state` field to be `OUT_OF_STOCK`. Leaving this field unspecified / as zero is not sufficient to mark the item out of stock.", "format": "int32", "type": "integer" }, "currencyCode": { - "description": "Optional. Currency code for price/costs. Use three-character ISO-4217\ncode. Required only if originalPrice or displayPrice is set.", + "description": "Optional. Currency code for price/costs. Use three-character ISO-4217 code. Required only if originalPrice or displayPrice is set.", "type": "string" }, "displayPrice": { - "description": "Optional. Display price of the product (e.g. discounted price). If\nprovided, this will override the display price in Catalog for this product.", + "description": "Optional. Display price of the product (e.g. discounted price). If provided, this will override the display price in Catalog for this product.", "format": "float", "type": "number" }, "id": { - "description": "Required. Catalog item ID. UTF-8 encoded string with a length limit of 128\ncharacters.", + "description": "Required. Catalog item ID. UTF-8 encoded string with a length limit of 128 characters.", "type": "string" }, "itemAttributes": { @@ -1708,17 +1661,17 @@ "description": "Optional. Extra features associated with a product in the user event." }, "originalPrice": { - "description": "Optional. Original price of the product. If provided, this will override\nthe original price in Catalog for this product.", + "description": "Optional. Original price of the product. If provided, this will override the original price in Catalog for this product.", "format": "float", "type": "number" }, "quantity": { - "description": "Optional. Quantity of the product associated with the user event. For\nexample, this field will be 2 if two products are added to the shopping\ncart for `add-to-cart` event. Required for `add-to-cart`, `add-to-list`,\n`remove-from-cart`, `checkout-start`, `purchase-complete`, `refund` event\ntypes.", + "description": "Optional. Quantity of the product associated with the user event. For example, this field will be 2 if two products are added to the shopping cart for `add-to-cart` event. Required for `add-to-cart`, `add-to-list`, `remove-from-cart`, `checkout-start`, `purchase-complete`, `refund` event types.", "format": "int32", "type": "integer" }, "stockState": { - "description": "Optional. Item stock state. If provided, this overrides the stock state\nin Catalog for items in this event.", + "description": "Optional. Item stock state. If provided, this overrides the stock state in Catalog for items in this event.", "enum": [ "STOCK_STATE_UNSPECIFIED", "IN_STOCK", @@ -1739,26 +1692,26 @@ "type": "object" }, "GoogleCloudRecommendationengineV1beta1ProductEventDetail": { - "description": "ProductEventDetail captures user event information specific to retail\nproducts.", + "description": "ProductEventDetail captures user event information specific to retail products.", "id": "GoogleCloudRecommendationengineV1beta1ProductEventDetail", "properties": { "cartId": { - "description": "Optional. The id or name of the associated shopping cart. This id is used\nto associate multiple items added or present in the cart before purchase.\n\nThis can only be set for `add-to-cart`, `remove-from-cart`,\n`checkout-start`, `purchase-complete`, or `shopping-cart-page-view` events.", + "description": "Optional. The id or name of the associated shopping cart. This id is used to associate multiple items added or present in the cart before purchase. This can only be set for `add-to-cart`, `remove-from-cart`, `checkout-start`, `purchase-complete`, or `shopping-cart-page-view` events.", "type": "string" }, "listId": { - "description": "Required for `add-to-list` and `remove-from-list` events. The id or name of\nthe list that the item is being added to or removed from. Other event types\nshould not set this field.", + "description": "Required for `add-to-list` and `remove-from-list` events. The id or name of the list that the item is being added to or removed from. Other event types should not set this field.", "type": "string" }, "pageCategories": { - "description": "Required for `category-page-view` events. Other event types should not set\nthis field.\nThe categories associated with a category page.\nCategory pages include special pages such as sales or promotions. For\ninstance, a special sale page may have the category hierarchy:\ncategories : [\"Sales\", \"2017 Black Friday Deals\"].", + "description": "Required for `category-page-view` events. Other event types should not set this field. The categories associated with a category page. Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: categories : [\"Sales\", \"2017 Black Friday Deals\"].", "items": { "$ref": "GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy" }, "type": "array" }, "productDetails": { - "description": "The main product details related to the event.\n\nThis field is required for the following event types:\n\n* `add-to-cart`\n* `add-to-list`\n* `checkout-start`\n* `detail-page-view`\n* `purchase-complete`\n* `refund`\n* `remove-from-cart`\n* `remove-from-list`\n\nThis field is optional for the following event types:\n\n* `page-visit`\n* `shopping-cart-page-view` - note that 'product_details' should be set for\n this unless the shopping cart is empty.\n* `search` (highly encouraged)\n\nIn a `search` event, this field represents the products returned to the end\nuser on the current page (the end user may have not finished broswing the\nwhole page yet). When a new page is returned to the end user, after\npagination/filtering/ordering even for the same query, a new SEARCH event\nwith different product_details is desired. The end user may have not\nfinished broswing the whole page yet.\n\nThis field is not allowed for the following event types:\n\n* `category-page-view`\n* `home-page-view`", + "description": "The main product details related to the event. This field is required for the following event types: * `add-to-cart` * `add-to-list` * `checkout-start` * `detail-page-view` * `purchase-complete` * `refund` * `remove-from-cart` * `remove-from-list` This field is optional for the following event types: * `page-visit` * `shopping-cart-page-view` - note that 'product_details' should be set for this unless the shopping cart is empty. * `search` (highly encouraged) In a `search` event, this field represents the products returned to the end user on the current page (the end user may have not finished broswing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new SEARCH event with different product_details is desired. The end user may have not finished broswing the whole page yet. This field is not allowed for the following event types: * `category-page-view` * `home-page-view`", "items": { "$ref": "GoogleCloudRecommendationengineV1beta1ProductDetail" }, @@ -1766,10 +1719,10 @@ }, "purchaseTransaction": { "$ref": "GoogleCloudRecommendationengineV1beta1PurchaseTransaction", - "description": "Optional. A transaction represents the entire purchase transaction.\nRequired for `purchase-complete` events. Optional for `checkout-start`\nevents. Other event types should not set this field." + "description": "Optional. A transaction represents the entire purchase transaction. Required for `purchase-complete` events. Optional for `checkout-start` events. Other event types should not set this field." }, "searchQuery": { - "description": "Required for `search` events. Other event types should not set this field.\nThe user's search query as UTF-8 encoded text with a length limit of 5 KiB.", + "description": "Required for `search` events. Other event types should not set this field. The user's search query as UTF-8 encoded text with a length limit of 5 KiB.", "type": "string" } }, @@ -1784,11 +1737,11 @@ "format": "float", "type": "number" }, - "description": "Optional. All the costs associated with the product. These can be\nmanufacturing costs, shipping expenses not borne by the end user, or any\nother costs.\n\nTotal product cost such that\n profit = revenue - (sum(taxes) + sum(costs))\nIf product_cost is not set, then\n profit = revenue - tax - shipping - sum(CatalogItem.costs).\n\nIf CatalogItem.cost is not specified for one of the items, CatalogItem.cost\nbased profit *cannot* be calculated for this Transaction.", + "description": "Optional. All the costs associated with the product. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs. Total product cost such that profit = revenue - (sum(taxes) + sum(costs)) If product_cost is not set, then profit = revenue - tax - shipping - sum(CatalogItem.costs). If CatalogItem.cost is not specified for one of the items, CatalogItem.cost based profit *cannot* be calculated for this Transaction.", "type": "object" }, "currencyCode": { - "description": "Required. Currency code. Use three-character ISO-4217 code. This field\nis not required if the event type is `refund`.", + "description": "Required. Currency code. Use three-character ISO-4217 code. This field is not required if the event type is `refund`.", "type": "string" }, "id": { @@ -1796,7 +1749,7 @@ "type": "string" }, "revenue": { - "description": "Required. Total revenue or grand total associated with the transaction.\nThis value include shipping, tax, or other adjustments to total revenue\nthat you want to include as part of your revenue calculations. This field\nis not required if the event type is `refund`.", + "description": "Required. Total revenue or grand total associated with the transaction. This value include shipping, tax, or other adjustments to total revenue that you want to include as part of your revenue calculations. This field is not required if the event type is `refund`.", "format": "float", "type": "number" }, @@ -1812,7 +1765,7 @@ "type": "object" }, "GoogleCloudRecommendationengineV1beta1PurgeUserEventsMetadata": { - "description": "Metadata related to the progress of the PurgeUserEvents operation.\nThis will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudRecommendationengineV1beta1PurgeUserEventsMetadata", "properties": { "createTime": { @@ -1832,18 +1785,18 @@ "id": "GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest", "properties": { "filter": { - "description": "Required. The filter string to specify the events to be deleted. Empty\nstring filter is not allowed. The eligible fields\nfor filtering are:\n\n* `eventType`: UserEvent.eventType field of type string.\n* `eventTime`: in ISO 8601 \"zulu\" format.\n* `visitorId`: field of type string. Specifying this will delete all\n events associated with a visitor.\n* `userId`: field of type string. Specifying this will delete all events\n associated with a user.\n\nExamples:\n\n* Deleting all events in a time range:\n `eventTime > \"2012-04-23T18:25:43.511Z\"\n eventTime < \"2012-04-23T18:30:43.511Z\"`\n* Deleting specific eventType in time range:\n `eventTime > \"2012-04-23T18:25:43.511Z\" eventType = \"detail-page-view\"`\n* Deleting all events for a specific visitor:\n `visitorId = \"visitor1024\"`\n\nThe filtering fields are assumed to have an implicit AND.", + "description": "Required. The filter string to specify the events to be deleted. Empty string filter is not allowed. The eligible fields for filtering are: * `eventType`: UserEvent.eventType field of type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `visitorId`: field of type string. Specifying this will delete all events associated with a visitor. * `userId`: field of type string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType in time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventType = \"detail-page-view\"` * Deleting all events for a specific visitor: `visitorId = \"visitor1024\"` The filtering fields are assumed to have an implicit AND.", "type": "string" }, "force": { - "description": "Optional. The default value is false. Override this flag to true to\nactually perform the purge. If the field is not set to true, a sampling of\nevents to be deleted will be returned.", + "description": "Optional. The default value is false. Override this flag to true to actually perform the purge. If the field is not set to true, a sampling of events to be deleted will be returned.", "type": "boolean" } }, "type": "object" }, "GoogleCloudRecommendationengineV1beta1PurgeUserEventsResponse": { - "description": "Response of the PurgeUserEventsRequest. If the long running operation is\nsuccessfully done, then this message is returned by the\ngoogle.longrunning.Operations.response field.", + "description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", "id": "GoogleCloudRecommendationengineV1beta1PurgeUserEventsResponse", "properties": { "purgedEventsCount": { @@ -1852,7 +1805,7 @@ "type": "string" }, "userEventsSample": { - "description": "A sampling of events deleted (or will be deleted) depending on the `force`\nproperty in the request. Max of 500 items will be returned.", + "description": "A sampling of events deleted (or will be deleted) depending on the `force` property in the request. Max of 500 items will be returned.", "items": { "$ref": "GoogleCloudRecommendationengineV1beta1UserEvent" }, @@ -1866,14 +1819,14 @@ "id": "GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest", "properties": { "userEventRejoinScope": { - "description": "Required. The type of the catalog rejoin to define the scope and range of the user\nevents to be rejoined with catalog items.", + "description": "Required. The type of the catalog rejoin to define the scope and range of the user events to be rejoined with catalog items.", "enum": [ "USER_EVENT_REJOIN_SCOPE_UNSPECIFIED", "JOINED_EVENTS", "UNJOINED_EVENTS" ], "enumDescriptions": [ - "Rejoin catalogs with all events including both joined events and\nunjoined events.", + "Rejoin catalogs with all events including both joined events and unjoined events.", "Only rejoin catalogs with joined events.", "Only rejoin catalogs with unjoined events." ], @@ -1883,15 +1836,15 @@ "type": "object" }, "GoogleCloudRecommendationengineV1beta1UserEvent": { - "description": "UserEvent captures all metadata information recommendation engine needs to\nknow about how end users interact with customers' website.", + "description": "UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.", "id": "GoogleCloudRecommendationengineV1beta1UserEvent", "properties": { "eventDetail": { "$ref": "GoogleCloudRecommendationengineV1beta1EventDetail", - "description": "Optional. User event detailed information common across different\nrecommendation types." + "description": "Optional. User event detailed information common across different recommendation types." }, "eventSource": { - "description": "Optional. This field should *not* be set when using JavaScript pixel\nor the Recommendations AI Tag. Defaults to `EVENT_SOURCE_UNSPECIFIED`.", + "description": "Optional. This field should *not* be set when using JavaScript pixel or the Recommendations AI Tag. Defaults to `EVENT_SOURCE_UNSPECIFIED`.", "enum": [ "EVENT_SOURCE_UNSPECIFIED", "AUTOML", @@ -1900,24 +1853,24 @@ ], "enumDescriptions": [ "Unspecified event source.", - "The event is ingested via a javascript pixel or Recommendations AI Tag\nthrough automl datalayer or JS Macros.", - "The event is ingested via Recommendations AI Tag through Enhanced\nEcommerce datalayer.", + "The event is ingested via a javascript pixel or Recommendations AI Tag through automl datalayer or JS Macros.", + "The event is ingested via Recommendations AI Tag through Enhanced Ecommerce datalayer.", "The event is ingested via Import user events API." ], "type": "string" }, "eventTime": { - "description": "Optional. Only required for ImportUserEvents method. Timestamp of user\nevent created.", + "description": "Optional. Only required for ImportUserEvents method. Timestamp of user event created.", "format": "google-datetime", "type": "string" }, "eventType": { - "description": "Required. User event type. Allowed values are:\n\n* `add-to-cart` Products being added to cart.\n* `add-to-list` Items being added to a list (shopping list, favorites\n etc).\n* `category-page-view` Special pages such as sale or promotion pages\n viewed.\n* `checkout-start` User starting a checkout process.\n* `detail-page-view` Products detail page viewed.\n* `home-page-view` Homepage viewed.\n* `page-visit` Generic page visits not included in the event types above.\n* `purchase-complete` User finishing a purchase.\n* `refund` Purchased items being refunded or returned.\n* `remove-from-cart` Products being removed from cart.\n* `remove-from-list` Items being removed from a list.\n* `search` Product search.\n* `shopping-cart-page-view` User viewing a shopping cart.\n* `impression` List of items displayed. Used by Google Tag Manager.", + "description": "Required. User event type. Allowed values are: * `add-to-cart` Products being added to cart. * `add-to-list` Items being added to a list (shopping list, favorites etc). * `category-page-view` Special pages such as sale or promotion pages viewed. * `checkout-start` User starting a checkout process. * `detail-page-view` Products detail page viewed. * `home-page-view` Homepage viewed. * `page-visit` Generic page visits not included in the event types above. * `purchase-complete` User finishing a purchase. * `refund` Purchased items being refunded or returned. * `remove-from-cart` Products being removed from cart. * `remove-from-list` Items being removed from a list. * `search` Product search. * `shopping-cart-page-view` User viewing a shopping cart. * `impression` List of items displayed. Used by Google Tag Manager.", "type": "string" }, "productEventDetail": { "$ref": "GoogleCloudRecommendationengineV1beta1ProductEventDetail", - "description": "Optional. Retail product specific user event metadata.\n\nThis field is required for the following event types:\n\n* `add-to-cart`\n* `add-to-list`\n* `category-page-view`\n* `checkout-start`\n* `detail-page-view`\n* `purchase-complete`\n* `refund`\n* `remove-from-cart`\n* `remove-from-list`\n* `search`\n\nThis field is optional for the following event types:\n\n* `page-visit`\n* `shopping-cart-page-view` - note that 'product_event_detail' should be\n set for this unless the shopping cart is empty.\n\nThis field is not allowed for the following event types:\n\n* `home-page-view`" + "description": "Optional. Retail product specific user event metadata. This field is required for the following event types: * `add-to-cart` * `add-to-list` * `category-page-view` * `checkout-start` * `detail-page-view` * `purchase-complete` * `refund` * `remove-from-cart` * `remove-from-list` * `search` This field is optional for the following event types: * `page-visit` * `shopping-cart-page-view` - note that 'product_event_detail' should be set for this unless the shopping cart is empty. This field is not allowed for the following event types: * `home-page-view`" }, "userInfo": { "$ref": "GoogleCloudRecommendationengineV1beta1UserInfo", @@ -1927,7 +1880,7 @@ "type": "object" }, "GoogleCloudRecommendationengineV1beta1UserEventImportSummary": { - "description": "A summary of import result. The UserEventImportSummary summarizes\nthe import status for user events.", + "description": "A summary of import result. The UserEventImportSummary summarizes the import status for user events.", "id": "GoogleCloudRecommendationengineV1beta1UserEventImportSummary", "properties": { "joinedEventsCount": { @@ -1936,7 +1889,7 @@ "type": "string" }, "unjoinedEventsCount": { - "description": "Count of user events imported, but with catalog information not found\nin the imported catalog.", + "description": "Count of user events imported, but with catalog information not found in the imported catalog.", "format": "int64", "type": "string" } @@ -1962,23 +1915,23 @@ "id": "GoogleCloudRecommendationengineV1beta1UserInfo", "properties": { "directUserRequest": { - "description": "Optional. Indicates if the request is made directly from the end user\nin which case the user_agent and ip_address fields can be populated\nfrom the HTTP request. This should *not* be set when using the javascript\npixel. This flag should be set only if the API request is made directly\nfrom the end user such as a mobile app (and not if a gateway or a server is\nprocessing and pushing the user events).", + "description": "Optional. Indicates if the request is made directly from the end user in which case the user_agent and ip_address fields can be populated from the HTTP request. This should *not* be set when using the javascript pixel. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events).", "type": "boolean" }, "ipAddress": { - "description": "Optional. IP address of the user. This could be either IPv4 (e.g. 104.133.9.80) or\nIPv6 (e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334). This should *not* be\nset when using the javascript pixel or if `direct_user_request` is set.\nUsed to extract location information for personalization.", + "description": "Optional. IP address of the user. This could be either IPv4 (e.g. 104.133.9.80) or IPv6 (e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334). This should *not* be set when using the javascript pixel or if `direct_user_request` is set. Used to extract location information for personalization.", "type": "string" }, "userAgent": { - "description": "Optional. User agent as included in the HTTP header. UTF-8 encoded string\nwith a length limit of 1 KiB.\n\nThis should *not* be set when using the JavaScript pixel or if\n`directUserRequest` is set.", + "description": "Optional. User agent as included in the HTTP header. UTF-8 encoded string with a length limit of 1 KiB. This should *not* be set when using the JavaScript pixel or if `directUserRequest` is set.", "type": "string" }, "userId": { - "description": "Optional. Unique identifier for logged-in user with a length limit of 128\nbytes. Required only for logged-in users.", + "description": "Optional. Unique identifier for logged-in user with a length limit of 128 bytes. Required only for logged-in users.", "type": "string" }, "visitorId": { - "description": "Required. A unique identifier for tracking visitors with a length limit of\n128 bytes.\n\nFor example, this could be implemented with a http cookie, which should be\nable to uniquely identify a visitor on a single device. This unique\nidentifier should not change if the visitor log in/out of the website.\nMaximum length 128 bytes. Cannot be empty.", + "description": "Required. A unique identifier for tracking visitors with a length limit of 128 bytes. For example, this could be implemented with a http cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Maximum length 128 bytes. Cannot be empty.", "type": "string" } }, @@ -2003,11 +1956,11 @@ "type": "object" }, "GoogleLongrunningOperation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "GoogleLongrunningOperation", "properties": { "done": { - "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { @@ -2019,11 +1972,11 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" }, "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "response": { @@ -2031,20 +1984,20 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" } }, "type": "object" }, "GoogleProtobufEmpty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "GoogleProtobufEmpty", "properties": {}, "type": "object" }, "GoogleRpcStatus": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "GoogleRpcStatus", "properties": { "code": { @@ -2053,7 +2006,7 @@ "type": "integer" }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -2064,7 +2017,7 @@ "type": "array" }, "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, diff --git a/discovery/recommender-v1.json b/discovery/recommender-v1.json index 445815bb28..683f691b56 100644 --- a/discovery/recommender-v1.json +++ b/discovery/recommender-v1.json @@ -114,7 +114,7 @@ "insights": { "methods": { "get": { - "description": "Gets the requested insight. Requires the recommender.*.get IAM permission\nfor the specified insight type.", + "description": "Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}", "httpMethod": "GET", "id": "recommender.projects.locations.insightTypes.insights.get", @@ -139,7 +139,7 @@ ] }, "list": { - "description": "Lists insights for a Cloud project. Requires the recommender.*.list IAM\npermission for the specified insight type.", + "description": "Lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the specified insight type.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights", "httpMethod": "GET", "id": "recommender.projects.locations.insightTypes.insights.list", @@ -148,23 +148,23 @@ ], "parameters": { "filter": { - "description": "Optional. Filter expression to restrict the insights returned. Supported\nfilter fields: state\nEg: `state:\"DISMISSED\" or state:\"ACTIVE\"", + "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:\"DISMISSED\" or state:\"ACTIVE\"", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of results to return from this request. Non-positive\nvalues are ignored. If not specified, the server will determine the number\nof results to return.", + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. If present, retrieves the next batch of results from the preceding call to\nthis method. `page_token` must be the value of `next_page_token` from the\nprevious response. The values of other method parameters must be identical\nto those in the previous call.", + "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The container resource on which to execute the request.\nAcceptable formats:\n\n1.\n\"projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]\",\n\nLOCATION here refers to GCP Locations:\nhttps://cloud.google.com/about/locations/", + "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. \"projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]\", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/insightTypes/[^/]+$", "required": true, @@ -180,7 +180,7 @@ ] }, "markAccepted": { - "description": "Marks the Insight State as Accepted. Users can use this method to\nindicate to the Recommender API that they have applied some action based\non the insight. This stops the insight content from being updated.\n\nMarkInsightAccepted can be applied to insights in ACTIVE state. Requires\nthe recommender.*.update IAM permission for the specified insight.", + "description": "Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted", "httpMethod": "POST", "id": "recommender.projects.locations.insightTypes.insights.markAccepted", @@ -216,7 +216,7 @@ "recommendations": { "methods": { "get": { - "description": "Gets the requested recommendation. Requires the recommender.*.get\nIAM permission for the specified recommender.", + "description": "Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}", "httpMethod": "GET", "id": "recommender.projects.locations.recommenders.recommendations.get", @@ -241,7 +241,7 @@ ] }, "list": { - "description": "Lists recommendations for a Cloud project. Requires the recommender.*.list\nIAM permission for the specified recommender.", + "description": "Lists recommendations for a Cloud project. Requires the recommender.*.list IAM permission for the specified recommender.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations", "httpMethod": "GET", "id": "recommender.projects.locations.recommenders.recommendations.list", @@ -250,23 +250,23 @@ ], "parameters": { "filter": { - "description": "Filter expression to restrict the recommendations returned. Supported\nfilter fields: state_info.state\nEg: `state_info.state:\"DISMISSED\" or state_info.state:\"FAILED\"", + "description": "Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:\"DISMISSED\" or state_info.state:\"FAILED\"", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of results to return from this request. Non-positive\nvalues are ignored. If not specified, the server will determine the number\nof results to return.", + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. If present, retrieves the next batch of results from the preceding call to\nthis method. `page_token` must be the value of `next_page_token` from the\nprevious response. The values of other method parameters must be identical\nto those in the previous call.", + "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The container resource on which to execute the request.\nAcceptable formats:\n\n1.\n\"projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]\",\n\nLOCATION here refers to GCP Locations:\nhttps://cloud.google.com/about/locations/", + "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. \"projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]\", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+$", "required": true, @@ -282,7 +282,7 @@ ] }, "markClaimed": { - "description": "Marks the Recommendation State as Claimed. Users can use this method to\nindicate to the Recommender API that they are starting to apply the\nrecommendation themselves. This stops the recommendation content from being\nupdated. Associated insights are frozen and placed in the ACCEPTED state.\n\nMarkRecommendationClaimed can be applied to recommendations in CLAIMED,\nSUCCEEDED, FAILED, or ACTIVE state.\n\nRequires the recommender.*.update IAM permission for the specified\nrecommender.", + "description": "Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed", "httpMethod": "POST", "id": "recommender.projects.locations.recommenders.recommendations.markClaimed", @@ -310,7 +310,7 @@ ] }, "markFailed": { - "description": "Marks the Recommendation State as Failed. Users can use this method to\nindicate to the Recommender API that they have applied the recommendation\nthemselves, and the operation failed. This stops the recommendation content\nfrom being updated. Associated insights are frozen and placed in the\nACCEPTED state.\n\nMarkRecommendationFailed can be applied to recommendations in ACTIVE,\nCLAIMED, SUCCEEDED, or FAILED state.\n\nRequires the recommender.*.update IAM permission for the specified\nrecommender.", + "description": "Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed", "httpMethod": "POST", "id": "recommender.projects.locations.recommenders.recommendations.markFailed", @@ -338,7 +338,7 @@ ] }, "markSucceeded": { - "description": "Marks the Recommendation State as Succeeded. Users can use this method to\nindicate to the Recommender API that they have applied the recommendation\nthemselves, and the operation was successful. This stops the recommendation\ncontent from being updated. Associated insights are frozen and placed in\nthe ACCEPTED state.\n\nMarkRecommendationSucceeded can be applied to recommendations in ACTIVE,\nCLAIMED, SUCCEEDED, or FAILED state.\n\nRequires the recommender.*.update IAM permission for the specified\nrecommender.", + "description": "Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded", "httpMethod": "POST", "id": "recommender.projects.locations.recommenders.recommendations.markSucceeded", @@ -374,7 +374,7 @@ } } }, - "revision": "20200704", + "revision": "20200801", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudRecommenderV1CostProjection": { @@ -383,7 +383,7 @@ "properties": { "cost": { "$ref": "GoogleTypeMoney", - "description": "An approximate projection on amount saved or amount incurred. Negative cost\nunits indicate cost savings and positive cost units indicate increase.\nSee google.type.Money documentation for positive/negative units." + "description": "An approximate projection on amount saved or amount incurred. Negative cost units indicate cost savings and positive cost units indicate increase. See google.type.Money documentation for positive/negative units." }, "duration": { "description": "Duration for which this cost applies.", @@ -423,7 +423,7 @@ "type": "object" }, "GoogleCloudRecommenderV1Insight": { - "description": "An insight along with the information used to derive the insight. The insight\nmay have associated recomendations as well.", + "description": "An insight along with the information used to derive the insight. The insight may have associated recomendations as well.", "id": "GoogleCloudRecommenderV1Insight", "properties": { "associatedRecommendations": { @@ -456,15 +456,15 @@ "description": "Properties of the object.", "type": "any" }, - "description": "A struct of custom fields to explain the insight.\nExample: \"grantedPermissionsCount\": \"1000\"", + "description": "A struct of custom fields to explain the insight. Example: \"grantedPermissionsCount\": \"1000\"", "type": "object" }, "description": { - "description": "Free-form human readable summary in English. The maximum length is 500\ncharacters.", + "description": "Free-form human readable summary in English. The maximum length is 500 characters.", "type": "string" }, "etag": { - "description": "Fingerprint of the Insight. Provides optimistic locking when updating\nstates.", + "description": "Fingerprint of the Insight. Provides optimistic locking when updating states.", "type": "string" }, "insightSubtype": { @@ -481,7 +481,7 @@ "type": "string" }, "observationPeriod": { - "description": "Observation period that led to the insight. The source data used to\ngenerate the insight ends at last_refresh_time and begins at\n(last_refresh_time - observation_period).", + "description": "Observation period that led to the insight. The source data used to generate the insight ends at last_refresh_time and begins at (last_refresh_time - observation_period).", "format": "google-duration", "type": "string" }, @@ -504,7 +504,7 @@ "id": "GoogleCloudRecommenderV1InsightRecommendationReference", "properties": { "recommendation": { - "description": "Recommendation resource name, e.g.\nprojects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]", + "description": "Recommendation resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]", "type": "string" } }, @@ -524,9 +524,9 @@ ], "enumDescriptions": [ "Unspecified state.", - "Insight is active. Content for ACTIVE insights can be updated by Google.\nACTIVE insights can be marked DISMISSED OR ACCEPTED.", - "Some action has been taken based on this insight. Insights become\naccepted when a recommendation derived from the insight has been marked\nCLAIMED, SUCCEEDED, or FAILED. ACTIVE insights can also be marked\nACCEPTED explicitly. Content for ACCEPTED insights is immutable. ACCEPTED\ninsights can only be marked ACCEPTED (which may update state metadata).", - "Insight is dismissed. Content for DISMISSED insights can be updated by\nGoogle. DISMISSED insights can be marked as ACTIVE." + "Insight is active. Content for ACTIVE insights can be updated by Google. ACTIVE insights can be marked DISMISSED OR ACCEPTED.", + "Some action has been taken based on this insight. Insights become accepted when a recommendation derived from the insight has been marked CLAIMED, SUCCEEDED, or FAILED. ACTIVE insights can also be marked ACCEPTED explicitly. Content for ACCEPTED insights is immutable. ACCEPTED insights can only be marked ACCEPTED (which may update state metadata).", + "Insight is dismissed. Content for DISMISSED insights can be updated by Google. DISMISSED insights can be marked as ACTIVE." ], "type": "string" }, @@ -552,7 +552,7 @@ "type": "array" }, "nextPageToken": { - "description": "A token that can be used to request the next page of results. This field is\nempty if there are no additional results.", + "description": "A token that can be used to request the next page of results. This field is empty if there are no additional results.", "type": "string" } }, @@ -563,7 +563,7 @@ "id": "GoogleCloudRecommenderV1ListRecommendationsResponse", "properties": { "nextPageToken": { - "description": "A token that can be used to request the next page of results. This field is\nempty if there are no additional results.", + "description": "A token that can be used to request the next page of results. This field is empty if there are no additional results.", "type": "string" }, "recommendations": { @@ -588,7 +588,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. State properties user wish to include with this state. Full replace of the\ncurrent state_metadata.", + "description": "Optional. State properties user wish to include with this state. Full replace of the current state_metadata.", "type": "object" } }, @@ -606,7 +606,7 @@ "additionalProperties": { "type": "string" }, - "description": "State properties to include with this state. Overwrites any existing\n`state_metadata`.\nKeys must match the regex /^a-z0-9{0,62}$/.\nValues must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.", + "description": "State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^a-z0-9{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.", "type": "object" } }, @@ -624,7 +624,7 @@ "additionalProperties": { "type": "string" }, - "description": "State properties to include with this state. Overwrites any existing\n`state_metadata`.\nKeys must match the regex /^a-z0-9{0,62}$/.\nValues must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.", + "description": "State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^a-z0-9{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.", "type": "object" } }, @@ -642,61 +642,61 @@ "additionalProperties": { "type": "string" }, - "description": "State properties to include with this state. Overwrites any existing\n`state_metadata`.\nKeys must match the regex /^a-z0-9{0,62}$/.\nValues must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.", + "description": "State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^a-z0-9{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.", "type": "object" } }, "type": "object" }, "GoogleCloudRecommenderV1Operation": { - "description": "Contains an operation for a resource loosely based on the JSON-PATCH format\nwith support for:\n\n* Custom filters for describing partial array patch.\n* Extended path values for describing nested arrays.\n* Custom fields for describing the resource for which the operation is being\n described.\n* Allows extension to custom operations not natively supported by RFC6902.\nSee https://tools.ietf.org/html/rfc6902 for details on the original RFC.", + "description": "Contains an operation for a resource loosely based on the JSON-PATCH format with support for: * Custom filters for describing partial array patch. * Extended path values for describing nested arrays. * Custom fields for describing the resource for which the operation is being described. * Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC.", "id": "GoogleCloudRecommenderV1Operation", "properties": { "action": { - "description": "Type of this operation. Contains one of 'and', 'remove', 'replace', 'move',\n'copy', 'test' and custom operations. This field is case-insensitive and\nalways populated.", + "description": "Type of this operation. Contains one of 'and', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated.", "type": "string" }, "path": { - "description": "Path to the target field being operated on. If the operation is at the\nresource level, then path should be \"/\". This field is always populated.", + "description": "Path to the target field being operated on. If the operation is at the resource level, then path should be \"/\". This field is always populated.", "type": "string" }, "pathFilters": { "additionalProperties": { "type": "any" }, - "description": "Set of filters to apply if `path` refers to array elements or nested array\nelements in order to narrow down to a single unique element that is being\ntested/modified.\nThis is intended to be an exact match per filter. To perform advanced\nmatching, use path_value_matchers.\n\n* Example: {\n \"/versions/*/name\" : \"it-123\"\n \"/versions/*/targetSize/percent\": 20\n }\n* Example: {\n \"/bindings/*/role\": \"roles/admin\"\n \"/bindings/*/condition\" : null\n }\n* Example: {\n \"/bindings/*/role\": \"roles/admin\"\n \"/bindings/*/members/*\" : [\"x@google.com\", \"y@google.com\"]\n }\nWhen both path_filters and path_value_matchers are set, an implicit AND\nmust be performed.", + "description": "Set of filters to apply if `path` refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers. * Example: { \"/versions/*/name\" : \"it-123\" \"/versions/*/targetSize/percent\": 20 } * Example: { \"/bindings/*/role\": \"roles/admin\" \"/bindings/*/condition\" : null } * Example: { \"/bindings/*/role\": \"roles/admin\" \"/bindings/*/members/*\" : [\"x@google.com\", \"y@google.com\"] } When both path_filters and path_value_matchers are set, an implicit AND must be performed.", "type": "object" }, "pathValueMatchers": { "additionalProperties": { "$ref": "GoogleCloudRecommenderV1ValueMatcher" }, - "description": "Similar to path_filters, this contains set of filters to apply if `path`\nfield referes to array elements. This is meant to support value matching\nbeyond exact match. To perform exact match, use path_filters.\nWhen both path_filters and path_value_matchers are set, an implicit AND\nmust be performed.", + "description": "Similar to path_filters, this contains set of filters to apply if `path` field referes to array elements. This is meant to support value matching beyond exact match. To perform exact match, use path_filters. When both path_filters and path_value_matchers are set, an implicit AND must be performed.", "type": "object" }, "resource": { - "description": "Contains the fully qualified resource name. This field is always populated.\nex: //cloudresourcemanager.googleapis.com/projects/foo.", + "description": "Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo.", "type": "string" }, "resourceType": { - "description": "Type of GCP resource being modified/tested. This field is always populated.\nExample: cloudresourcemanager.googleapis.com/Project,\ncompute.googleapis.com/Instance", + "description": "Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance", "type": "string" }, "sourcePath": { - "description": "Can be set with action 'copy' or 'move' to indicate the source field within\nresource or source_resource, ignored if provided for other operation types.", + "description": "Can be set with action 'copy' or 'move' to indicate the source field within resource or source_resource, ignored if provided for other operation types.", "type": "string" }, "sourceResource": { - "description": "Can be set with action 'copy' to copy resource configuration across\ndifferent resources of the same type. Example: A resource clone can be\ndone via action = 'copy', path = \"/\", from = \"/\",\nsource_resource = and resource_name = .\nThis field is empty for all other values of `action`.", + "description": "Can be set with action 'copy' to copy resource configuration across different resources of the same type. Example: A resource clone can be done via action = 'copy', path = \"/\", from = \"/\", source_resource = and resource_name = . This field is empty for all other values of `action`.", "type": "string" }, "value": { - "description": "Value for the `path` field. Will be set for actions:'add'/'replace'.\nMaybe set for action: 'test'. Either this or `value_matcher` will be set\nfor 'test' operation. An exact match must be performed.", + "description": "Value for the `path` field. Will be set for actions:'add'/'replace'. Maybe set for action: 'test'. Either this or `value_matcher` will be set for 'test' operation. An exact match must be performed.", "type": "any" }, "valueMatcher": { "$ref": "GoogleCloudRecommenderV1ValueMatcher", - "description": "Can be set for action 'test' for advanced matching for the value of\n'path' field. Either this or `value` will be set for 'test' operation." + "description": "Can be set for action 'test' for advanced matching for the value of 'path' field. Either this or `value` will be set for 'test' operation." } }, "type": "object" @@ -706,7 +706,7 @@ "id": "GoogleCloudRecommenderV1OperationGroup", "properties": { "operations": { - "description": "List of operations across one or more resources that belong to this group.\nLoosely based on RFC6902 and should be performed in the order they appear.", + "description": "List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear.", "items": { "$ref": "GoogleCloudRecommenderV1Operation" }, @@ -716,11 +716,11 @@ "type": "object" }, "GoogleCloudRecommenderV1Recommendation": { - "description": "A recommendation along with a suggested action. E.g., a rightsizing\nrecommendation for an underutilized VM, IAM role recommendations, etc", + "description": "A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc", "id": "GoogleCloudRecommenderV1Recommendation", "properties": { "additionalImpact": { - "description": "Optional set of additional impact that this recommendation may have when\ntrying to optimize for the primary category. These may be positive\nor negative.", + "description": "Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative.", "items": { "$ref": "GoogleCloudRecommenderV1Impact" }, @@ -738,15 +738,15 @@ "description": "Content of the recommendation describing recommended changes to resources." }, "description": { - "description": "Free-form human readable summary in English. The maximum length is 500\ncharacters.", + "description": "Free-form human readable summary in English. The maximum length is 500 characters.", "type": "string" }, "etag": { - "description": "Fingerprint of the Recommendation. Provides optimistic locking when\nupdating states.", + "description": "Fingerprint of the Recommendation. Provides optimistic locking when updating states.", "type": "string" }, "lastRefreshTime": { - "description": "Last time this recommendation was refreshed by the system that created it\nin the first place.", + "description": "Last time this recommendation was refreshed by the system that created it in the first place.", "format": "google-datetime", "type": "string" }, @@ -756,10 +756,10 @@ }, "primaryImpact": { "$ref": "GoogleCloudRecommenderV1Impact", - "description": "The primary impact that this recommendation can have while trying to\noptimize for one category." + "description": "The primary impact that this recommendation can have while trying to optimize for one category." }, "recommenderSubtype": { - "description": "Contains an identifier for a subtype of recommendations produced for the\nsame recommender. Subtype is a function of content and impact, meaning a\nnew subtype might be added when significant changes to `content` or\n`primary_impact.category` are introduced. See the Recommenders section\nto see a list of subtypes for a given Recommender.\n\nExamples:\n For recommender = \"google.iam.policy.Recommender\",\n recommender_subtype can be one of \"REMOVE_ROLE\"/\"REPLACE_ROLE\"", + "description": "Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = \"google.iam.policy.Recommender\", recommender_subtype can be one of \"REMOVE_ROLE\"/\"REPLACE_ROLE\"", "type": "string" }, "stateInfo": { @@ -774,7 +774,7 @@ "id": "GoogleCloudRecommenderV1RecommendationContent", "properties": { "operationGroups": { - "description": "Operations to one or more Google Cloud resources grouped in such a way\nthat, all operations within one group are expected to be performed\natomically and in an order.", + "description": "Operations to one or more Google Cloud resources grouped in such a way that, all operations within one group are expected to be performed atomically and in an order.", "items": { "$ref": "GoogleCloudRecommenderV1OperationGroup" }, @@ -788,7 +788,7 @@ "id": "GoogleCloudRecommenderV1RecommendationInsightReference", "properties": { "insight": { - "description": "Insight resource name, e.g.\nprojects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]", + "description": "Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]", "type": "string" } }, @@ -810,11 +810,11 @@ ], "enumDescriptions": [ "Default state. Don't use directly.", - "Recommendation is active and can be applied. Recommendations content can\nbe updated by Google.\n\nACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", - "Recommendation is in claimed state. Recommendations content is\nimmutable and cannot be updated by Google.\n\nCLAIMED recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", - "Recommendation is in succeeded state. Recommendations content is\nimmutable and cannot be updated by Google.\n\nSUCCEEDED recommendations can be marked as SUCCEEDED, or FAILED.", - "Recommendation is in failed state. Recommendations content is immutable\nand cannot be updated by Google.\n\nFAILED recommendations can be marked as SUCCEEDED, or FAILED.", - "Recommendation is in dismissed state. Recommendation content can be\nupdated by Google.\n\nDISMISSED recommendations can be marked as ACTIVE." + "Recommendation is active and can be applied. Recommendations content can be updated by Google. ACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", + "Recommendation is in claimed state. Recommendations content is immutable and cannot be updated by Google. CLAIMED recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", + "Recommendation is in succeeded state. Recommendations content is immutable and cannot be updated by Google. SUCCEEDED recommendations can be marked as SUCCEEDED, or FAILED.", + "Recommendation is in failed state. Recommendations content is immutable and cannot be updated by Google. FAILED recommendations can be marked as SUCCEEDED, or FAILED.", + "Recommendation is in dismissed state. Recommendation content can be updated by Google. DISMISSED recommendations can be marked as ACTIVE." ], "type": "string" }, @@ -833,7 +833,7 @@ "id": "GoogleCloudRecommenderV1ValueMatcher", "properties": { "matchesPattern": { - "description": "To be used for full regex matching. The regular expression is using the\nGoogle RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be\nused with RE2::FullMatch", + "description": "To be used for full regex matching. The regular expression is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2::FullMatch", "type": "string" } }, @@ -848,12 +848,12 @@ "type": "string" }, "nanos": { - "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", + "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", "format": "int32", "type": "integer" }, "units": { - "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", "format": "int64", "type": "string" } diff --git a/discovery/recommender-v1beta1.json b/discovery/recommender-v1beta1.json index 67fb24d566..ab72868c5f 100644 --- a/discovery/recommender-v1beta1.json +++ b/discovery/recommender-v1beta1.json @@ -114,7 +114,7 @@ "insights": { "methods": { "get": { - "description": "Gets the requested insight. Requires the recommender.*.get IAM permission\nfor the specified insight type.", + "description": "Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}", "httpMethod": "GET", "id": "recommender.projects.locations.insightTypes.insights.get", @@ -139,7 +139,7 @@ ] }, "list": { - "description": "Lists insights for a Cloud project. Requires the recommender.*.list IAM\npermission for the specified insight type.", + "description": "Lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the specified insight type.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights", "httpMethod": "GET", "id": "recommender.projects.locations.insightTypes.insights.list", @@ -148,23 +148,23 @@ ], "parameters": { "filter": { - "description": "Optional. Filter expression to restrict the insights returned. Supported\nfilter fields: state\nEg: `state:\"DISMISSED\" or state:\"ACTIVE\"", + "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:\"DISMISSED\" or state:\"ACTIVE\"", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of results to return from this request. Non-positive\nvalues are ignored. If not specified, the server will determine the number\nof results to return.", + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. If present, retrieves the next batch of results from the preceding call to\nthis method. `page_token` must be the value of `next_page_token` from the\nprevious response. The values of other method parameters must be identical\nto those in the previous call.", + "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The container resource on which to execute the request.\nAcceptable formats:\n\n1.\n\"projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]\",\n\nLOCATION here refers to GCP Locations:\nhttps://cloud.google.com/about/locations/", + "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. \"projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]\", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/insightTypes/[^/]+$", "required": true, @@ -180,7 +180,7 @@ ] }, "markAccepted": { - "description": "Marks the Insight State as Accepted. Users can use this method to\nindicate to the Recommender API that they have applied some action based\non the insight. This stops the insight content from being updated.\n\nMarkInsightAccepted can be applied to insights in ACTIVE state. Requires\nthe recommender.*.update IAM permission for the specified insight.", + "description": "Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted", "httpMethod": "POST", "id": "recommender.projects.locations.insightTypes.insights.markAccepted", @@ -216,7 +216,7 @@ "recommendations": { "methods": { "get": { - "description": "Gets the requested recommendation. Requires the recommender.*.get\nIAM permission for the specified recommender.", + "description": "Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}", "httpMethod": "GET", "id": "recommender.projects.locations.recommenders.recommendations.get", @@ -241,7 +241,7 @@ ] }, "list": { - "description": "Lists recommendations for a Cloud project. Requires the recommender.*.list\nIAM permission for the specified recommender.", + "description": "Lists recommendations for a Cloud project. Requires the recommender.*.list IAM permission for the specified recommender.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations", "httpMethod": "GET", "id": "recommender.projects.locations.recommenders.recommendations.list", @@ -250,23 +250,23 @@ ], "parameters": { "filter": { - "description": "Filter expression to restrict the recommendations returned. Supported\nfilter fields: state_info.state\nEg: `state_info.state:\"DISMISSED\" or state_info.state:\"FAILED\"", + "description": "Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:\"DISMISSED\" or state_info.state:\"FAILED\"", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of results to return from this request. Non-positive\nvalues are ignored. If not specified, the server will determine the number\nof results to return.", + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. If present, retrieves the next batch of results from the preceding call to\nthis method. `page_token` must be the value of `next_page_token` from the\nprevious response. The values of other method parameters must be identical\nto those in the previous call.", + "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The container resource on which to execute the request.\nAcceptable formats:\n\n1.\n\"projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]\",\n\nLOCATION here refers to GCP Locations:\nhttps://cloud.google.com/about/locations/", + "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. \"projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]\", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+$", "required": true, @@ -282,7 +282,7 @@ ] }, "markClaimed": { - "description": "Marks the Recommendation State as Claimed. Users can use this method to\nindicate to the Recommender API that they are starting to apply the\nrecommendation themselves. This stops the recommendation content from being\nupdated. Associated insights are frozen and placed in the ACCEPTED state.\n\nMarkRecommendationClaimed can be applied to recommendations in CLAIMED or\nACTIVE state.\n\nRequires the recommender.*.update IAM permission for the specified\nrecommender.", + "description": "Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed", "httpMethod": "POST", "id": "recommender.projects.locations.recommenders.recommendations.markClaimed", @@ -310,7 +310,7 @@ ] }, "markFailed": { - "description": "Marks the Recommendation State as Failed. Users can use this method to\nindicate to the Recommender API that they have applied the recommendation\nthemselves, and the operation failed. This stops the recommendation content\nfrom being updated. Associated insights are frozen and placed in the\nACCEPTED state.\n\nMarkRecommendationFailed can be applied to recommendations in ACTIVE,\nCLAIMED, SUCCEEDED, or FAILED state.\n\nRequires the recommender.*.update IAM permission for the specified\nrecommender.", + "description": "Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed", "httpMethod": "POST", "id": "recommender.projects.locations.recommenders.recommendations.markFailed", @@ -338,7 +338,7 @@ ] }, "markSucceeded": { - "description": "Marks the Recommendation State as Succeeded. Users can use this method to\nindicate to the Recommender API that they have applied the recommendation\nthemselves, and the operation was successful. This stops the recommendation\ncontent from being updated. Associated insights are frozen and placed in\nthe ACCEPTED state.\n\nMarkRecommendationSucceeded can be applied to recommendations in ACTIVE,\nCLAIMED, SUCCEEDED, or FAILED state.\n\nRequires the recommender.*.update IAM permission for the specified\nrecommender.", + "description": "Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded", "httpMethod": "POST", "id": "recommender.projects.locations.recommenders.recommendations.markSucceeded", @@ -374,7 +374,7 @@ } } }, - "revision": "20200502", + "revision": "20200801", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudRecommenderV1beta1CostProjection": { @@ -383,7 +383,7 @@ "properties": { "cost": { "$ref": "GoogleTypeMoney", - "description": "An approximate projection on amount saved or amount incurred. Negative cost\nunits indicate cost savings and positive cost units indicate increase.\nSee google.type.Money documentation for positive/negative units." + "description": "An approximate projection on amount saved or amount incurred. Negative cost units indicate cost savings and positive cost units indicate increase. See google.type.Money documentation for positive/negative units." }, "duration": { "description": "Duration for which this cost applies.", @@ -423,7 +423,7 @@ "type": "object" }, "GoogleCloudRecommenderV1beta1Insight": { - "description": "An insight along with the information used to derive the insight. The insight\nmay have associated recomendations as well.", + "description": "An insight along with the information used to derive the insight. The insight may have associated recomendations as well.", "id": "GoogleCloudRecommenderV1beta1Insight", "properties": { "associatedRecommendations": { @@ -456,15 +456,15 @@ "description": "Properties of the object.", "type": "any" }, - "description": "A struct of custom fields to explain the insight.\nExample: \"grantedPermissionsCount\": \"1000\"", + "description": "A struct of custom fields to explain the insight. Example: \"grantedPermissionsCount\": \"1000\"", "type": "object" }, "description": { - "description": "Free-form human readable summary in English. The maximum length is 500\ncharacters.", + "description": "Free-form human readable summary in English. The maximum length is 500 characters.", "type": "string" }, "etag": { - "description": "Fingerprint of the Insight. Provides optimistic locking when updating\nstates.", + "description": "Fingerprint of the Insight. Provides optimistic locking when updating states.", "type": "string" }, "insightSubtype": { @@ -481,7 +481,7 @@ "type": "string" }, "observationPeriod": { - "description": "Observation period that led to the insight. The source data used to\ngenerate the insight ends at last_refresh_time and begins at\n(last_refresh_time - observation_period).", + "description": "Observation period that led to the insight. The source data used to generate the insight ends at last_refresh_time and begins at (last_refresh_time - observation_period).", "format": "google-duration", "type": "string" }, @@ -504,7 +504,7 @@ "id": "GoogleCloudRecommenderV1beta1InsightRecommendationReference", "properties": { "recommendation": { - "description": "Recommendation resource name, e.g.\nprojects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]", + "description": "Recommendation resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]", "type": "string" } }, @@ -524,9 +524,9 @@ ], "enumDescriptions": [ "Unspecified state.", - "Insight is active. Content for ACTIVE insights can be updated by Google.\nACTIVE insights can be marked DISMISSED OR ACCEPTED.", - "Some action has been taken based on this insight. Insights become\naccepted when a recommendation derived from the insight has been marked\nCLAIMED, SUCCEEDED, or FAILED. ACTIVE insights can also be marked\nACCEPTED explicitly. Content for ACCEPTED insights is immutable. ACCEPTED\ninsights can only be marked ACCEPTED (which may update state metadata).", - "Insight is dismissed. Content for DISMISSED insights can be updated by\nGoogle. DISMISSED insights can be marked as ACTIVE." + "Insight is active. Content for ACTIVE insights can be updated by Google. ACTIVE insights can be marked DISMISSED OR ACCEPTED.", + "Some action has been taken based on this insight. Insights become accepted when a recommendation derived from the insight has been marked CLAIMED, SUCCEEDED, or FAILED. ACTIVE insights can also be marked ACCEPTED explicitly. Content for ACCEPTED insights is immutable. ACCEPTED insights can only be marked ACCEPTED (which may update state metadata).", + "Insight is dismissed. Content for DISMISSED insights can be updated by Google. DISMISSED insights can be marked as ACTIVE." ], "type": "string" }, @@ -552,7 +552,7 @@ "type": "array" }, "nextPageToken": { - "description": "A token that can be used to request the next page of results. This field is\nempty if there are no additional results.", + "description": "A token that can be used to request the next page of results. This field is empty if there are no additional results.", "type": "string" } }, @@ -563,7 +563,7 @@ "id": "GoogleCloudRecommenderV1beta1ListRecommendationsResponse", "properties": { "nextPageToken": { - "description": "A token that can be used to request the next page of results. This field is\nempty if there are no additional results.", + "description": "A token that can be used to request the next page of results. This field is empty if there are no additional results.", "type": "string" }, "recommendations": { @@ -588,7 +588,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. State properties user wish to include with this state. Full replace of the\ncurrent state_metadata.", + "description": "Optional. State properties user wish to include with this state. Full replace of the current state_metadata.", "type": "object" } }, @@ -606,7 +606,7 @@ "additionalProperties": { "type": "string" }, - "description": "State properties to include with this state. Overwrites any existing\n`state_metadata`.\nKeys must match the regex /^a-z0-9{0,62}$/.\nValues must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.", + "description": "State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^a-z0-9{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.", "type": "object" } }, @@ -624,7 +624,7 @@ "additionalProperties": { "type": "string" }, - "description": "State properties to include with this state. Overwrites any existing\n`state_metadata`.\nKeys must match the regex /^a-z0-9{0,62}$/.\nValues must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.", + "description": "State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^a-z0-9{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.", "type": "object" } }, @@ -642,61 +642,61 @@ "additionalProperties": { "type": "string" }, - "description": "State properties to include with this state. Overwrites any existing\n`state_metadata`.\nKeys must match the regex /^a-z0-9{0,62}$/.\nValues must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.", + "description": "State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^a-z0-9{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.", "type": "object" } }, "type": "object" }, "GoogleCloudRecommenderV1beta1Operation": { - "description": "Contains an operation for a resource loosely based on the JSON-PATCH format\nwith support for:\n\n* Custom filters for describing partial array patch.\n* Extended path values for describing nested arrays.\n* Custom fields for describing the resource for which the operation is being\n described.\n* Allows extension to custom operations not natively supported by RFC6902.\nSee https://tools.ietf.org/html/rfc6902 for details on the original RFC.", + "description": "Contains an operation for a resource loosely based on the JSON-PATCH format with support for: * Custom filters for describing partial array patch. * Extended path values for describing nested arrays. * Custom fields for describing the resource for which the operation is being described. * Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC.", "id": "GoogleCloudRecommenderV1beta1Operation", "properties": { "action": { - "description": "Type of this operation. Contains one of 'and', 'remove', 'replace', 'move',\n'copy', 'test' and 'custom' operations. This field is case-insensitive and\nalways populated.", + "description": "Type of this operation. Contains one of 'and', 'remove', 'replace', 'move', 'copy', 'test' and 'custom' operations. This field is case-insensitive and always populated.", "type": "string" }, "path": { - "description": "Path to the target field being operated on. If the operation is at the\nresource level, then path should be \"/\". This field is always populated.", + "description": "Path to the target field being operated on. If the operation is at the resource level, then path should be \"/\". This field is always populated.", "type": "string" }, "pathFilters": { "additionalProperties": { "type": "any" }, - "description": "Set of filters to apply if `path` refers to array elements or nested array\nelements in order to narrow down to a single unique element that is being\ntested/modified.\nThis is intended to be an exact match per filter. To perform advanced\nmatching, use path_value_matchers.\n\n* Example: {\n \"/versions/*/name\" : \"it-123\"\n \"/versions/*/targetSize/percent\": 20\n }\n* Example: {\n \"/bindings/*/role\": \"roles/admin\"\n \"/bindings/*/condition\" : null\n }\n* Example: {\n \"/bindings/*/role\": \"roles/admin\"\n \"/bindings/*/members/*\" : [\"x@google.com\", \"y@google.com\"]\n }\nWhen both path_filters and path_value_matchers are set, an implicit AND\nmust be performed.", + "description": "Set of filters to apply if `path` refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers. * Example: { \"/versions/*/name\" : \"it-123\" \"/versions/*/targetSize/percent\": 20 } * Example: { \"/bindings/*/role\": \"roles/admin\" \"/bindings/*/condition\" : null } * Example: { \"/bindings/*/role\": \"roles/admin\" \"/bindings/*/members/*\" : [\"x@google.com\", \"y@google.com\"] } When both path_filters and path_value_matchers are set, an implicit AND must be performed.", "type": "object" }, "pathValueMatchers": { "additionalProperties": { "$ref": "GoogleCloudRecommenderV1beta1ValueMatcher" }, - "description": "Similar to path_filters, this contains set of filters to apply if `path`\nfield referes to array elements. This is meant to support value matching\nbeyond exact match. To perform exact match, use path_filters.\nWhen both path_filters and path_value_matchers are set, an implicit AND\nmust be performed.", + "description": "Similar to path_filters, this contains set of filters to apply if `path` field referes to array elements. This is meant to support value matching beyond exact match. To perform exact match, use path_filters. When both path_filters and path_value_matchers are set, an implicit AND must be performed.", "type": "object" }, "resource": { - "description": "Contains the fully qualified resource name. This field is always populated.\nex: //cloudresourcemanager.googleapis.com/projects/foo.", + "description": "Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo.", "type": "string" }, "resourceType": { - "description": "Type of GCP resource being modified/tested. This field is always populated.\nExample: cloudresourcemanager.googleapis.com/Project,\ncompute.googleapis.com/Instance", + "description": "Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance", "type": "string" }, "sourcePath": { - "description": "Can be set with action 'copy' or 'move' to indicate the source field within\nresource or source_resource, ignored if provided for other operation types.", + "description": "Can be set with action 'copy' or 'move' to indicate the source field within resource or source_resource, ignored if provided for other operation types.", "type": "string" }, "sourceResource": { - "description": "Can be set with action 'copy' to copy resource configuration across\ndifferent resources of the same type. Example: A resource clone can be\ndone via action = 'copy', path = \"/\", from = \"/\",\nsource_resource = and resource_name = .\nThis field is empty for all other values of `action`.", + "description": "Can be set with action 'copy' to copy resource configuration across different resources of the same type. Example: A resource clone can be done via action = 'copy', path = \"/\", from = \"/\", source_resource = and resource_name = . This field is empty for all other values of `action`.", "type": "string" }, "value": { - "description": "Value for the `path` field. Will be set for actions:'add'/'replace'.\nMaybe set for action: 'test'. Either this or `value_matcher` will be set\nfor 'test' operation. An exact match must be performed.", + "description": "Value for the `path` field. Will be set for actions:'add'/'replace'. Maybe set for action: 'test'. Either this or `value_matcher` will be set for 'test' operation. An exact match must be performed.", "type": "any" }, "valueMatcher": { "$ref": "GoogleCloudRecommenderV1beta1ValueMatcher", - "description": "Can be set for action 'test' for advanced matching for the value of\n'path' field. Either this or `value` will be set for 'test' operation." + "description": "Can be set for action 'test' for advanced matching for the value of 'path' field. Either this or `value` will be set for 'test' operation." } }, "type": "object" @@ -706,7 +706,7 @@ "id": "GoogleCloudRecommenderV1beta1OperationGroup", "properties": { "operations": { - "description": "List of operations across one or more resources that belong to this group.\nLoosely based on RFC6902 and should be performed in the order they appear.", + "description": "List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear.", "items": { "$ref": "GoogleCloudRecommenderV1beta1Operation" }, @@ -716,11 +716,11 @@ "type": "object" }, "GoogleCloudRecommenderV1beta1Recommendation": { - "description": "A recommendation along with a suggested action. E.g., a rightsizing\nrecommendation for an underutilized VM, IAM role recommendations, etc", + "description": "A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc", "id": "GoogleCloudRecommenderV1beta1Recommendation", "properties": { "additionalImpact": { - "description": "Optional set of additional impact that this recommendation may have when\ntrying to optimize for the primary category. These may be positive\nor negative.", + "description": "Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative.", "items": { "$ref": "GoogleCloudRecommenderV1beta1Impact" }, @@ -738,15 +738,15 @@ "description": "Content of the recommendation describing recommended changes to resources." }, "description": { - "description": "Free-form human readable summary in English. The maximum length is 500\ncharacters.", + "description": "Free-form human readable summary in English. The maximum length is 500 characters.", "type": "string" }, "etag": { - "description": "Fingerprint of the Recommendation. Provides optimistic locking when\nupdating states.", + "description": "Fingerprint of the Recommendation. Provides optimistic locking when updating states.", "type": "string" }, "lastRefreshTime": { - "description": "Last time this recommendation was refreshed by the system that created it\nin the first place.", + "description": "Last time this recommendation was refreshed by the system that created it in the first place.", "format": "google-datetime", "type": "string" }, @@ -756,10 +756,10 @@ }, "primaryImpact": { "$ref": "GoogleCloudRecommenderV1beta1Impact", - "description": "The primary impact that this recommendation can have while trying to\noptimize for one category." + "description": "The primary impact that this recommendation can have while trying to optimize for one category." }, "recommenderSubtype": { - "description": "Contains an identifier for a subtype of recommendations produced for the\nsame recommender. Subtype is a function of content and impact, meaning a\nnew subtype might be added when significant changes to `content` or\n`primary_impact.category` are introduced. See the Recommenders section\nto see a list of subtypes for a given Recommender.\n\nExamples:\n For recommender = \"google.iam.policy.Recommender\",\n recommender_subtype can be one of \"REMOVE_ROLE\"/\"REPLACE_ROLE\"", + "description": "Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = \"google.iam.policy.Recommender\", recommender_subtype can be one of \"REMOVE_ROLE\"/\"REPLACE_ROLE\"", "type": "string" }, "stateInfo": { @@ -774,7 +774,7 @@ "id": "GoogleCloudRecommenderV1beta1RecommendationContent", "properties": { "operationGroups": { - "description": "Operations to one or more Google Cloud resources grouped in such a way\nthat, all operations within one group are expected to be performed\natomically and in an order.", + "description": "Operations to one or more Google Cloud resources grouped in such a way that, all operations within one group are expected to be performed atomically and in an order.", "items": { "$ref": "GoogleCloudRecommenderV1beta1OperationGroup" }, @@ -788,7 +788,7 @@ "id": "GoogleCloudRecommenderV1beta1RecommendationInsightReference", "properties": { "insight": { - "description": "Insight resource name, e.g.\nprojects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]", + "description": "Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]", "type": "string" } }, @@ -810,11 +810,11 @@ ], "enumDescriptions": [ "Default state. Don't use directly.", - "Recommendation is active and can be applied. Recommendations content can\nbe updated by Google.\n\nACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", - "Recommendation is in claimed state. Recommendations content is\nimmutable and cannot be updated by Google.\n\nCLAIMED recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", - "Recommendation is in succeeded state. Recommendations content is\nimmutable and cannot be updated by Google.\n\nSUCCEEDED recommendations can be marked as SUCCEEDED, or FAILED.", - "Recommendation is in failed state. Recommendations content is immutable\nand cannot be updated by Google.\n\nFAILED recommendations can be marked as SUCCEEDED, or FAILED.", - "Recommendation is in dismissed state. Recommendation content can be\nupdated by Google.\n\nDISMISSED recommendations can be marked as ACTIVE." + "Recommendation is active and can be applied. Recommendations content can be updated by Google. ACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", + "Recommendation is in claimed state. Recommendations content is immutable and cannot be updated by Google. CLAIMED recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", + "Recommendation is in succeeded state. Recommendations content is immutable and cannot be updated by Google. SUCCEEDED recommendations can be marked as SUCCEEDED, or FAILED.", + "Recommendation is in failed state. Recommendations content is immutable and cannot be updated by Google. FAILED recommendations can be marked as SUCCEEDED, or FAILED.", + "Recommendation is in dismissed state. Recommendation content can be updated by Google. DISMISSED recommendations can be marked as ACTIVE." ], "type": "string" }, @@ -833,7 +833,7 @@ "id": "GoogleCloudRecommenderV1beta1ValueMatcher", "properties": { "matchesPattern": { - "description": "To be used for full regex matching. The regular expression is using the\nGoogle RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be\nused with RE2::FullMatch", + "description": "To be used for full regex matching. The regular expression is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2::FullMatch", "type": "string" } }, @@ -848,12 +848,12 @@ "type": "string" }, "nanos": { - "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", + "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", "format": "int32", "type": "integer" }, "units": { - "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", "format": "int64", "type": "string" } diff --git a/discovery/runtimeconfig-v1.json b/discovery/runtimeconfig-v1.json index 9ef94f439b..e1d853c852 100644 --- a/discovery/runtimeconfig-v1.json +++ b/discovery/runtimeconfig-v1.json @@ -111,7 +111,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "flatPath": "v1/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "runtimeconfig.operations.cancel", @@ -140,7 +140,7 @@ ] }, "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1/operations/{operationsId}", "httpMethod": "DELETE", "id": "runtimeconfig.operations.delete", @@ -166,7 +166,7 @@ ] }, "list": { - "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", "flatPath": "v1/operations", "httpMethod": "GET", "id": "runtimeconfig.operations.list", @@ -210,7 +210,7 @@ } } }, - "revision": "20200727", + "revision": "20200803", "rootUrl": "https://runtimeconfig.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -220,7 +220,7 @@ "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" @@ -244,11 +244,11 @@ "type": "object" }, "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "properties": { "done": { - "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { @@ -260,11 +260,11 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" }, "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "response": { @@ -272,14 +272,14 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" } }, "type": "object" }, "Status": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { @@ -288,7 +288,7 @@ "type": "integer" }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -299,7 +299,7 @@ "type": "array" }, "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, diff --git a/discovery/runtimeconfig-v1beta1.json b/discovery/runtimeconfig-v1beta1.json index 6a8068f569..0b5835f623 100644 --- a/discovery/runtimeconfig-v1beta1.json +++ b/discovery/runtimeconfig-v1beta1.json @@ -113,7 +113,7 @@ "configs": { "methods": { "create": { - "description": "Creates a new RuntimeConfig resource. The configuration name must be\nunique within project.", + "description": "Creates a new RuntimeConfig resource. The configuration name must be unique within project.", "flatPath": "v1beta1/projects/{projectsId}/configs", "httpMethod": "POST", "id": "runtimeconfig.projects.configs.create", @@ -122,14 +122,14 @@ ], "parameters": { "parent": { - "description": "The [project\nID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.", + "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) for this request, in the format `projects/[PROJECT_ID]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, "type": "string" }, "requestId": { - "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.", + "description": "An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters.", "location": "query", "type": "string" } @@ -156,7 +156,7 @@ ], "parameters": { "name": { - "description": "The RuntimeConfig resource to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", + "description": "The RuntimeConfig resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+$", "required": true, @@ -182,7 +182,7 @@ ], "parameters": { "name": { - "description": "The name of the RuntimeConfig resource to retrieve, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", + "description": "The name of the RuntimeConfig resource to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+$", "required": true, @@ -199,7 +199,7 @@ ] }, "getIamPolicy": { - "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", + "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": "v1beta1/projects/{projectsId}/configs/{configsId}:getIamPolicy", "httpMethod": "GET", "id": "runtimeconfig.projects.configs.getIamPolicy", @@ -208,13 +208,13 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" }, "resource": { - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+$", "required": true, @@ -240,18 +240,18 @@ ], "parameters": { "pageSize": { - "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.", + "description": "Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.", + "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "parent": { - "description": "The [project\nID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.", + "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) for this request, in the format `projects/[PROJECT_ID]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -268,7 +268,7 @@ ] }, "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "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": "v1beta1/projects/{projectsId}/configs/{configsId}:setIamPolicy", "httpMethod": "POST", "id": "runtimeconfig.projects.configs.setIamPolicy", @@ -277,7 +277,7 @@ ], "parameters": { "resource": { - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+$", "required": true, @@ -297,7 +297,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "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": "v1beta1/projects/{projectsId}/configs/{configsId}:testIamPermissions", "httpMethod": "POST", "id": "runtimeconfig.projects.configs.testIamPermissions", @@ -306,7 +306,7 @@ ], "parameters": { "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+$", "required": true, @@ -335,7 +335,7 @@ ], "parameters": { "name": { - "description": "The name of the RuntimeConfig resource to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", + "description": "The name of the RuntimeConfig resource to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+$", "required": true, @@ -359,7 +359,7 @@ "operations": { "methods": { "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}", "httpMethod": "GET", "id": "runtimeconfig.projects.configs.operations.get", @@ -385,7 +385,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "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": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}:testIamPermissions", "httpMethod": "POST", "id": "runtimeconfig.projects.configs.operations.testIamPermissions", @@ -394,7 +394,7 @@ ], "parameters": { "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+/operations/.*$", "required": true, @@ -418,7 +418,7 @@ "variables": { "methods": { "create": { - "description": "Creates a variable within the given configuration. You cannot create\na variable with a name that is a prefix of an existing variable name, or a\nname that has an existing variable name as a prefix.\n\nTo learn more about creating a variable, read the\n[Setting and Getting\nData](/deployment-manager/runtime-configurator/set-and-get-variables)\ndocumentation.", + "description": "Creates a variable within the given configuration. You cannot create a variable with a name that is a prefix of an existing variable name, or a name that has an existing variable name as a prefix. To learn more about creating a variable, read the [Setting and Getting Data](/deployment-manager/runtime-configurator/set-and-get-variables) documentation.", "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables", "httpMethod": "POST", "id": "runtimeconfig.projects.configs.variables.create", @@ -427,14 +427,14 @@ ], "parameters": { "parent": { - "description": "The path to the RutimeConfig resource that this variable should belong to.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", + "description": "The path to the RutimeConfig resource that this variable should belong to. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+$", "required": true, "type": "string" }, "requestId": { - "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.", + "description": "An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters.", "location": "query", "type": "string" } @@ -452,7 +452,7 @@ ] }, "delete": { - "description": "Deletes a variable or multiple variables.\n\nIf you specify a variable name, then that variable is deleted. If you\nspecify a prefix and `recursive` is true, then all variables with that\nprefix are deleted. You must set a `recursive` to true if you delete\nvariables by prefix.", + "description": "Deletes a variable or multiple variables. If you specify a variable name, then that variable is deleted. If you specify a prefix and `recursive` is true, then all variables with that prefix are deleted. You must set a `recursive` to true if you delete variables by prefix.", "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}", "httpMethod": "DELETE", "id": "runtimeconfig.projects.configs.variables.delete", @@ -461,14 +461,14 @@ ], "parameters": { "name": { - "description": "The name of the variable to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`", + "description": "The name of the variable to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+/variables/.*$", "required": true, "type": "string" }, "recursive": { - "description": "Set to `true` to recursively delete multiple variables with the same\nprefix.", + "description": "Set to `true` to recursively delete multiple variables with the same prefix.", "location": "query", "type": "boolean" } @@ -492,7 +492,7 @@ ], "parameters": { "name": { - "description": "The name of the variable to return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`", + "description": "The name of the variable to return, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+/variables/.*$", "required": true, @@ -509,7 +509,7 @@ ] }, "list": { - "description": "Lists variables within given a configuration, matching any provided\nfilters. This only lists variable names, not the values, unless\n`return_values` is true, in which case only variables that user has IAM\npermission to GetVariable will be returned.", + "description": "Lists variables within given a configuration, matching any provided filters. This only lists variable names, not the values, unless `return_values` is true, in which case only variables that user has IAM permission to GetVariable will be returned.", "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables", "httpMethod": "GET", "id": "runtimeconfig.projects.configs.variables.list", @@ -518,30 +518,30 @@ ], "parameters": { "filter": { - "description": "Filters variables by matching the specified filter. For example:\n\n`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.", + "description": "Filters variables by matching the specified filter. For example: `projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.", "location": "query", "type": "string" }, "pageSize": { - "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.", + "description": "Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.", + "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "parent": { - "description": "The path to the RuntimeConfig resource for which you want to list\nvariables. The configuration must exist beforehand; the path must be in the\nformat:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", + "description": "The path to the RuntimeConfig resource for which you want to list variables. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+$", "required": true, "type": "string" }, "returnValues": { - "description": "The flag indicates whether the user wants to return values of variables.\nIf true, then only those variables that user has IAM GetVariable permission\nwill be returned along with their values.", + "description": "The flag indicates whether the user wants to return values of variables. If true, then only those variables that user has IAM GetVariable permission will be returned along with their values.", "location": "query", "type": "boolean" } @@ -556,7 +556,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "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": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:testIamPermissions", "httpMethod": "POST", "id": "runtimeconfig.projects.configs.variables.testIamPermissions", @@ -565,7 +565,7 @@ ], "parameters": { "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+/variables/.*$", "required": true, @@ -594,7 +594,7 @@ ], "parameters": { "name": { - "description": "The name of the variable to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`", + "description": "The name of the variable to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+/variables/.*$", "required": true, @@ -614,7 +614,7 @@ ] }, "watch": { - "description": "Watches a specific variable and waits for a change in the variable's value.\nWhen there is a change, this method returns the new value or times out.\n\nIf a variable is deleted while being watched, the `variableState` state is\nset to `DELETED` and the method returns the last known variable `value`.\n\nIf you set the deadline for watching to a larger value than internal\ntimeout (60 seconds), the current variable value is returned and the\n`variableState` will be `VARIABLE_STATE_UNSPECIFIED`.\n\nTo learn more about creating a watcher, read the\n[Watching a Variable for\nChanges](/deployment-manager/runtime-configurator/watching-a-variable)\ndocumentation.", + "description": "Watches a specific variable and waits for a change in the variable's value. When there is a change, this method returns the new value or times out. If a variable is deleted while being watched, the `variableState` state is set to `DELETED` and the method returns the last known variable `value`. If you set the deadline for watching to a larger value than internal timeout (60 seconds), the current variable value is returned and the `variableState` will be `VARIABLE_STATE_UNSPECIFIED`. To learn more about creating a watcher, read the [Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable) documentation.", "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:watch", "httpMethod": "POST", "id": "runtimeconfig.projects.configs.variables.watch", @@ -623,7 +623,7 @@ ], "parameters": { "name": { - "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", + "description": "The name of the variable to watch, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+/variables/.*$", "required": true, @@ -647,7 +647,7 @@ "waiters": { "methods": { "create": { - "description": "Creates a Waiter resource. This operation returns a long-running Operation\nresource which can be polled for completion. However, a waiter with the\ngiven name will exist (and can be retrieved) prior to the operation\ncompleting. If the operation fails, the failed Waiter resource will\nstill exist and must be deleted prior to subsequent creation attempts.", + "description": "Creates a Waiter resource. This operation returns a long-running Operation resource which can be polled for completion. However, a waiter with the given name will exist (and can be retrieved) prior to the operation completing. If the operation fails, the failed Waiter resource will still exist and must be deleted prior to subsequent creation attempts.", "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters", "httpMethod": "POST", "id": "runtimeconfig.projects.configs.waiters.create", @@ -656,14 +656,14 @@ ], "parameters": { "parent": { - "description": "The path to the configuration that will own the waiter.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.", + "description": "The path to the configuration that will own the waiter. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+$", "required": true, "type": "string" }, "requestId": { - "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.", + "description": "An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters.", "location": "query", "type": "string" } @@ -690,7 +690,7 @@ ], "parameters": { "name": { - "description": "The Waiter resource to delete, in the format:\n\n `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`", + "description": "The Waiter resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$", "required": true, @@ -716,7 +716,7 @@ ], "parameters": { "name": { - "description": "The fully-qualified name of the Waiter resource object to retrieve, in the\nformat:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`", + "description": "The fully-qualified name of the Waiter resource object to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$", "required": true, @@ -742,18 +742,18 @@ ], "parameters": { "pageSize": { - "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.", + "description": "Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.", + "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "parent": { - "description": "The path to the configuration for which you want to get a list of waiters.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", + "description": "The path to the configuration for which you want to get a list of waiters. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+$", "required": true, @@ -770,7 +770,7 @@ ] }, "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "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": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}:testIamPermissions", "httpMethod": "POST", "id": "runtimeconfig.projects.configs.waiters.testIamPermissions", @@ -779,7 +779,7 @@ ], "parameters": { "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", "location": "path", "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$", "required": true, @@ -805,7 +805,7 @@ } } }, - "revision": "20200504", + "revision": "20200803", "rootUrl": "https://runtimeconfig.googleapis.com/", "schemas": { "Binding": { @@ -814,28 +814,28 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." + "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { - "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", + "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, "type": "array" }, "role": { - "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", "type": "string" } }, "type": "object" }, "Cardinality": { - "description": "A Cardinality condition for the Waiter resource. A cardinality condition is\nmet when the number of variables under a specified path prefix reaches a\npredefined number. For example, if you set a Cardinality condition where\nthe `path` is set to `/foo` and the number of paths is set to `2`, the\nfollowing variables would meet the condition in a RuntimeConfig resource:\n\n+ `/foo/variable1 = \"value1\"`\n+ `/foo/variable2 = \"value2\"`\n+ `/bar/variable3 = \"value3\"`\n\nIt would not satisfy the same condition with the `number` set to\n`3`, however, because there is only 2 paths that start with `/foo`.\nCardinality conditions are recursive; all subtrees under the specific\npath prefix are counted.", + "description": "A Cardinality condition for the Waiter resource. A cardinality condition is met when the number of variables under a specified path prefix reaches a predefined number. For example, if you set a Cardinality condition where the `path` is set to `/foo` and the number of paths is set to `2`, the following variables would meet the condition in a RuntimeConfig resource: + `/foo/variable1 = \"value1\"` + `/foo/variable2 = \"value2\"` + `/bar/variable3 = \"value3\"` It would not satisfy the same condition with the `number` set to `3`, however, because there is only 2 paths that start with `/foo`. Cardinality conditions are recursive; all subtrees under the specific path prefix are counted.", "id": "Cardinality", "properties": { "number": { - "description": "The number variables under the `path` that must exist to meet this\ncondition. Defaults to 1 if not specified.", + "description": "The number variables under the `path` that must exist to meet this condition. Defaults to 1 if not specified.", "format": "int32", "type": "integer" }, @@ -847,7 +847,7 @@ "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" @@ -864,41 +864,41 @@ "type": "object" }, "Expr": { - "description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.", + "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "id": "Expr", "properties": { "description": { - "description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.", + "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "expression": { - "description": "Textual representation of an expression in Common Expression Language\nsyntax.", + "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "location": { - "description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.", + "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" }, "title": { - "description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.", + "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" } }, "type": "object" }, "ListConfigsResponse": { - "description": "`ListConfigs()` returns the following response. The order of returned\nobjects is arbitrary; that is, it is not ordered in any particular way.", + "description": "`ListConfigs()` returns the following response. The order of returned objects is arbitrary; that is, it is not ordered in any particular way.", "id": "ListConfigsResponse", "properties": { "configs": { - "description": "A list of the configurations in the project. The order of returned\nobjects is arbitrary; that is, it is not ordered in any particular way.", + "description": "A list of the configurations in the project. The order of returned objects is arbitrary; that is, it is not ordered in any particular way.", "items": { "$ref": "RuntimeConfig" }, "type": "array" }, "nextPageToken": { - "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results", + "description": "This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results", "type": "string" } }, @@ -909,11 +909,11 @@ "id": "ListVariablesResponse", "properties": { "nextPageToken": { - "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results", + "description": "This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results", "type": "string" }, "variables": { - "description": "A list of variables and their values. The order of returned variable\nobjects is arbitrary.", + "description": "A list of variables and their values. The order of returned variable objects is arbitrary.", "items": { "$ref": "Variable" }, @@ -923,11 +923,11 @@ "type": "object" }, "ListWaitersResponse": { - "description": "Response for the `ListWaiters()` method.\nOrder of returned waiter objects is arbitrary.", + "description": "Response for the `ListWaiters()` method. Order of returned waiter objects is arbitrary.", "id": "ListWaitersResponse", "properties": { "nextPageToken": { - "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results", + "description": "This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results", "type": "string" }, "waiters": { @@ -941,11 +941,11 @@ "type": "object" }, "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "properties": { "done": { - "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { @@ -957,11 +957,11 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" }, "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "response": { @@ -969,30 +969,30 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" } }, "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "bindings": { - "description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.", + "description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.", "items": { "$ref": "Binding" }, "type": "array" }, "etag": { - "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.", + "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "format": "byte", "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -1000,7 +1000,7 @@ "type": "object" }, "RuntimeConfig": { - "description": "A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig\nservice. A RuntimeConfig resource consists of metadata and a hierarchy of\nvariables.", + "description": "A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig service. A RuntimeConfig resource consists of metadata and a hierarchy of variables.", "id": "RuntimeConfig", "properties": { "description": { @@ -1008,7 +1008,7 @@ "type": "string" }, "name": { - "description": "The resource name of a runtime config. The name must have the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an\narbitrary name that matches the\n`[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression.\nThe length of `[CONFIG_NAME]` must be less than 64 characters.\n\nYou pick the RuntimeConfig resource name, but the server will validate that\nthe name adheres to this format. After you create the resource, you cannot\nchange the resource's name.", + "description": "The resource name of a runtime config. The name must have the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME] The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an arbitrary name that matches the `[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression. The length of `[CONFIG_NAME]` must be less than 64 characters. You pick the RuntimeConfig resource name, but the server will validate that the name adheres to this format. After you create the resource, you cannot change the resource's name.", "type": "string" } }, @@ -1020,13 +1020,13 @@ "properties": { "policy": { "$ref": "Policy", - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them." } }, "type": "object" }, "Status": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { @@ -1035,7 +1035,7 @@ "type": "integer" }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -1046,7 +1046,7 @@ "type": "array" }, "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, @@ -1057,7 +1057,7 @@ "id": "TestIamPermissionsRequest", "properties": { "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "items": { "type": "string" }, @@ -1071,7 +1071,7 @@ "id": "TestIamPermissionsResponse", "properties": { "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "items": { "type": "string" }, @@ -1081,15 +1081,15 @@ "type": "object" }, "Variable": { - "description": "Describes a single variable within a RuntimeConfig resource.\nThe name denotes the hierarchical variable name. For example,\n`ports/serving_port` is a valid variable name. The variable value is an\nopaque string and only leaf variables can have values (that is, variables\nthat do not have any child variables).", + "description": "Describes a single variable within a RuntimeConfig resource. The name denotes the hierarchical variable name. For example, `ports/serving_port` is a valid variable name. The variable value is an opaque string and only leaf variables can have values (that is, variables that do not have any child variables).", "id": "Variable", "properties": { "name": { - "description": "The name of the variable resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a\nvalid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system\nfile path naming.\n\nThe `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and\ndashes. Slashes are used as path element separators and are not part of the\n`[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one\nnon-slash character. Multiple slashes are coalesced into single slash\ncharacter. Each path segment should match\n[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.\nThe length of a `[VARIABLE_NAME]` must be less than 256 characters.\n\nOnce you create a variable, you cannot change the variable name.", + "description": "The name of the variable resource, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME] The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system file path naming. The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and dashes. Slashes are used as path element separators and are not part of the `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one non-slash character. Multiple slashes are coalesced into single slash character. Each path segment should match [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression. The length of a `[VARIABLE_NAME]` must be less than 256 characters. Once you create a variable, you cannot change the variable name.", "type": "string" }, "state": { - "description": "Output only. The current state of the variable. The variable state\nindicates the outcome of the `variables().watch` call and is visible\nthrough the `get` and `list` calls.", + "description": "Output only. The current state of the variable. The variable state indicates the outcome of the `variables().watch` call and is visible through the `get` and `list` calls.", "enum": [ "VARIABLE_STATE_UNSPECIFIED", "UPDATED", @@ -1103,16 +1103,16 @@ "type": "string" }, "text": { - "description": "The string value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. For example,\n`text: \"my text value\"`. The string must be valid UTF-8.", + "description": "The string value of the variable. The length of the value must be less than 4096 bytes. Empty values are also accepted. For example, `text: \"my text value\"`. The string must be valid UTF-8.", "type": "string" }, "updateTime": { - "description": "Output only. The time of the last variable update.\nTimestamp will be UTC timestamp.", + "description": "Output only. The time of the last variable update. Timestamp will be UTC timestamp.", "format": "google-datetime", "type": "string" }, "value": { - "description": "The binary value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. The value must be\nbase64 encoded, and must comply with IETF RFC4648\n(https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`\ncan be set.", + "description": "The binary value of the variable. The length of the value must be less than 4096 bytes. Empty values are also accepted. The value must be base64 encoded, and must comply with IETF RFC4648 (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text` can be set.", "format": "byte", "type": "string" } @@ -1120,36 +1120,36 @@ "type": "object" }, "Waiter": { - "description": "A Waiter resource waits for some end condition within a RuntimeConfig\nresource to be met before it returns. For example, assume you have a\ndistributed system where each node writes to a Variable resource indicating\nthe node's readiness as part of the startup process.\n\nYou then configure a Waiter resource with the success condition set to wait\nuntil some number of nodes have checked in. Afterwards, your application\nruns some arbitrary code after the condition has been met and the waiter\nreturns successfully.\n\nOnce created, a Waiter resource is immutable.\n\nTo learn more about using waiters, read the\n[Creating a\nWaiter](/deployment-manager/runtime-configurator/creating-a-waiter)\ndocumentation.", + "description": "A Waiter resource waits for some end condition within a RuntimeConfig resource to be met before it returns. For example, assume you have a distributed system where each node writes to a Variable resource indicating the node's readiness as part of the startup process. You then configure a Waiter resource with the success condition set to wait until some number of nodes have checked in. Afterwards, your application runs some arbitrary code after the condition has been met and the waiter returns successfully. Once created, a Waiter resource is immutable. To learn more about using waiters, read the [Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter) documentation.", "id": "Waiter", "properties": { "createTime": { - "description": "Output only. The instant at which this Waiter resource was created. Adding\nthe value of `timeout` to this instant yields the timeout deadline for the\nwaiter.", + "description": "Output only. The instant at which this Waiter resource was created. Adding the value of `timeout` to this instant yields the timeout deadline for the waiter.", "format": "google-datetime", "type": "string" }, "done": { - "description": "Output only. If the value is `false`, it means the waiter is still waiting\nfor one of its conditions to be met.\n\nIf true, the waiter has finished. If the waiter finished due to a timeout\nor failure, `error` will be set.", + "description": "Output only. If the value is `false`, it means the waiter is still waiting for one of its conditions to be met. If true, the waiter has finished. If the waiter finished due to a timeout or failure, `error` will be set.", "type": "boolean" }, "error": { "$ref": "Status", - "description": "Output only. If the waiter ended due to a failure or timeout, this value\nwill be set." + "description": "Output only. If the waiter ended due to a failure or timeout, this value will be set." }, "failure": { "$ref": "EndCondition", - "description": "[Optional] The failure condition of this waiter. If this condition is met,\n`done` will be set to `true` and the `error` code will be set to `ABORTED`.\nThe failure condition takes precedence over the success condition. If both\nconditions are met, a failure will be indicated. This value is optional; if\nno failure condition is set, the only failure scenario will be a timeout." + "description": "[Optional] The failure condition of this waiter. If this condition is met, `done` will be set to `true` and the `error` code will be set to `ABORTED`. The failure condition takes precedence over the success condition. If both conditions are met, a failure will be indicated. This value is optional; if no failure condition is set, the only failure scenario will be a timeout." }, "name": { - "description": "The name of the Waiter resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]\n\nThe `[PROJECT_ID]` must be a valid Google Cloud project ID,\nthe `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the\n`[WAITER_NAME]` must match RFC 1035 segment specification, and the length\nof `[WAITER_NAME]` must be less than 64 bytes.\n\nAfter you create a Waiter resource, you cannot change the resource name.", + "description": "The name of the Waiter resource, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME] The `[PROJECT_ID]` must be a valid Google Cloud project ID, the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the `[WAITER_NAME]` must match RFC 1035 segment specification, and the length of `[WAITER_NAME]` must be less than 64 bytes. After you create a Waiter resource, you cannot change the resource name.", "type": "string" }, "success": { "$ref": "EndCondition", - "description": "[Required] The success condition. If this condition is met, `done` will be\nset to `true` and the `error` value will remain unset. The failure\ncondition takes precedence over the success condition. If both conditions\nare met, a failure will be indicated." + "description": "[Required] The success condition. If this condition is met, `done` will be set to `true` and the `error` value will remain unset. The failure condition takes precedence over the success condition. If both conditions are met, a failure will be indicated." }, "timeout": { - "description": "[Required] Specifies the timeout of the waiter in seconds, beginning from\nthe instant that `waiters().create` method is called. If this time elapses\nbefore the success or failure conditions are met, the waiter fails and sets\nthe `error` code to `DEADLINE_EXCEEDED`.", + "description": "[Required] Specifies the timeout of the waiter in seconds, beginning from the instant that `waiters().create` method is called. If this time elapses before the success or failure conditions are met, the waiter fails and sets the `error` code to `DEADLINE_EXCEEDED`.", "format": "google-duration", "type": "string" } @@ -1161,7 +1161,7 @@ "id": "WatchVariableRequest", "properties": { "newerThan": { - "description": "If specified, checks the current timestamp of the variable and if the\ncurrent timestamp is newer than `newerThan` timestamp, the method returns\nimmediately.\n\nIf not specified or the variable has an older timestamp, the watcher waits\nfor a the value to change before returning.", + "description": "If specified, checks the current timestamp of the variable and if the current timestamp is newer than `newerThan` timestamp, the method returns immediately. If not specified or the variable has an older timestamp, the watcher waits for a the value to change before returning.", "format": "google-datetime", "type": "string" } diff --git a/discovery/serviceconsumermanagement-v1.json b/discovery/serviceconsumermanagement-v1.json index a1bf93db5a..9e9d680655 100644 --- a/discovery/serviceconsumermanagement-v1.json +++ b/discovery/serviceconsumermanagement-v1.json @@ -542,7 +542,7 @@ } } }, - "revision": "20200801", + "revision": "20200804", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -1523,7 +1523,7 @@ "type": "object" }, "MetricDescriptor": { - "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. The following are specific rules for service defined Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `description` fields are all required. The `unit` field must be specified if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default 500 metric descriptors per service is allowed. * Maximum of default 10 labels per metric descriptor is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas", + "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. ", "id": "MetricDescriptor", "properties": { "description": { @@ -1535,7 +1535,7 @@ "type": "string" }, "labels": { - "description": "The set of labels that can be used to describe a specific instance of this metric type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.", + "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.", "items": { "$ref": "LabelDescriptor" }, @@ -1597,7 +1597,7 @@ "type": "string" }, "type": { - "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of `{service name}/{relative metric name}`, such as `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric name must follow: * Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. * The maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name `custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/user/`. Metric types should use a natural hierarchical grouping. For example: \"custom.googleapis.com/invoice/paid/amount\" \"external.googleapis.com/prometheus/up\" \"appengine.googleapis.com/http/server/response_latencies\"", + "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: \"custom.googleapis.com/invoice/paid/amount\" \"external.googleapis.com/prometheus/up\" \"appengine.googleapis.com/http/server/response_latencies\"", "type": "string" }, "unit": { @@ -1705,7 +1705,7 @@ "type": "object" }, "MonitoredResourceDescriptor": { - "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and `\"zone\"` to identify particular VM instances. Different services can support different monitored resource types. The following are specific rules to service defined monitored resources for Monitoring and Logging: * The `type`, `display_name`, `description`, `labels` and `launch_stage` fields are all required. * The first label of the monitored resource descriptor must be `resource_container`. There are legacy monitored resource descritptors start with `project_id`. * It must include a `location` label. * Maximum of default 5 service defined monitored resource descriptors is allowed per service. * Maximum of default 10 labels per monitored resource is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas ", + "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and `\"zone\"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. ", "id": "MonitoredResourceDescriptor", "properties": { "description": { @@ -1717,7 +1717,7 @@ "type": "string" }, "labels": { - "description": "Required. A set of labels used to describe instances of this monitored resource type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, an individual Google Cloud SQL database is identified by values for the labels `database_id` and `location`.", + "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `\"database_id\"` and `\"zone\"`.", "items": { "$ref": "LabelDescriptor" }, @@ -1752,7 +1752,7 @@ "type": "string" }, "type": { - "description": "Required. The monitored resource type. For example, the type `cloudsql_database` represents databases in Google Cloud SQL. All service defined monitored resource types must be prefixed with the service name, in the format of `{service name}/{relative resource name}`. The relative resource name must follow: * Only upper and lower-case letters and digits are allowed. * It must start with upper case character and is recommended to use Upper Camel Case style. * The maximum number of characters allowed for the relative_resource_name is 100. Note there are legacy service monitored resources not following this rule.", + "description": "Required. The monitored resource type. For example, the type `\"cloudsql_database\"` represents databases in Google Cloud SQL.", "type": "string" } }, diff --git a/discovery/serviceconsumermanagement-v1beta1.json b/discovery/serviceconsumermanagement-v1beta1.json index 99197e73ea..ce32cef2ae 100644 --- a/discovery/serviceconsumermanagement-v1beta1.json +++ b/discovery/serviceconsumermanagement-v1beta1.json @@ -452,7 +452,7 @@ } } }, - "revision": "20200801", + "revision": "20200804", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -1309,7 +1309,7 @@ "type": "object" }, "MetricDescriptor": { - "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. The following are specific rules for service defined Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `description` fields are all required. The `unit` field must be specified if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default 500 metric descriptors per service is allowed. * Maximum of default 10 labels per metric descriptor is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas", + "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. ", "id": "MetricDescriptor", "properties": { "description": { @@ -1321,7 +1321,7 @@ "type": "string" }, "labels": { - "description": "The set of labels that can be used to describe a specific instance of this metric type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.", + "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.", "items": { "$ref": "LabelDescriptor" }, @@ -1383,7 +1383,7 @@ "type": "string" }, "type": { - "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of `{service name}/{relative metric name}`, such as `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric name must follow: * Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. * The maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name `custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/user/`. Metric types should use a natural hierarchical grouping. For example: \"custom.googleapis.com/invoice/paid/amount\" \"external.googleapis.com/prometheus/up\" \"appengine.googleapis.com/http/server/response_latencies\"", + "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: \"custom.googleapis.com/invoice/paid/amount\" \"external.googleapis.com/prometheus/up\" \"appengine.googleapis.com/http/server/response_latencies\"", "type": "string" }, "unit": { @@ -1491,7 +1491,7 @@ "type": "object" }, "MonitoredResourceDescriptor": { - "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and `\"zone\"` to identify particular VM instances. Different services can support different monitored resource types. The following are specific rules to service defined monitored resources for Monitoring and Logging: * The `type`, `display_name`, `description`, `labels` and `launch_stage` fields are all required. * The first label of the monitored resource descriptor must be `resource_container`. There are legacy monitored resource descritptors start with `project_id`. * It must include a `location` label. * Maximum of default 5 service defined monitored resource descriptors is allowed per service. * Maximum of default 10 labels per monitored resource is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas ", + "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and `\"zone\"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. ", "id": "MonitoredResourceDescriptor", "properties": { "description": { @@ -1503,7 +1503,7 @@ "type": "string" }, "labels": { - "description": "Required. A set of labels used to describe instances of this monitored resource type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, an individual Google Cloud SQL database is identified by values for the labels `database_id` and `location`.", + "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `\"database_id\"` and `\"zone\"`.", "items": { "$ref": "LabelDescriptor" }, @@ -1538,7 +1538,7 @@ "type": "string" }, "type": { - "description": "Required. The monitored resource type. For example, the type `cloudsql_database` represents databases in Google Cloud SQL. All service defined monitored resource types must be prefixed with the service name, in the format of `{service name}/{relative resource name}`. The relative resource name must follow: * Only upper and lower-case letters and digits are allowed. * It must start with upper case character and is recommended to use Upper Camel Case style. * The maximum number of characters allowed for the relative_resource_name is 100. Note there are legacy service monitored resources not following this rule.", + "description": "Required. The monitored resource type. For example, the type `\"cloudsql_database\"` represents databases in Google Cloud SQL.", "type": "string" } }, diff --git a/discovery/servicenetworking-v1.json b/discovery/servicenetworking-v1.json index 8cd6fbec4c..6bef160c3b 100644 --- a/discovery/servicenetworking-v1.json +++ b/discovery/servicenetworking-v1.json @@ -677,7 +677,7 @@ } } }, - "revision": "20200801", + "revision": "20200804", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1849,7 +1849,7 @@ "type": "object" }, "MetricDescriptor": { - "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. The following are specific rules for service defined Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `description` fields are all required. The `unit` field must be specified if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default 500 metric descriptors per service is allowed. * Maximum of default 10 labels per metric descriptor is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas", + "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. ", "id": "MetricDescriptor", "properties": { "description": { @@ -1861,7 +1861,7 @@ "type": "string" }, "labels": { - "description": "The set of labels that can be used to describe a specific instance of this metric type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.", + "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.", "items": { "$ref": "LabelDescriptor" }, @@ -1923,7 +1923,7 @@ "type": "string" }, "type": { - "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of `{service name}/{relative metric name}`, such as `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric name must follow: * Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. * The maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name `custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/user/`. Metric types should use a natural hierarchical grouping. For example: \"custom.googleapis.com/invoice/paid/amount\" \"external.googleapis.com/prometheus/up\" \"appengine.googleapis.com/http/server/response_latencies\"", + "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: \"custom.googleapis.com/invoice/paid/amount\" \"external.googleapis.com/prometheus/up\" \"appengine.googleapis.com/http/server/response_latencies\"", "type": "string" }, "unit": { @@ -2031,7 +2031,7 @@ "type": "object" }, "MonitoredResourceDescriptor": { - "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and `\"zone\"` to identify particular VM instances. Different services can support different monitored resource types. The following are specific rules to service defined monitored resources for Monitoring and Logging: * The `type`, `display_name`, `description`, `labels` and `launch_stage` fields are all required. * The first label of the monitored resource descriptor must be `resource_container`. There are legacy monitored resource descritptors start with `project_id`. * It must include a `location` label. * Maximum of default 5 service defined monitored resource descriptors is allowed per service. * Maximum of default 10 labels per monitored resource is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas ", + "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and `\"zone\"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. ", "id": "MonitoredResourceDescriptor", "properties": { "description": { @@ -2043,7 +2043,7 @@ "type": "string" }, "labels": { - "description": "Required. A set of labels used to describe instances of this monitored resource type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, an individual Google Cloud SQL database is identified by values for the labels `database_id` and `location`.", + "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `\"database_id\"` and `\"zone\"`.", "items": { "$ref": "LabelDescriptor" }, @@ -2078,7 +2078,7 @@ "type": "string" }, "type": { - "description": "Required. The monitored resource type. For example, the type `cloudsql_database` represents databases in Google Cloud SQL. All service defined monitored resource types must be prefixed with the service name, in the format of `{service name}/{relative resource name}`. The relative resource name must follow: * Only upper and lower-case letters and digits are allowed. * It must start with upper case character and is recommended to use Upper Camel Case style. * The maximum number of characters allowed for the relative_resource_name is 100. Note there are legacy service monitored resources not following this rule.", + "description": "Required. The monitored resource type. For example, the type `\"cloudsql_database\"` represents databases in Google Cloud SQL.", "type": "string" } }, diff --git a/discovery/servicenetworking-v1beta.json b/discovery/servicenetworking-v1beta.json index 470474467b..843d10e2c0 100644 --- a/discovery/servicenetworking-v1beta.json +++ b/discovery/servicenetworking-v1beta.json @@ -307,7 +307,7 @@ } } }, - "revision": "20200801", + "revision": "20200804", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1353,7 +1353,7 @@ "type": "object" }, "MetricDescriptor": { - "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. The following are specific rules for service defined Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `description` fields are all required. The `unit` field must be specified if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default 500 metric descriptors per service is allowed. * Maximum of default 10 labels per metric descriptor is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas", + "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. ", "id": "MetricDescriptor", "properties": { "description": { @@ -1365,7 +1365,7 @@ "type": "string" }, "labels": { - "description": "The set of labels that can be used to describe a specific instance of this metric type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.", + "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.", "items": { "$ref": "LabelDescriptor" }, @@ -1427,7 +1427,7 @@ "type": "string" }, "type": { - "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of `{service name}/{relative metric name}`, such as `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric name must follow: * Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. * The maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name `custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/user/`. Metric types should use a natural hierarchical grouping. For example: \"custom.googleapis.com/invoice/paid/amount\" \"external.googleapis.com/prometheus/up\" \"appengine.googleapis.com/http/server/response_latencies\"", + "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: \"custom.googleapis.com/invoice/paid/amount\" \"external.googleapis.com/prometheus/up\" \"appengine.googleapis.com/http/server/response_latencies\"", "type": "string" }, "unit": { @@ -1535,7 +1535,7 @@ "type": "object" }, "MonitoredResourceDescriptor": { - "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and `\"zone\"` to identify particular VM instances. Different services can support different monitored resource types. The following are specific rules to service defined monitored resources for Monitoring and Logging: * The `type`, `display_name`, `description`, `labels` and `launch_stage` fields are all required. * The first label of the monitored resource descriptor must be `resource_container`. There are legacy monitored resource descritptors start with `project_id`. * It must include a `location` label. * Maximum of default 5 service defined monitored resource descriptors is allowed per service. * Maximum of default 10 labels per monitored resource is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas ", + "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and `\"zone\"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. ", "id": "MonitoredResourceDescriptor", "properties": { "description": { @@ -1547,7 +1547,7 @@ "type": "string" }, "labels": { - "description": "Required. A set of labels used to describe instances of this monitored resource type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, an individual Google Cloud SQL database is identified by values for the labels `database_id` and `location`.", + "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `\"database_id\"` and `\"zone\"`.", "items": { "$ref": "LabelDescriptor" }, @@ -1582,7 +1582,7 @@ "type": "string" }, "type": { - "description": "Required. The monitored resource type. For example, the type `cloudsql_database` represents databases in Google Cloud SQL. All service defined monitored resource types must be prefixed with the service name, in the format of `{service name}/{relative resource name}`. The relative resource name must follow: * Only upper and lower-case letters and digits are allowed. * It must start with upper case character and is recommended to use Upper Camel Case style. * The maximum number of characters allowed for the relative_resource_name is 100. Note there are legacy service monitored resources not following this rule.", + "description": "Required. The monitored resource type. For example, the type `\"cloudsql_database\"` represents databases in Google Cloud SQL.", "type": "string" } }, diff --git a/discovery/serviceusage-v1.json b/discovery/serviceusage-v1.json index b038c1b03f..28c37cc275 100644 --- a/discovery/serviceusage-v1.json +++ b/discovery/serviceusage-v1.json @@ -426,7 +426,7 @@ } } }, - "revision": "20200801", + "revision": "20200804", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AdminQuotaPolicy": { @@ -1859,7 +1859,7 @@ "type": "object" }, "MetricDescriptor": { - "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. The following are specific rules for service defined Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `description` fields are all required. The `unit` field must be specified if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default 500 metric descriptors per service is allowed. * Maximum of default 10 labels per metric descriptor is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas", + "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. ", "id": "MetricDescriptor", "properties": { "description": { @@ -1871,7 +1871,7 @@ "type": "string" }, "labels": { - "description": "The set of labels that can be used to describe a specific instance of this metric type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.", + "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.", "items": { "$ref": "LabelDescriptor" }, @@ -1933,7 +1933,7 @@ "type": "string" }, "type": { - "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of `{service name}/{relative metric name}`, such as `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric name must follow: * Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. * The maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name `custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/user/`. Metric types should use a natural hierarchical grouping. For example: \"custom.googleapis.com/invoice/paid/amount\" \"external.googleapis.com/prometheus/up\" \"appengine.googleapis.com/http/server/response_latencies\"", + "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: \"custom.googleapis.com/invoice/paid/amount\" \"external.googleapis.com/prometheus/up\" \"appengine.googleapis.com/http/server/response_latencies\"", "type": "string" }, "unit": { @@ -2041,7 +2041,7 @@ "type": "object" }, "MonitoredResourceDescriptor": { - "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and `\"zone\"` to identify particular VM instances. Different services can support different monitored resource types. The following are specific rules to service defined monitored resources for Monitoring and Logging: * The `type`, `display_name`, `description`, `labels` and `launch_stage` fields are all required. * The first label of the monitored resource descriptor must be `resource_container`. There are legacy monitored resource descritptors start with `project_id`. * It must include a `location` label. * Maximum of default 5 service defined monitored resource descriptors is allowed per service. * Maximum of default 10 labels per monitored resource is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas ", + "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and `\"zone\"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. ", "id": "MonitoredResourceDescriptor", "properties": { "description": { @@ -2053,7 +2053,7 @@ "type": "string" }, "labels": { - "description": "Required. A set of labels used to describe instances of this monitored resource type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, an individual Google Cloud SQL database is identified by values for the labels `database_id` and `location`.", + "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `\"database_id\"` and `\"zone\"`.", "items": { "$ref": "LabelDescriptor" }, @@ -2088,7 +2088,7 @@ "type": "string" }, "type": { - "description": "Required. The monitored resource type. For example, the type `cloudsql_database` represents databases in Google Cloud SQL. All service defined monitored resource types must be prefixed with the service name, in the format of `{service name}/{relative resource name}`. The relative resource name must follow: * Only upper and lower-case letters and digits are allowed. * It must start with upper case character and is recommended to use Upper Camel Case style. * The maximum number of characters allowed for the relative_resource_name is 100. Note there are legacy service monitored resources not following this rule.", + "description": "Required. The monitored resource type. For example, the type `\"cloudsql_database\"` represents databases in Google Cloud SQL.", "type": "string" } }, diff --git a/discovery/serviceusage-v1beta1.json b/discovery/serviceusage-v1beta1.json index d23de31019..2f3b333394 100644 --- a/discovery/serviceusage-v1beta1.json +++ b/discovery/serviceusage-v1beta1.json @@ -834,7 +834,7 @@ } } }, - "revision": "20200801", + "revision": "20200804", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AdminQuotaPolicy": { @@ -2361,7 +2361,7 @@ "type": "object" }, "MetricDescriptor": { - "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. The following are specific rules for service defined Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `description` fields are all required. The `unit` field must be specified if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default 500 metric descriptors per service is allowed. * Maximum of default 10 labels per metric descriptor is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas", + "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. ", "id": "MetricDescriptor", "properties": { "description": { @@ -2373,7 +2373,7 @@ "type": "string" }, "labels": { - "description": "The set of labels that can be used to describe a specific instance of this metric type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.", + "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.", "items": { "$ref": "LabelDescriptor" }, @@ -2435,7 +2435,7 @@ "type": "string" }, "type": { - "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of `{service name}/{relative metric name}`, such as `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric name must follow: * Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. * The maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name `custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/user/`. Metric types should use a natural hierarchical grouping. For example: \"custom.googleapis.com/invoice/paid/amount\" \"external.googleapis.com/prometheus/up\" \"appengine.googleapis.com/http/server/response_latencies\"", + "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: \"custom.googleapis.com/invoice/paid/amount\" \"external.googleapis.com/prometheus/up\" \"appengine.googleapis.com/http/server/response_latencies\"", "type": "string" }, "unit": { @@ -2543,7 +2543,7 @@ "type": "object" }, "MonitoredResourceDescriptor": { - "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and `\"zone\"` to identify particular VM instances. Different services can support different monitored resource types. The following are specific rules to service defined monitored resources for Monitoring and Logging: * The `type`, `display_name`, `description`, `labels` and `launch_stage` fields are all required. * The first label of the monitored resource descriptor must be `resource_container`. There are legacy monitored resource descritptors start with `project_id`. * It must include a `location` label. * Maximum of default 5 service defined monitored resource descriptors is allowed per service. * Maximum of default 10 labels per monitored resource is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas ", + "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and `\"zone\"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. ", "id": "MonitoredResourceDescriptor", "properties": { "description": { @@ -2555,7 +2555,7 @@ "type": "string" }, "labels": { - "description": "Required. A set of labels used to describe instances of this monitored resource type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, an individual Google Cloud SQL database is identified by values for the labels `database_id` and `location`.", + "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `\"database_id\"` and `\"zone\"`.", "items": { "$ref": "LabelDescriptor" }, @@ -2590,7 +2590,7 @@ "type": "string" }, "type": { - "description": "Required. The monitored resource type. For example, the type `cloudsql_database` represents databases in Google Cloud SQL. All service defined monitored resource types must be prefixed with the service name, in the format of `{service name}/{relative resource name}`. The relative resource name must follow: * Only upper and lower-case letters and digits are allowed. * It must start with upper case character and is recommended to use Upper Camel Case style. * The maximum number of characters allowed for the relative_resource_name is 100. Note there are legacy service monitored resources not following this rule.", + "description": "Required. The monitored resource type. For example, the type `\"cloudsql_database\"` represents databases in Google Cloud SQL.", "type": "string" } }, diff --git a/discovery/sourcerepo-v1.json b/discovery/sourcerepo-v1.json index cab4eb7244..9d49abd8ba 100644 --- a/discovery/sourcerepo-v1.json +++ b/discovery/sourcerepo-v1.json @@ -450,11 +450,11 @@ } } }, - "revision": "20200520", + "revision": "20200729", "rootUrl": "https://sourcerepo.googleapis.com/", "schemas": { "AuditConfig": { - "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.", + "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\",\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\"\n },\n {\n \"log_type\": \"ADMIN_READ\"\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\",\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\"\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.", "id": "AuditConfig", "properties": { "auditLogConfigs": { @@ -472,7 +472,7 @@ "type": "object" }, "AuditLogConfig": { - "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.", + "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\"\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.", "id": "AuditLogConfig", "properties": { "exemptedMembers": { diff --git a/discovery/storagetransfer-v1.json b/discovery/storagetransfer-v1.json index bc74382cad..420f0f33cf 100644 --- a/discovery/storagetransfer-v1.json +++ b/discovery/storagetransfer-v1.json @@ -396,7 +396,7 @@ } } }, - "revision": "20200724", + "revision": "20200730", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AwsAccessKey": { @@ -536,7 +536,7 @@ "Unknown error. For example, this error may be returned when\na `Status` value received from another address space belongs to\nan error space that is not known in this address space. Also\nerrors raised by APIs that do not return enough error information\nmay be converted to this error.\n\nHTTP Mapping: 500 Internal Server Error", "The client specified an invalid argument. Note that this differs\nfrom `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments\nthat are problematic regardless of the state of the system\n(e.g., a malformed file name).\n\nHTTP Mapping: 400 Bad Request", "The deadline expired before the operation could complete. For operations\nthat change the state of the system, this error may be returned\neven if the operation has completed successfully. For example, a\nsuccessful response from a server could have been delayed long\nenough for the deadline to expire.\n\nHTTP Mapping: 504 Gateway Timeout", - "Some requested entity (e.g., file or directory) was not found.\n\nNote to server developers: if a request is denied for an entire class\nof users, such as gradual feature rollout or undocumented whitelist,\n`NOT_FOUND` may be used. If a request is denied for some users within\na class of users, such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP Mapping: 404 Not Found", + "Some requested entity (e.g., file or directory) was not found.\n\nNote to server developers: if a request is denied for an entire class\nof users, such as gradual feature rollout or undocumented allowlist,\n`NOT_FOUND` may be used. If a request is denied for some users within\na class of users, such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP Mapping: 404 Not Found", "The entity that a client attempted to create (e.g., file or directory)\nalready exists.\n\nHTTP Mapping: 409 Conflict", "The caller does not have permission to execute the specified\noperation. `PERMISSION_DENIED` must not be used for rejections\ncaused by exhausting some resource (use `RESOURCE_EXHAUSTED`\ninstead for those errors). `PERMISSION_DENIED` must not be\nused if the caller can not be identified (use `UNAUTHENTICATED`\ninstead for those errors). This error code does not imply the\nrequest is valid or the requested entity exists or satisfies\nother pre-conditions.\n\nHTTP Mapping: 403 Forbidden", "The request does not have valid authentication credentials for the\noperation.\n\nHTTP Mapping: 401 Unauthorized", @@ -680,7 +680,7 @@ "type": "object" }, "ObjectConditions": { - "description": "Conditions that determine which objects will be transferred. Applies only\nto S3 and Cloud Storage objects.\n\nThe \"last modification time\" refers to the time of the\nlast change to the object's content or metadata — specifically, this is\nthe `updated` property of Cloud Storage objects and the `LastModified`\nfield of S3 objects.", + "description": "Conditions that determine which objects will be transferred. Applies only\nto Cloud Data Sources such as S3, Azure, and Cloud Storage.\n\nThe \"last modification time\" refers to the time of the\nlast change to the object's content or metadata — specifically, this is\nthe `updated` property of Cloud Storage objects, the `LastModified` field of\nS3 objects, and the `Last-Modified` header of Azure blobs.", "id": "ObjectConditions", "properties": { "excludePrefixes": { @@ -1060,7 +1060,7 @@ "type": "object" }, "TransferOptions": { - "description": "TransferOptions uses three boolean parameters to define the actions\nto be performed on objects in a transfer.", + "description": "TransferOptions define the actions to be performed on objects in a transfer.", "id": "TransferOptions", "properties": { "deleteObjectsFromSourceAfterTransfer": { diff --git a/discovery/testing-v1.json b/discovery/testing-v1.json index 7670d5250b..a292ece5d9 100644 --- a/discovery/testing-v1.json +++ b/discovery/testing-v1.json @@ -133,7 +133,7 @@ "testMatrices": { "methods": { "cancel": { - "description": "Cancels unfinished test executions in a test matrix.\nThis call returns immediately and cancellation proceeds asychronously.\nIf the matrix is already final, this operation will have no effect.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the Test Matrix does not exist", + "description": "Cancels unfinished test executions in a test matrix. This call returns immediately and cancellation proceeds asynchronously. If the matrix is already final, this operation will have no effect. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist", "flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel", "httpMethod": "POST", "id": "testing.projects.testMatrices.cancel", @@ -164,7 +164,7 @@ ] }, "create": { - "description": "Creates and runs a matrix of tests according to the given specifications.\nUnsupported environments will be returned in the state UNSUPPORTED.\nMatrices are limited to at most 200 supported executions.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project\n- INVALID_ARGUMENT - if the request is malformed or if the matrix expands\n to more than 200 supported executions", + "description": "Creates and runs a matrix of tests according to the given specifications. Unsupported environments will be returned in the state UNSUPPORTED. Matrices are limited to at most 200 supported executions. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed or if the matrix expands to more than 200 supported executions", "flatPath": "v1/projects/{projectId}/testMatrices", "httpMethod": "POST", "id": "testing.projects.testMatrices.create", @@ -179,7 +179,7 @@ "type": "string" }, "requestId": { - "description": "A string id used to detect duplicated requests.\nIds are automatically scoped to a project, so\nusers should ensure the ID is unique per-project.\nA UUID is recommended.\n\nOptional, but strongly recommended.", + "description": "A string id used to detect duplicated requests. Ids are automatically scoped to a project, so users should ensure the ID is unique per-project. A UUID is recommended. Optional, but strongly recommended.", "location": "query", "type": "string" } @@ -196,7 +196,7 @@ ] }, "get": { - "description": "Checks the status of a test matrix.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the Test Matrix does not exist", + "description": "Checks the status of a test matrix. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist", "flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}", "httpMethod": "GET", "id": "testing.projects.testMatrices.get", @@ -234,7 +234,7 @@ "testEnvironmentCatalog": { "methods": { "get": { - "description": "Gets the catalog of supported test environments.\n\nMay return any of the following canonical error codes:\n\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the environment type does not exist\n- INTERNAL - if an internal error occurred", + "description": "Gets the catalog of supported test environments. May return any of the following canonical error codes: - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the environment type does not exist - INTERNAL - if an internal error occurred", "flatPath": "v1/testEnvironmentCatalog/{environmentType}", "httpMethod": "GET", "id": "testing.testEnvironmentCatalog.get", @@ -252,6 +252,14 @@ "PROVIDED_SOFTWARE", "DEVICE_IP_BLOCKS" ], + "enumDescriptions": [ + "Do not use. For proto versioning only.", + "A device running a version of the Android OS.", + "A device running a version of iOS.", + "A network configuration to use when running a test.", + "The software environment provided by TestExecutionService.", + "The IP blocks used by devices in the test environment." + ], "location": "path", "required": true, "type": "string" @@ -274,7 +282,7 @@ } } }, - "revision": "20200722", + "revision": "20200805", "rootUrl": "https://testing.googleapis.com/", "schemas": { "Account": { @@ -293,19 +301,19 @@ "id": "AndroidDevice", "properties": { "androidModelId": { - "description": "Required. The id of the Android device to be used.\nUse the TestEnvironmentDiscoveryService to get supported options.", + "description": "Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options.", "type": "string" }, "androidVersionId": { - "description": "Required. The id of the Android OS version to be used.\nUse the TestEnvironmentDiscoveryService to get supported options.", + "description": "Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options.", "type": "string" }, "locale": { - "description": "Required. The locale the test device used for testing.\nUse the TestEnvironmentDiscoveryService to get supported options.", + "description": "Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options.", "type": "string" }, "orientation": { - "description": "Required. How the device is oriented during the test.\nUse the TestEnvironmentDiscoveryService to get supported options.", + "description": "Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options.", "type": "string" } }, @@ -351,7 +359,7 @@ "type": "object" }, "AndroidInstrumentationTest": { - "description": "A test of an Android application that can control an Android component\nindependently of its normal lifecycle.\nAndroid instrumentation tests run an application APK and test APK inside the\nsame process on a virtual or physical AndroidDevice. They also specify\na test runner class, such as com.google.GoogleTestRunner, which can vary\non the specific instrumentation framework chosen.\n\nSee for\nmore information on types of Android tests.", + "description": "A test of an Android application that can control an Android component independently of its normal lifecycle. Android instrumentation tests run an application APK and test APK inside the same process on a virtual or physical AndroidDevice. They also specify a test runner class, such as com.google.GoogleTestRunner, which can vary on the specific instrumentation framework chosen. See for more information on types of Android tests.", "id": "AndroidInstrumentationTest", "properties": { "appApk": { @@ -363,19 +371,19 @@ "description": "A multi-apk app bundle for the application under test." }, "appPackageId": { - "description": "The java package for the application under test.\nThe default value is determined by examining the application's manifest.", + "description": "The java package for the application under test. The default value is determined by examining the application's manifest.", "type": "string" }, "orchestratorOption": { - "description": "The option of whether running each test within its own invocation of\ninstrumentation with Android Test Orchestrator or not.\n** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or\nhigher! **\nOrchestrator offers the following benefits:\n - No shared state\n - Crashes are isolated\n - Logs are scoped per test\n\nSee\n\nfor more information about Android Test Orchestrator.\n\nIf not set, the test will be run without the orchestrator.", + "description": "The option of whether running each test within its own invocation of instrumentation with Android Test Orchestrator or not. ** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or higher! ** Orchestrator offers the following benefits: - No shared state - Crashes are isolated - Logs are scoped per test See for more information about Android Test Orchestrator. If not set, the test will be run without the orchestrator.", "enum": [ "ORCHESTRATOR_OPTION_UNSPECIFIED", "USE_ORCHESTRATOR", "DO_NOT_USE_ORCHESTRATOR" ], "enumDescriptions": [ - "Default value: the server will choose the mode. Currently implies that\nthe test will run without the orchestrator. In the future,\nall instrumentation tests will be run with the orchestrator.\nUsing the orchestrator is highly encouraged because of all the benefits it\noffers.", - "Run test using orchestrator.\n** Only compatible with AndroidJUnitRunner version 1.0 or higher! **\nRecommended.", + "Default value: the server will choose the mode. Currently implies that the test will run without the orchestrator. In the future, all instrumentation tests will be run with the orchestrator. Using the orchestrator is highly encouraged because of all the benefits it offers.", + "Run test using orchestrator. ** Only compatible with AndroidJUnitRunner version 1.0 or higher! ** Recommended.", "Run test without using orchestrator." ], "type": "string" @@ -389,15 +397,15 @@ "description": "Required. The APK containing the test code to be executed." }, "testPackageId": { - "description": "The java package for the test to be executed.\nThe default value is determined by examining the application's manifest.", + "description": "The java package for the test to be executed. The default value is determined by examining the application's manifest.", "type": "string" }, "testRunnerClass": { - "description": "The InstrumentationTestRunner class.\nThe default value is determined by examining the application's manifest.", + "description": "The InstrumentationTestRunner class. The default value is determined by examining the application's manifest.", "type": "string" }, "testTargets": { - "description": "Each target must be fully qualified with the package name or class name,\nin one of these formats:\n - \"package package_name\"\n - \"class package_name.class_name\"\n - \"class package_name.class_name#method_name\"\n\nIf empty, all targets in the module will be run.", + "description": "Each target must be fully qualified with the package name or class name, in one of these formats: - \"package package_name\" - \"class package_name.class_name\" - \"class package_name.class_name#method_name\" If empty, all targets in the module will be run.", "items": { "type": "string" }, @@ -407,32 +415,32 @@ "type": "object" }, "AndroidMatrix": { - "description": "A set of Android device configuration permutations is defined by the\nthe cross-product of the given axes. Internally, the given AndroidMatrix\nwill be expanded into a set of AndroidDevices.\n\nOnly supported permutations will be instantiated. Invalid permutations\n(e.g., incompatible models/versions) are ignored.", + "description": "A set of Android device configuration permutations is defined by the the cross-product of the given axes. Internally, the given AndroidMatrix will be expanded into a set of AndroidDevices. Only supported permutations will be instantiated. Invalid permutations (e.g., incompatible models/versions) are ignored.", "id": "AndroidMatrix", "properties": { "androidModelIds": { - "description": "Required. The ids of the set of Android device to be used.\nUse the TestEnvironmentDiscoveryService to get supported options.", + "description": "Required. The ids of the set of Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options.", "items": { "type": "string" }, "type": "array" }, "androidVersionIds": { - "description": "Required. The ids of the set of Android OS version to be used.\nUse the TestEnvironmentDiscoveryService to get supported options.", + "description": "Required. The ids of the set of Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options.", "items": { "type": "string" }, "type": "array" }, "locales": { - "description": "Required. The set of locales the test device will enable for testing.\nUse the TestEnvironmentDiscoveryService to get supported options.", + "description": "Required. The set of locales the test device will enable for testing. Use the TestEnvironmentDiscoveryService to get supported options.", "items": { "type": "string" }, "type": "array" }, "orientations": { - "description": "Required. The set of orientations to test with.\nUse the TestEnvironmentDiscoveryService to get supported options.", + "description": "Required. The set of orientations to test with. Use the TestEnvironmentDiscoveryService to get supported options.", "items": { "type": "string" }, @@ -446,11 +454,11 @@ "id": "AndroidModel", "properties": { "brand": { - "description": "The company that this device is branded with.\nExample: \"Google\", \"Samsung\".", + "description": "The company that this device is branded with. Example: \"Google\", \"Samsung\".", "type": "string" }, "codename": { - "description": "The name of the industrial design.\nThis corresponds to android.os.Build.DEVICE.", + "description": "The name of the industrial design. This corresponds to android.os.Build.DEVICE.", "type": "string" }, "form": { @@ -462,10 +470,10 @@ "EMULATOR" ], "enumDescriptions": [ - "Do not use. For proto versioning only.", - "Android virtual device using Compute Engine native virtualization. Firebase\nTest Lab only.", + "Do not use. For proto versioning only.", + "Android virtual device using Compute Engine native virtualization. Firebase Test Lab only.", "Actual hardware.", - "Android virtual device using emulator in nested virtualization. Equivalent\nto Android Studio." + "Android virtual device using emulator in nested virtualization. Equivalent to Android Studio." ], "type": "string" }, @@ -486,11 +494,11 @@ "type": "string" }, "id": { - "description": "The unique opaque id for this model.\nUse this for invoking the TestExecutionService.", + "description": "The unique opaque id for this model. Use this for invoking the TestExecutionService.", "type": "string" }, "lowFpsVideoRecording": { - "description": "True if and only if tests with this model are recorded by stitching\ntogether screenshots. See use_low_spec_video_recording in device config.", + "description": "True if and only if tests with this model are recorded by stitching together screenshots. See use_low_spec_video_recording in device config.", "type": "boolean" }, "manufacturer": { @@ -498,11 +506,11 @@ "type": "string" }, "name": { - "description": "The human-readable marketing name for this device model.\nExamples: \"Nexus 5\", \"Galaxy S5\".", + "description": "The human-readable marketing name for this device model. Examples: \"Nexus 5\", \"Galaxy S5\".", "type": "string" }, "screenDensity": { - "description": "Screen density in DPI.\nThis corresponds to ro.sf.lcd_density", + "description": "Screen density in DPI. This corresponds to ro.sf.lcd_density", "format": "int32", "type": "integer" }, @@ -517,7 +525,7 @@ "type": "integer" }, "supportedAbis": { - "description": "The list of supported ABIs for this device.\nThis corresponds to either android.os.Build.SUPPORTED_ABIS (for API level\n21 and above) or android.os.Build.CPU_ABI/CPU_ABI2.\nThe most preferred ABI is the first element in the list.\n\nElements are optionally prefixed by \"version_id:\" (where version_id is\nthe id of an AndroidVersion), denoting an ABI that is supported only on\na particular version.", + "description": "The list of supported ABIs for this device. This corresponds to either android.os.Build.SUPPORTED_ABIS (for API level 21 and above) or android.os.Build.CPU_ABI/CPU_ABI2. The most preferred ABI is the first element in the list. Elements are optionally prefixed by \"version_id:\" (where version_id is the id of an AndroidVersion), denoting an ABI that is supported only on a particular version.", "items": { "type": "string" }, @@ -531,21 +539,21 @@ "type": "array" }, "tags": { - "description": "Tags for this dimension.\nExamples: \"default\", \"preview\", \"deprecated\".", + "description": "Tags for this dimension. Examples: \"default\", \"preview\", \"deprecated\".", "items": { "type": "string" }, "type": "array" }, "thumbnailUrl": { - "description": "URL of a thumbnail image (photo) of the device.\ne.g. https://lh3.googleusercontent.com/90WcauuJiCYABEl8U0lcZeuS5STUbf2yW...", + "description": "URL of a thumbnail image (photo) of the device. e.g. https://lh3.googleusercontent.com/90WcauuJiCYABEl8U0lcZeuS5STUbf2yW...", "type": "string" } }, "type": "object" }, "AndroidRoboTest": { - "description": "A test of an android application that explores the application on a virtual\nor physical Android Device, finding culprits and crashes as it goes.", + "description": "A test of an android application that explores the application on a virtual or physical Android Device, finding culprits and crashes as it goes.", "id": "AndroidRoboTest", "properties": { "appApk": { @@ -561,21 +569,21 @@ "type": "string" }, "appPackageId": { - "description": "The java package for the application under test.\nThe default value is determined by examining the application's manifest.", + "description": "The java package for the application under test. The default value is determined by examining the application's manifest.", "type": "string" }, "maxDepth": { - "description": "The max depth of the traversal stack Robo can explore. Needs to be at least\n2 to make Robo explore the app beyond the first activity.\nDefault is 50.", + "description": "The max depth of the traversal stack Robo can explore. Needs to be at least 2 to make Robo explore the app beyond the first activity. Default is 50.", "format": "int32", "type": "integer" }, "maxSteps": { - "description": "The max number of steps Robo can execute.\nDefault is no limit.", + "description": "The max number of steps Robo can execute. Default is no limit.", "format": "int32", "type": "integer" }, "roboDirectives": { - "description": "A set of directives Robo should apply during the crawl.\nThis allows users to customize the crawl. For example, the username and\npassword for a test account can be provided.", + "description": "A set of directives Robo should apply during the crawl. This allows users to customize the crawl. For example, the username and password for a test account can be provided.", "items": { "$ref": "RoboDirective" }, @@ -583,10 +591,10 @@ }, "roboScript": { "$ref": "FileReference", - "description": "A JSON file with a sequence of actions Robo should perform as a prologue\nfor the crawl." + "description": "A JSON file with a sequence of actions Robo should perform as a prologue for the crawl." }, "startingIntents": { - "description": "The intents used to launch the app for the crawl.\nIf none are provided, then the main launcher activity is launched.\nIf some are provided, then only those provided are launched (the main\nlauncher activity must be provided explicitly).", + "description": "The intents used to launch the app for the crawl. If none are provided, then the main launcher activity is launched. If some are provided, then only those provided are launched (the main launcher activity must be provided explicitly).", "items": { "$ref": "RoboStartingIntent" }, @@ -617,7 +625,7 @@ "type": "object" }, "AndroidTestLoop": { - "description": "A test of an Android Application with a Test Loop.\nThe intent \\ will be implicitly added, since Games is the only\nuser of this api, for the time being.", + "description": "A test of an Android Application with a Test Loop. The intent \\ will be implicitly added, since Games is the only user of this api, for the time being.", "id": "AndroidTestLoop", "properties": { "appApk": { @@ -629,18 +637,18 @@ "description": "A multi-apk app bundle for the application under test." }, "appPackageId": { - "description": "The java package for the application under test.\nThe default is determined by examining the application's manifest.", + "description": "The java package for the application under test. The default is determined by examining the application's manifest.", "type": "string" }, "scenarioLabels": { - "description": "The list of scenario labels that should be run during the test.\nThe scenario labels should map to labels defined in the application's\nmanifest. For example, player_experience and\ncom.google.test.loops.player_experience add all of the loops labeled in the\nmanifest with the com.google.test.loops.player_experience name to the\nexecution.\nScenarios can also be specified in the scenarios field.", + "description": "The list of scenario labels that should be run during the test. The scenario labels should map to labels defined in the application's manifest. For example, player_experience and com.google.test.loops.player_experience add all of the loops labeled in the manifest with the com.google.test.loops.player_experience name to the execution. Scenarios can also be specified in the scenarios field.", "items": { "type": "string" }, "type": "array" }, "scenarios": { - "description": "The list of scenarios that should be run during the test.\nThe default is all test loops, derived from the application's\nmanifest.", + "description": "The list of scenarios that should be run during the test. The default is all test loops, derived from the application's manifest.", "items": { "format": "int32", "type": "integer" @@ -655,12 +663,12 @@ "id": "AndroidVersion", "properties": { "apiLevel": { - "description": "The API level for this Android version.\nExamples: 18, 19.", + "description": "The API level for this Android version. Examples: 18, 19.", "format": "int32", "type": "integer" }, "codeName": { - "description": "The code name for this Android version.\nExamples: \"JellyBean\", \"KitKat\".", + "description": "The code name for this Android version. Examples: \"JellyBean\", \"KitKat\".", "type": "string" }, "distribution": { @@ -668,7 +676,7 @@ "description": "Market share for this version." }, "id": { - "description": "An opaque id for this Android version.\nUse this id to invoke the TestExecutionService.", + "description": "An opaque id for this Android version. Use this id to invoke the TestExecutionService.", "type": "string" }, "releaseDate": { @@ -676,14 +684,14 @@ "description": "The date this Android version became available in the market." }, "tags": { - "description": "Tags for this dimension.\nExamples: \"default\", \"preview\", \"deprecated\".", + "description": "Tags for this dimension. Examples: \"default\", \"preview\", \"deprecated\".", "items": { "type": "string" }, "type": "array" }, "versionString": { - "description": "A string representing this version of the Android OS.\nExamples: \"4.3\", \"4.4\".", + "description": "A string representing this version of the Android OS. Examples: \"4.3\", \"4.4\".", "type": "string" } }, @@ -698,14 +706,14 @@ "description": "The path to an APK to be installed on the device before the test begins." }, "packageName": { - "description": "The java package for the APK to be installed.\nValue is determined by examining the application's manifest.", + "description": "The java package for the APK to be installed. Value is determined by examining the application's manifest.", "type": "string" } }, "type": "object" }, "ApkDetail": { - "description": "Android application details based on application manifest and apk archive\ncontents.", + "description": "Android application details based on application manifest and apk archive contents.", "id": "ApkDetail", "properties": { "apkManifest": { @@ -715,7 +723,7 @@ "type": "object" }, "ApkManifest": { - "description": "An Android app manifest. See\nhttp://developer.android.com/guide/topics/manifest/manifest-intro.html", + "description": "An Android app manifest. See http://developer.android.com/guide/topics/manifest/manifest-intro.html", "id": "ApkManifest", "properties": { "applicationLabel": { @@ -739,7 +747,7 @@ "type": "integer" }, "packageName": { - "description": "Full Java-style package name for this application, e.g.\n\"com.example.foo\".", + "description": "Full Java-style package name for this application, e.g. \"com.example.foo\".", "type": "string" }, "targetSdkVersion": { @@ -751,7 +759,7 @@ "type": "object" }, "AppBundle": { - "description": "An Android App Bundle file format, containing a BundleConfig.pb file,\na base module directory, zero or more dynamic feature module directories.\n

    See https://developer.android.com/guide/app-bundle/build for guidance on\nbuilding App Bundles.", + "description": "An Android App Bundle file format, containing a BundleConfig.pb file, a base module directory, zero or more dynamic feature module directories. See https://developer.android.com/guide/app-bundle/build for guidance on building App Bundles.", "id": "AppBundle", "properties": { "bundleLocation": { @@ -766,7 +774,7 @@ "id": "CancelTestMatrixResponse", "properties": { "testState": { - "description": "The current rolled-up state of the test matrix.\nIf this state is already final, then the cancelation request will\nhave no effect.", + "description": "The current rolled-up state of the test matrix. If this state is already final, then the cancelation request will have no effect.", "enum": [ "TEST_STATE_UNSPECIFIED", "VALIDATING", @@ -781,17 +789,17 @@ "INVALID" ], "enumDescriptions": [ - "Do not use. For proto versioning only.", + "Do not use. For proto versioning only.", "The execution or matrix is being validated.", "The execution or matrix is waiting for resources to become available.", - "The execution is currently being processed.\n\nCan only be set on an execution.", - "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.", - "The execution or matrix has stopped because it encountered an\ninfrastructure failure.", - "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.", - "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.", - "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.", - "The user cancelled the execution.\n\nCan only be set on an execution.", - "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware" + "The execution is currently being processed. Can only be set on an execution.", + "The execution or matrix has terminated normally. On a matrix this means that the matrix level processing completed normally, but individual executions may be in an ERROR state.", + "The execution or matrix has stopped because it encountered an infrastructure failure.", + "The execution was not run because it corresponds to a unsupported environment. Can only be set on an execution.", + "The execution was not run because the provided inputs are incompatible with the requested environment. Example: requested AndroidVersion is lower than APK's minSdkVersion Can only be set on an execution.", + "The execution was not run because the provided inputs are incompatible with the requested architecture. Example: requested device does not support running the native code in the supplied APK Can only be set on an execution.", + "The user cancelled the execution. Can only be set on an execution.", + "The execution or matrix was not run because the provided inputs are not valid. Examples: input file is not of the expected type, is malformed/corrupt, or was flagged as malware" ], "type": "string" } @@ -817,7 +825,7 @@ "type": "object" }, "ClientInfoDetail": { - "description": "Key-value pair of detailed information about the client which invoked the\ntest. Examples: {'Version', '1.0'}, {'Release Track', 'BETA'}.", + "description": "Key-value pair of detailed information about the client which invoked the test. Examples: {'Version', '1.0'}, {'Release Track', 'BETA'}.", "id": "ClientInfoDetail", "properties": { "key": { @@ -832,21 +840,21 @@ "type": "object" }, "Date": { - "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day\nand time zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. This can represent:\n\n* A full date, with non-zero year, month and day values\n* A month and day value, with a zero year, e.g. an anniversary\n* A year on its own, with zero month and day values\n* A year and month value, with a zero day, e.g. a credit card expiration date\n\nRelated types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", "id": "Date", "properties": { "day": { - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year by itself or a year and month where the day is not\nsignificant.", + "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.", "format": "int32", "type": "integer" }, "month": { - "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a\nmonth and day.", + "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.", "format": "int32", "type": "integer" }, "year": { - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.", + "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.", "format": "int32", "type": "integer" } @@ -889,10 +897,10 @@ "EMULATOR" ], "enumDescriptions": [ - "Do not use. For proto versioning only.", - "Android virtual device using Compute Engine native virtualization. Firebase\nTest Lab only.", + "Do not use. For proto versioning only.", + "Android virtual device using Compute Engine native virtualization. Firebase Test Lab only.", "Actual hardware.", - "Android virtual device using emulator in nested virtualization. Equivalent\nto Android Studio." + "Android virtual device using emulator in nested virtualization. Equivalent to Android Studio." ], "type": "string" } @@ -914,11 +922,11 @@ "type": "object" }, "Distribution": { - "description": "Data about the relative number of devices running a\ngiven configuration of the Android platform.", + "description": "Data about the relative number of devices running a given configuration of the Android platform.", "id": "Distribution", "properties": { "marketShare": { - "description": "Output only. The estimated fraction (0-1) of the total market with this\nconfiguration.", + "description": "Output only. The estimated fraction (0-1) of the total market with this configuration.", "format": "double", "type": "number" }, @@ -951,7 +959,7 @@ "properties": { "androidDeviceList": { "$ref": "AndroidDeviceList", - "description": "A list of Android devices; the test will be run only on the specified\ndevices." + "description": "A list of Android devices; the test will be run only on the specified devices." }, "androidMatrix": { "$ref": "AndroidMatrix", @@ -984,7 +992,7 @@ "id": "FileReference", "properties": { "gcsPath": { - "description": "A path to a file in Google Cloud Storage.\nExample: gs://build-app-1414623860166/app%40debug-unaligned.apk\nThese paths are expected to be url encoded (percent encoding)", + "description": "A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding)", "type": "string" } }, @@ -1002,7 +1010,7 @@ "type": "object" }, "GoogleAuto": { - "description": "Enables automatic Google account login.\nIf set, the service automatically generates a Google test account and adds\nit to the device, before executing the test. Note that test accounts might be\nreused.\nMany applications show their full set of functionalities when an account is\npresent on the device. Logging into the device with these generated accounts\nallows testing more functionalities.", + "description": "Enables automatic Google account login. If set, the service automatically generates a Google test account and adds it to the device, before executing the test. Note that test accounts might be reused. Many applications show their full set of functionalities when an account is present on the device. Logging into the device with these generated accounts allows testing more functionalities.", "id": "GoogleAuto", "properties": {}, "type": "object" @@ -1012,32 +1020,32 @@ "id": "GoogleCloudStorage", "properties": { "gcsPath": { - "description": "Required. The path to a directory in GCS that will\neventually contain the results for this test.\nThe requesting user must have write access on the bucket in the supplied\npath.", + "description": "Required. The path to a directory in GCS that will eventually contain the results for this test. The requesting user must have write access on the bucket in the supplied path.", "type": "string" } }, "type": "object" }, "IntentFilter": { - "description": "The section of an tag.\nhttps://developer.android.com/guide/topics/manifest/intent-filter-element.html", + "description": "The section of an tag. https://developer.android.com/guide/topics/manifest/intent-filter-element.html", "id": "IntentFilter", "properties": { "actionNames": { - "description": "The android:name value of the tag.", + "description": "The android:name value of the tag.", "items": { "type": "string" }, "type": "array" }, "categoryNames": { - "description": "The android:name value of the tag.", + "description": "The android:name value of the tag.", "items": { "type": "string" }, "type": "array" }, "mimeType": { - "description": "The android:mimeType value of the tag.", + "description": "The android:mimeType value of the tag.", "type": "string" } }, @@ -1048,19 +1056,19 @@ "id": "IosDevice", "properties": { "iosModelId": { - "description": "Required. The id of the iOS device to be used.\nUse the TestEnvironmentDiscoveryService to get supported options.", + "description": "Required. The id of the iOS device to be used. Use the TestEnvironmentDiscoveryService to get supported options.", "type": "string" }, "iosVersionId": { - "description": "Required. The id of the iOS major software version to be used.\nUse the TestEnvironmentDiscoveryService to get supported options.", + "description": "Required. The id of the iOS major software version to be used. Use the TestEnvironmentDiscoveryService to get supported options.", "type": "string" }, "locale": { - "description": "Required. The locale the test device used for testing.\nUse the TestEnvironmentDiscoveryService to get supported options.", + "description": "Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options.", "type": "string" }, "orientation": { - "description": "Required. How the device is oriented during the test.\nUse the TestEnvironmentDiscoveryService to get supported options.", + "description": "Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options.", "type": "string" } }, @@ -1113,11 +1121,11 @@ "type": "object" }, "IosModel": { - "description": "A description of an iOS device tests may be run on.\nNext tag: 13", + "description": "A description of an iOS device tests may be run on. Next tag: 13", "id": "IosModel", "properties": { "deviceCapabilities": { - "description": "Device capabilities.\nCopied from\nhttps://developer.apple.com/library/archive/documentation/DeviceInformation/Reference/iOSDeviceCompatibility/DeviceCompatibilityMatrix/DeviceCompatibilityMatrix.html", + "description": "Device capabilities. Copied from https://developer.apple.com/library/archive/documentation/DeviceInformation/Reference/iOSDeviceCompatibility/DeviceCompatibilityMatrix/DeviceCompatibilityMatrix.html", "items": { "type": "string" }, @@ -1140,11 +1148,11 @@ "type": "string" }, "id": { - "description": "The unique opaque id for this model.\nUse this for invoking the TestExecutionService.", + "description": "The unique opaque id for this model. Use this for invoking the TestExecutionService.", "type": "string" }, "name": { - "description": "The human-readable name for this device model.\nExamples: \"iPhone 4s\", \"iPad Mini 2\".", + "description": "The human-readable name for this device model. Examples: \"iPhone 4s\", \"iPad Mini 2\".", "type": "string" }, "screenDensity": { @@ -1170,7 +1178,7 @@ "type": "array" }, "tags": { - "description": "Tags for this dimension.\nExamples: \"default\", \"preview\", \"deprecated\".", + "description": "Tags for this dimension. Examples: \"default\", \"preview\", \"deprecated\".", "items": { "type": "string" }, @@ -1201,7 +1209,7 @@ "type": "object" }, "IosTestLoop": { - "description": "A test of an iOS application that implements one or more game loop scenarios.\nThis test type accepts an archived application (.ipa file) and a list of\ninteger scenarios that will be executed on the app sequentially.", + "description": "A test of an iOS application that implements one or more game loop scenarios. This test type accepts an archived application (.ipa file) and a list of integer scenarios that will be executed on the app sequentially.", "id": "IosTestLoop", "properties": { "appBundleId": { @@ -1213,7 +1221,7 @@ "description": "Required. The .ipa of the application to test." }, "scenarios": { - "description": "The list of scenarios that should be run during the test. Defaults to the\nsingle scenario 0 if unspecified.", + "description": "The list of scenarios that should be run during the test. Defaults to the single scenario 0 if unspecified.", "items": { "format": "int32", "type": "integer" @@ -1228,7 +1236,7 @@ "id": "IosTestSetup", "properties": { "networkProfile": { - "description": "The network traffic profile used for running the test.\nAvailable network profiles can be queried by using the\nNETWORK_CONFIGURATION environment type when calling\nTestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.", + "description": "The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.", "type": "string" } }, @@ -1239,16 +1247,16 @@ "id": "IosVersion", "properties": { "id": { - "description": "An opaque id for this iOS version.\nUse this id to invoke the TestExecutionService.", + "description": "An opaque id for this iOS version. Use this id to invoke the TestExecutionService.", "type": "string" }, "majorVersion": { - "description": "An integer representing the major iOS version.\nExamples: \"8\", \"9\".", + "description": "An integer representing the major iOS version. Examples: \"8\", \"9\".", "format": "int32", "type": "integer" }, "minorVersion": { - "description": "An integer representing the minor iOS version.\nExamples: \"1\", \"2\".", + "description": "An integer representing the minor iOS version. Examples: \"1\", \"2\".", "format": "int32", "type": "integer" }, @@ -1260,7 +1268,7 @@ "type": "array" }, "tags": { - "description": "Tags for this dimension.\nExamples: \"default\", \"preview\", \"deprecated\".", + "description": "Tags for this dimension. Examples: \"default\", \"preview\", \"deprecated\".", "items": { "type": "string" }, @@ -1270,7 +1278,7 @@ "type": "object" }, "IosXcTest": { - "description": "A test of an iOS application that uses the XCTest framework.\nXcode supports the option to \"build for testing\", which generates an\n.xctestrun file that contains a test specification (arguments, test methods,\netc). This test type accepts a zip file containing the .xctestrun file and\nthe corresponding contents of the Build/Products directory that contains all\nthe binaries needed to run the tests.", + "description": "A test of an iOS application that uses the XCTest framework. Xcode supports the option to \"build for testing\", which generates an .xctestrun file that contains a test specification (arguments, test methods, etc). This test type accepts a zip file containing the .xctestrun file and the corresponding contents of the Build/Products directory that contains all the binaries needed to run the tests.", "id": "IosXcTest", "properties": { "appBundleId": { @@ -1278,20 +1286,20 @@ "type": "string" }, "testSpecialEntitlements": { - "description": "The option to test special app entitlements. Setting this would re-sign the\napp having special entitlements with an explicit application-identifier.\nCurrently supports testing aps-environment entitlement.", + "description": "The option to test special app entitlements. Setting this would re-sign the app having special entitlements with an explicit application-identifier. Currently supports testing aps-environment entitlement.", "type": "boolean" }, "testsZip": { "$ref": "FileReference", - "description": "Required. The .zip containing the .xctestrun file and the contents of the\nDerivedData/Build/Products directory.\nThe .xctestrun file in this zip is ignored if the xctestrun field is\nspecified." + "description": "Required. The .zip containing the .xctestrun file and the contents of the DerivedData/Build/Products directory. The .xctestrun file in this zip is ignored if the xctestrun field is specified." }, "xcodeVersion": { - "description": "The Xcode version that should be used for the test.\nUse the TestEnvironmentDiscoveryService to get supported options.\nDefaults to the latest Xcode version Firebase Test Lab supports.", + "description": "The Xcode version that should be used for the test. Use the TestEnvironmentDiscoveryService to get supported options. Defaults to the latest Xcode version Firebase Test Lab supports.", "type": "string" }, "xctestrun": { "$ref": "FileReference", - "description": "An .xctestrun file that will override the .xctestrun file in the\ntests zip. Because the .xctestrun file contains environment variables along\nwith test methods to run and/or ignore, this can be useful for sharding\ntests. Default is taken from the tests zip." + "description": "An .xctestrun file that will override the .xctestrun file in the tests zip. Because the .xctestrun file contains environment variables along with test methods to run and/or ignore, this can be useful for sharding tests. Default is taken from the tests zip." } }, "type": "object" @@ -1307,19 +1315,19 @@ "id": "Locale", "properties": { "id": { - "description": "The id for this locale.\nExample: \"en_US\".", + "description": "The id for this locale. Example: \"en_US\".", "type": "string" }, "name": { - "description": "A human-friendly name for this language/locale.\nExample: \"English\".", + "description": "A human-friendly name for this language/locale. Example: \"English\".", "type": "string" }, "region": { - "description": "A human-friendly string representing the region for this\nlocale. Example: \"United States\". Not present for every locale.", + "description": "A human-friendly string representing the region for this locale. Example: \"United States\". Not present for every locale.", "type": "string" }, "tags": { - "description": "Tags for this dimension.\nExample: \"default\".", + "description": "Tags for this dimension. Example: \"default\".", "items": { "type": "string" }, @@ -1329,11 +1337,11 @@ "type": "object" }, "ManualSharding": { - "description": "Shards test cases into the specified groups of packages, classes, and/or\nmethods.\n\nWith manual sharding enabled, specifying test targets via\nenvironment_variables or in InstrumentationTest is invalid.", + "description": "Shards test cases into the specified groups of packages, classes, and/or methods. With manual sharding enabled, specifying test targets via environment_variables or in InstrumentationTest is invalid.", "id": "ManualSharding", "properties": { "testTargetsForShard": { - "description": "Required. Group of packages, classes, and/or test methods to be run for\neach shard. When any physical devices are selected, the number of\ntest_targets_for_shard must be >= 1 and <= 50. When no physical devices are\nselected, the number must be >= 1 and <= 250.", + "description": "Required. Group of packages, classes, and/or test methods to be run for each shard. When any physical devices are selected, the number of test_targets_for_shard must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 250.", "items": { "$ref": "TestTargetsForShard" }, @@ -1381,7 +1389,7 @@ "description": "Required. Opaque Binary Blob (OBB) file(s) to install on the device." }, "obbFileName": { - "description": "Required. OBB file name which must conform to the format as specified by\nAndroid\ne.g. [main|patch].0300110.com.example.android.obb\nwhich will be installed into\n \\/Android/obb/\\/\non the device.", + "description": "Required. OBB file name which must conform to the format as specified by Android e.g. [main|patch].0300110.com.example.android.obb which will be installed into \\/Android/obb/\\/ on the device.", "type": "string" } }, @@ -1392,15 +1400,15 @@ "id": "Orientation", "properties": { "id": { - "description": "The id for this orientation.\nExample: \"portrait\".", + "description": "The id for this orientation. Example: \"portrait\".", "type": "string" }, "name": { - "description": "A human-friendly name for this orientation.\nExample: \"portrait\".", + "description": "A human-friendly name for this orientation. Example: \"portrait\".", "type": "string" }, "tags": { - "description": "Tags for this dimension.\nExample: \"default\".", + "description": "Tags for this dimension. Example: \"default\".", "items": { "type": "string" }, @@ -1414,7 +1422,7 @@ "id": "ProvidedSoftwareCatalog", "properties": { "orchestratorVersion": { - "description": "A string representing the current version of Android Test\nOrchestrator that is provided by TestExecutionService.\nExample: \"1.0.2 beta\".", + "description": "A string representing the current version of Android Test Orchestrator that is provided by TestExecutionService. Example: \"1.0.2 beta\".", "type": "string" } }, @@ -1429,7 +1437,7 @@ "description": "Required. The source file." }, "devicePath": { - "description": "Required. Where to put the content on the device. Must be an absolute,\nallowlisted path. If the file exists, it will be replaced.\nThe following device-side directories and any of their subdirectories are\nallowlisted:\n

    ${EXTERNAL_STORAGE}, /sdcard, or /storage

    \n

    ${ANDROID_DATA}/local/tmp, or /data/local/tmp

    \n

    Specifying a path outside of these directory trees is invalid.\n\n

    The paths /sdcard and /data will be made available and treated as\nimplicit path substitutions. E.g. if /sdcard on a particular device does\nnot map to external storage, the system will replace it with the external\nstorage path prefix for that device and copy the file there.\n\n

    It is strongly advised to use the \nEnvironment API in app and test code to access files on the device in a\nportable way.", + "description": "Required. Where to put the content on the device. Must be an absolute, allowlisted path. If the file exists, it will be replaced. The following device-side directories and any of their subdirectories are allowlisted: ${EXTERNAL_STORAGE}, /sdcard, or /storage ${ANDROID_DATA}/local/tmp, or /data/local/tmp Specifying a path outside of these directory trees is invalid. The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device and copy the file there. It is strongly advised to use the Environment API in app and test code to access files on the device in a portable way.", "type": "string" } }, @@ -1453,17 +1461,17 @@ }, "toolResultsHistory": { "$ref": "ToolResultsHistory", - "description": "The tool results history that contains the tool results execution that\nresults are written to.\n\nIf not provided, the service will choose an appropriate value." + "description": "The tool results history that contains the tool results execution that results are written to. If not provided, the service will choose an appropriate value." } }, "type": "object" }, "RoboDirective": { - "description": "Directs Robo to interact with a specific UI element if it is encountered\nduring the crawl. Currently, Robo can perform text entry or element click.", + "description": "Directs Robo to interact with a specific UI element if it is encountered during the crawl. Currently, Robo can perform text entry or element click.", "id": "RoboDirective", "properties": { "actionType": { - "description": "Required. The type of action that Robo should perform on the specified\nelement.", + "description": "Required. The type of action that Robo should perform on the specified element.", "enum": [ "ACTION_TYPE_UNSPECIFIED", "SINGLE_CLICK", @@ -1472,18 +1480,18 @@ ], "enumDescriptions": [ "DO NOT USE. For proto versioning only.", - "Direct Robo to click on the specified element. No-op if specified element\nis not clickable.", - "Direct Robo to enter text on the specified element. No-op if specified\nelement is not enabled or does not allow text entry.", + "Direct Robo to click on the specified element. No-op if specified element is not clickable.", + "Direct Robo to enter text on the specified element. No-op if specified element is not enabled or does not allow text entry.", "Direct Robo to ignore interactions with a specific element." ], "type": "string" }, "inputText": { - "description": "The text that Robo is directed to set. If left empty, the directive will be\ntreated as a CLICK on the element matching the resource_name.", + "description": "The text that Robo is directed to set. If left empty, the directive will be treated as a CLICK on the element matching the resource_name.", "type": "string" }, "resourceName": { - "description": "Required. The android resource name of the target UI element.\nFor example,\n in Java: R.string.foo\n in xml: @string/foo\nOnly the \"foo\" part is needed.\nReference doc:\nhttps://developer.android.com/guide/topics/resources/accessing-resources.html", + "description": "Required. The android resource name of the target UI element. For example, in Java: R.string.foo in xml: @string/foo Only the \"foo\" part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html", "type": "string" } }, @@ -1536,7 +1544,7 @@ "properties": { "manualSharding": { "$ref": "ManualSharding", - "description": "Shards test cases into the specified groups of packages, classes, and/or\nmethods." + "description": "Shards test cases into the specified groups of packages, classes, and/or methods." }, "uniformSharding": { "$ref": "UniformSharding", @@ -1550,7 +1558,7 @@ "id": "StartActivityIntent", "properties": { "action": { - "description": "Action name.\nRequired for START_ACTIVITY.", + "description": "Action name. Required for START_ACTIVITY.", "type": "string" }, "categories": { @@ -1571,7 +1579,7 @@ "id": "SystraceSetup", "properties": { "durationSeconds": { - "description": "Systrace duration in seconds.\nShould be between 1 and 30 seconds. 0 disables systrace.", + "description": "Systrace duration in seconds. Should be between 1 and 30 seconds. 0 disables systrace.", "format": "int32", "type": "integer" } @@ -1583,11 +1591,11 @@ "id": "TestDetails", "properties": { "errorMessage": { - "description": "Output only. If the TestState is ERROR, then this string will contain\nhuman-readable details about the error.", + "description": "Output only. If the TestState is ERROR, then this string will contain human-readable details about the error.", "type": "string" }, "progressMessages": { - "description": "Output only. Human-readable, detailed descriptions of the test's progress.\nFor example: \"Provisioning a device\", \"Starting Test\".\n\nDuring the course of execution new data may be appended\nto the end of progress_messages.", + "description": "Output only. Human-readable, detailed descriptions of the test's progress. For example: \"Provisioning a device\", \"Starting Test\". During the course of execution new data may be appended to the end of progress_messages.", "items": { "type": "string" }, @@ -1648,7 +1656,7 @@ "description": "Output only. Details about the shard." }, "state": { - "description": "Output only. Indicates the current progress of the test execution\n(e.g., FINISHED).", + "description": "Output only. Indicates the current progress of the test execution (e.g., FINISHED).", "enum": [ "TEST_STATE_UNSPECIFIED", "VALIDATING", @@ -1663,17 +1671,17 @@ "INVALID" ], "enumDescriptions": [ - "Do not use. For proto versioning only.", + "Do not use. For proto versioning only.", "The execution or matrix is being validated.", "The execution or matrix is waiting for resources to become available.", - "The execution is currently being processed.\n\nCan only be set on an execution.", - "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.", - "The execution or matrix has stopped because it encountered an\ninfrastructure failure.", - "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.", - "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.", - "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.", - "The user cancelled the execution.\n\nCan only be set on an execution.", - "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware" + "The execution is currently being processed. Can only be set on an execution.", + "The execution or matrix has terminated normally. On a matrix this means that the matrix level processing completed normally, but individual executions may be in an ERROR state.", + "The execution or matrix has stopped because it encountered an infrastructure failure.", + "The execution was not run because it corresponds to a unsupported environment. Can only be set on an execution.", + "The execution was not run because the provided inputs are incompatible with the requested environment. Example: requested AndroidVersion is lower than APK's minSdkVersion Can only be set on an execution.", + "The execution was not run because the provided inputs are incompatible with the requested architecture. Example: requested device does not support running the native code in the supplied APK Can only be set on an execution.", + "The user cancelled the execution. Can only be set on an execution.", + "The execution or matrix was not run because the provided inputs are not valid. Examples: input file is not of the expected type, is malformed/corrupt, or was flagged as malware" ], "type": "string" }, @@ -1698,7 +1706,7 @@ "type": "object" }, "TestMatrix": { - "description": "TestMatrix captures all details about a test. It contains the environment\nconfiguration, test specification, test executions and overall state and\noutcome.", + "description": "TestMatrix captures all details about a test. It contains the environment configuration, test specification, test executions and overall state and outcome.", "id": "TestMatrix", "properties": { "clientInfo": { @@ -1710,12 +1718,12 @@ "description": "Required. The devices the tests are being executed on." }, "flakyTestAttempts": { - "description": "The number of times a TestExecution should be re-attempted if one or more\nof its test cases fail for any reason.\nThe maximum number of reruns allowed is 10.\n\nDefault is 0, which implies no reruns.", + "description": "The number of times a TestExecution should be re-attempted if one or more of its test cases fail for any reason. The maximum number of reruns allowed is 10. Default is 0, which implies no reruns.", "format": "int32", "type": "integer" }, "invalidMatrixDetails": { - "description": "Output only. Describes why the matrix is considered invalid.\nOnly useful for matrices in the INVALID state.", + "description": "Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state.", "enum": [ "INVALID_MATRIX_DETAILS_UNSPECIFIED", "DETAILS_UNAVAILABLE", @@ -1760,40 +1768,40 @@ "The input test APK could not be parsed.", "The AndroidManifest.xml could not be found.", "The APK manifest does not declare a package name.", - "The APK application ID (aka package name) is invalid.\nSee also\nhttps://developer.android.com/studio/build/application-id", + "The APK application ID (aka package name) is invalid. See also https://developer.android.com/studio/build/application-id", "The test package and app package are the same.", "The test apk does not declare an instrumentation.", "The input app apk does not have a signature.", - "The test runner class specified by user or in the test APK's manifest file\nis not compatible with Android Test Orchestrator.\nOrchestrator is only compatible with AndroidJUnitRunner version 1.0 or\nhigher.\nOrchestrator can be disabled by using DO_NOT_USE_ORCHESTRATOR\nOrchestratorOption.", - "The test APK does not contain the test runner class specified by user or in\nthe manifest file.\nThis can be caused by either of the following reasons:\n- the user provided a runner class name that's incorrect, or\n- the test runner isn't built into the test APK (might be in the app APK\ninstead).", + "The test runner class specified by user or in the test APK's manifest file is not compatible with Android Test Orchestrator. Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or higher. Orchestrator can be disabled by using DO_NOT_USE_ORCHESTRATOR OrchestratorOption.", + "The test APK does not contain the test runner class specified by user or in the manifest file. This can be caused by either of the following reasons: - the user provided a runner class name that's incorrect, or - the test runner isn't built into the test APK (might be in the app APK instead).", "A main launcher activity could not be found.", "The app declares one or more permissions that are not allowed.", "There is a conflict in the provided robo_directives.", - "There is at least one invalid resource name in the provided\nrobo directives", - "Invalid definition of action in the robo directives\n(e.g. a click or ignore action includes an input text field)", - "There is no test loop intent filter, or the one that is given is\nnot formatted correctly.", - "The request contains a scenario label that was not declared in the\nmanifest.", + "There is at least one invalid resource name in the provided robo directives", + "Invalid definition of action in the robo directives (e.g. a click or ignore action includes an input text field)", + "There is no test loop intent filter, or the one that is given is not formatted correctly.", + "The request contains a scenario label that was not declared in the manifest.", "There was an error when parsing a label's value.", - "The request contains a scenario number that was not declared in the\nmanifest.", + "The request contains a scenario number that was not declared in the manifest.", "Device administrator applications are not allowed.", - "The zipped XCTest was malformed. The zip did not contain a single\n.xctestrun file and the contents of the DerivedData/Build/Products\ndirectory.", - "The zipped XCTest was built for the iOS simulator rather than for a\nphysical device.", + "The zipped XCTest was malformed. The zip did not contain a single .xctestrun file and the contents of the DerivedData/Build/Products directory.", + "The zipped XCTest was built for the iOS simulator rather than for a physical device.", "The .xctestrun file did not specify any test targets.", - "One or more of the test targets defined in the .xctestrun file specifies\n\"UseDestinationArtifacts\", which is disallowed.", - "XC tests which run on physical devices must have\n\"IsAppHostedTestBundle\" == \"true\" in the xctestrun file.", + "One or more of the test targets defined in the .xctestrun file specifies \"UseDestinationArtifacts\", which is disallowed.", + "XC tests which run on physical devices must have \"IsAppHostedTestBundle\" == \"true\" in the xctestrun file.", "An Info.plist file in the XCTest zip could not be parsed.", - "The APK is marked as \"testOnly\".\nDeprecated and not currently used.", + "The APK is marked as \"testOnly\". Deprecated and not currently used.", "The input IPA could not be parsed.", "The application doesn't register the game loop URL scheme.", "The iOS application bundle (.app) couldn't be processed.", - "APK contains no code.\nSee also\nhttps://developer.android.com/guide/topics/manifest/application-element.html#code", - "Either the provided input APK path was malformed,\nthe APK file does not exist, or the user does not have permission to\naccess the APK file.", + "APK contains no code. See also https://developer.android.com/guide/topics/manifest/application-element.html#code", + "Either the provided input APK path was malformed, the APK file does not exist, or the user does not have permission to access the APK file.", "APK is built for a preview SDK which is unsupported" ], "type": "string" }, "outcomeSummary": { - "description": "Output Only. The overall outcome of the test.\nOnly set when the test matrix state is FINISHED.", + "description": "Output Only. The overall outcome of the test. Only set when the test matrix state is FINISHED.", "enum": [ "OUTCOME_SUMMARY_UNSPECIFIED", "SUCCESS", @@ -1803,10 +1811,10 @@ ], "enumDescriptions": [ "Do not use. For proto versioning only.", - "The test matrix run was successful, for instance:\n- All the test cases passed.\n- Robo did not detect a crash of the application under test.", - "A run failed, for instance:\n- One or more test case failed.\n- A test timed out.\n- The application under test crashed.", - "Something unexpected happened. The run should still be considered\nunsuccessful but this is likely a transient problem and re-running the\ntest might be successful.", - "All tests were skipped, for instance:\n- All device configurations were incompatible." + "The test matrix run was successful, for instance: - All the test cases passed. - Robo did not detect a crash of the application under test.", + "A run failed, for instance: - One or more test case failed. - A test timed out. - The application under test crashed.", + "Something unexpected happened. The run should still be considered unsuccessful but this is likely a transient problem and re-running the test might be successful.", + "All tests were skipped, for instance: - All device configurations were incompatible." ], "type": "string" }, @@ -1834,22 +1842,22 @@ "INVALID" ], "enumDescriptions": [ - "Do not use. For proto versioning only.", + "Do not use. For proto versioning only.", "The execution or matrix is being validated.", "The execution or matrix is waiting for resources to become available.", - "The execution is currently being processed.\n\nCan only be set on an execution.", - "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.", - "The execution or matrix has stopped because it encountered an\ninfrastructure failure.", - "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.", - "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.", - "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.", - "The user cancelled the execution.\n\nCan only be set on an execution.", - "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware" + "The execution is currently being processed. Can only be set on an execution.", + "The execution or matrix has terminated normally. On a matrix this means that the matrix level processing completed normally, but individual executions may be in an ERROR state.", + "The execution or matrix has stopped because it encountered an infrastructure failure.", + "The execution was not run because it corresponds to a unsupported environment. Can only be set on an execution.", + "The execution was not run because the provided inputs are incompatible with the requested environment. Example: requested AndroidVersion is lower than APK's minSdkVersion Can only be set on an execution.", + "The execution was not run because the provided inputs are incompatible with the requested architecture. Example: requested device does not support running the native code in the supplied APK Can only be set on an execution.", + "The user cancelled the execution. Can only be set on an execution.", + "The execution or matrix was not run because the provided inputs are not valid. Examples: input file is not of the expected type, is malformed/corrupt, or was flagged as malware" ], "type": "string" }, "testExecutions": { - "description": "Output only. The list of test executions that the service creates for\nthis matrix.", + "description": "Output only. The list of test executions that the service creates for this matrix.", "items": { "$ref": "TestExecution" }, @@ -1880,14 +1888,14 @@ "description": "The device will be logged in on this account for the duration of the test." }, "additionalApks": { - "description": "APKs to install in addition to those being directly tested.\nCurrently capped at 100.", + "description": "APKs to install in addition to those being directly tested. Currently capped at 100.", "items": { "$ref": "Apk" }, "type": "array" }, "directoriesToPull": { - "description": "List of directories on the device to upload to GCS at the end of the test;\nthey must be absolute paths under /sdcard, /storage or /data/local/tmp.\nPath names are restricted to characters a-z A-Z 0-9 _ - . + and /\n\nNote: The paths /sdcard and /data will be made available and treated as\nimplicit path substitutions. E.g. if /sdcard on a particular device does\nnot map to external storage, the system will replace it with the external\nstorage path prefix for that device.", + "description": "List of directories on the device to upload to GCS at the end of the test; they must be absolute paths under /sdcard, /storage or /data/local/tmp. Path names are restricted to characters a-z A-Z 0-9 _ - . + and / Note: The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device.", "items": { "type": "string" }, @@ -1898,7 +1906,7 @@ "type": "boolean" }, "environmentVariables": { - "description": "Environment variables to set for the test (only applicable for\ninstrumentation tests).", + "description": "Environment variables to set for the test (only applicable for instrumentation tests).", "items": { "$ref": "EnvironmentVariable" }, @@ -1912,12 +1920,12 @@ "type": "array" }, "networkProfile": { - "description": "The network traffic profile used for running the test.\nAvailable network profiles can be queried by using the\nNETWORK_CONFIGURATION environment type when calling\nTestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.", + "description": "The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.", "type": "string" }, "systrace": { "$ref": "SystraceSetup", - "description": "Systrace configuration for the run.\nIf set a systrace will be taken, starting on test start and lasting for the\nconfigured duration. The systrace file thus obtained is put in the results\nbucket together with the other artifacts from the run." + "description": "Systrace configuration for the run. If set a systrace will be taken, starting on test start and lasting for the configured duration. The systrace file thus obtained is put in the results bucket together with the other artifacts from the run." } }, "type": "object" @@ -1960,10 +1968,10 @@ }, "testSetup": { "$ref": "TestSetup", - "description": "Test setup requirements for Android e.g. files to install, bootstrap\nscripts." + "description": "Test setup requirements for Android e.g. files to install, bootstrap scripts." }, "testTimeout": { - "description": "Max time a test execution is allowed to run before it is\nautomatically cancelled.\nThe default value is 5 min.", + "description": "Max time a test execution is allowed to run before it is automatically cancelled. The default value is 5 min.", "format": "google-duration", "type": "string" } @@ -1975,7 +1983,7 @@ "id": "TestTargetsForShard", "properties": { "testTargets": { - "description": "Group of packages, classes, and/or test methods to be run for each shard.\nThe targets need to be specified in AndroidJUnitRunner argument format. For\nexample, “package com.my.packages” “class com.my.package.MyClass”.\n\nThe number of shard_test_targets must be greater than 0.", + "description": "Group of packages, classes, and/or test methods to be run for each shard. The targets need to be specified in AndroidJUnitRunner argument format. For example, \"package com.my.packages\" \"class com.my.package.MyClass\". The number of shard_test_targets must be greater than 0.", "items": { "type": "string" }, @@ -1985,7 +1993,7 @@ "type": "object" }, "ToolResultsExecution": { - "description": "Represents a tool results execution resource.\n\nThis has the results of a TestMatrix.", + "description": "Represents a tool results execution resource. This has the results of a TestMatrix.", "id": "ToolResultsExecution", "properties": { "executionId": { @@ -2019,7 +2027,7 @@ "type": "object" }, "ToolResultsStep": { - "description": "Represents a tool results step resource.\n\nThis has the results of a TestExecution.", + "description": "Represents a tool results step resource. This has the results of a TestExecution.", "id": "ToolResultsStep", "properties": { "executionId": { @@ -2074,11 +2082,11 @@ "type": "object" }, "UniformSharding": { - "description": "Uniformly shards test cases given a total number of shards.\n\nFor Instrumentation test, it will be translated to “-e numShard” “-e\nshardIndex” AndroidJUnitRunner arguments. With uniform sharding enabled,\nspecifying these sharding arguments via environment_variables is invalid.", + "description": "Uniformly shards test cases given a total number of shards. For Instrumentation test, it will be translated to \"-e numShard\" \"-e shardIndex\" AndroidJUnitRunner arguments. With uniform sharding enabled, specifying these sharding arguments via environment_variables is invalid.", "id": "UniformSharding", "properties": { "numShards": { - "description": "Required. Total number of shards. When any physical devices are selected,\nthe number must be >= 1 and <= 50. When no physical devices are selected,\nthe number must be >= 1 and <= 250.", + "description": "Required. Total number of shards. When any physical devices are selected, the number must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 250.", "format": "int32", "type": "integer" } @@ -2090,14 +2098,14 @@ "id": "XcodeVersion", "properties": { "tags": { - "description": "Tags for this Xcode version.\nExample: \"default\".", + "description": "Tags for this Xcode version. Example: \"default\".", "items": { "type": "string" }, "type": "array" }, "version": { - "description": "The id for this version.\nExample: \"9.2\".", + "description": "The id for this version. Example: \"9.2\".", "type": "string" } }, diff --git a/discovery/texttospeech-v1beta1.json b/discovery/texttospeech-v1beta1.json index 3f54430873..6a07a3d616 100644 --- a/discovery/texttospeech-v1beta1.json +++ b/discovery/texttospeech-v1beta1.json @@ -153,7 +153,7 @@ } } }, - "revision": "20200703", + "revision": "20200731", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AudioConfig": { @@ -166,13 +166,15 @@ "AUDIO_ENCODING_UNSPECIFIED", "LINEAR16", "MP3", - "OGG_OPUS" + "OGG_OPUS", + "MULAW" ], "enumDescriptions": [ "Not specified. Will return result google.rpc.Code.INVALID_ARGUMENT.", "Uncompressed 16-bit signed little-endian samples (Linear PCM).\nAudio content returned as LINEAR16 also contains a WAV header.", "MP3 audio at 32kbps.", - "Opus encoded audio wrapped in an ogg container. The result will be a\nfile which can be played natively on Android, and in browsers (at least\nChrome and Firefox). The quality of the encoding is considerably higher\nthan MP3 while using approximately the same bitrate." + "Opus encoded audio wrapped in an ogg container. The result will be a\nfile which can be played natively on Android, and in browsers (at least\nChrome and Firefox). The quality of the encoding is considerably higher\nthan MP3 while using approximately the same bitrate.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.\nAudio content returned as MULAW also contains a WAV header." ], "type": "string" }, @@ -243,6 +245,21 @@ "$ref": "AudioConfig", "description": "Required. The configuration of the synthesized audio." }, + "enableTimePointing": { + "description": "Whether and what timepoints are returned in the response.", + "enumDescriptions": [ + "Not specified. No timepoint information will be returned.", + "Timepoint information of tags in SSML input will be returned." + ], + "items": { + "enum": [ + "TIMEPOINT_TYPE_UNSPECIFIED", + "SSML_MARK" + ], + "type": "string" + }, + "type": "array" + }, "input": { "$ref": "SynthesisInput", "description": "Required. The Synthesizer requires either plain text or SSML as input." @@ -258,10 +275,37 @@ "description": "The message returned to the client by the `SynthesizeSpeech` method.", "id": "SynthesizeSpeechResponse", "properties": { + "audioConfig": { + "$ref": "AudioConfig", + "description": "The audio metadata of `audio_content`." + }, "audioContent": { "description": "The audio data bytes encoded as specified in the request, including the\nheader for encodings that are wrapped in containers (e.g. MP3, OGG_OPUS).\nFor LINEAR16 audio, we include the WAV header. Note: as\nwith all bytes fields, protobuffers use a pure binary representation,\nwhereas JSON representations use base64.", "format": "byte", "type": "string" + }, + "timepoints": { + "description": "A link between a position in the original request input and a corresponding\ntime in the output audio. It's only supported via of SSML input.", + "items": { + "$ref": "Timepoint" + }, + "type": "array" + } + }, + "type": "object" + }, + "Timepoint": { + "description": "This contains a mapping between a certain point in the input text and a\ncorresponding time in the output audio.", + "id": "Timepoint", + "properties": { + "markName": { + "description": "Timepoint name as received from the client within tag.", + "type": "string" + }, + "timeSeconds": { + "description": "Time offset in seconds from the start of the synthesized audio.", + "format": "double", + "type": "number" } }, "type": "object" diff --git a/discovery/translate-v3.json b/discovery/translate-v3.json index ad50eff8d1..2072e484b3 100644 --- a/discovery/translate-v3.json +++ b/discovery/translate-v3.json @@ -492,7 +492,7 @@ ], "parameters": { "filter": { - "description": "Optional. Filter specifying constraints of a list operation.\nFiltering is not supported yet, and the parameter currently has no effect.\nIf missing, no filtering is performed.", + "description": "Optional. Filter specifying constraints of a list operation.\nSpecify the constraint by the format of \"key=value\", where key must be\n\"src\" or \"tgt\", and the value must be a valid language code.\nFor multiple restrictions, concatenate them by \"AND\" (uppercase only),\nsuch as: \"src=en-US AND tgt=zh-CN\". Notice that the exact match is used\nhere, which means using 'en-US' and 'en' can lead to different results,\nwhich depends on the language code you used when you create the glossary.\nFor the unidirectional glossaries, the \"src\" and \"tgt\" add restrictions\non the source and target language code separately.\nFor the equivalent term set glossaries, the \"src\" and/or \"tgt\" add\nrestrictions on the term set.\nFor example: \"src=en-US AND tgt=zh-CN\" will only pick the unidirectional\nglossaries which exactly match the source language code as \"en-US\" and the\ntarget language code \"zh-CN\", but all equivalent term set glossaries which\ncontain \"en-US\" and \"zh-CN\" in their language set will be picked.\nIf missing, no filtering is performed.", "location": "query", "type": "string" }, @@ -687,7 +687,7 @@ } } }, - "revision": "20200522", + "revision": "20200730", "rootUrl": "https://translation.googleapis.com/", "schemas": { "BatchTranslateTextRequest": { diff --git a/discovery/translate-v3beta1.json b/discovery/translate-v3beta1.json index d61d4d4a35..32bb37a86a 100644 --- a/discovery/translate-v3beta1.json +++ b/discovery/translate-v3beta1.json @@ -492,7 +492,7 @@ ], "parameters": { "filter": { - "description": "Optional. Filter specifying constraints of a list operation.\nFiltering is not supported yet, and the parameter currently has no effect.\nIf missing, no filtering is performed.", + "description": "Optional. Filter specifying constraints of a list operation.\nSpecify the constraint by the format of \"key=value\", where key must be\n\"src\" or \"tgt\", and the value must be a valid language code.\nFor multiple restrictions, concatenate them by \"AND\" (uppercase only),\nsuch as: \"src=en-US AND tgt=zh-CN\". Notice that the exact match is used\nhere, which means using 'en-US' and 'en' can lead to different results,\nwhich depends on the language code you used when you create the glossary.\nFor the unidirectional glossaries, the \"src\" and \"tgt\" add restrictions\non the source and target language code separately.\nFor the equivalent term set glossaries, the \"src\" and/or \"tgt\" add\nrestrictions on the term set.\nFor example: \"src=en-US AND tgt=zh-CN\" will only pick the unidirectional\nglossaries which exactly match the source language code as \"en-US\" and the\ntarget language code \"zh-CN\", but all equivalent term set glossaries which\ncontain \"en-US\" and \"zh-CN\" in their language set will be picked.\nIf missing, no filtering is performed.", "location": "query", "type": "string" }, @@ -687,7 +687,7 @@ } } }, - "revision": "20200508", + "revision": "20200730", "rootUrl": "https://translation.googleapis.com/", "schemas": { "BatchTranslateTextRequest": { diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index c8889bfa04..c1afbea0a4 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -296,7 +296,7 @@ export namespace bigquerydatatransfer_v1 { enableFailureEmail?: boolean | null; } /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -373,7 +373,7 @@ export namespace bigquerydatatransfer_v1 { */ displayName?: string | null; /** - * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string} | null; /** @@ -451,7 +451,7 @@ export namespace bigquerydatatransfer_v1 { runs?: Schema$TransferRun[]; } /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -459,7 +459,7 @@ export namespace bigquerydatatransfer_v1 { */ code?: number | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}> | null; /** @@ -485,7 +485,7 @@ export namespace bigquerydatatransfer_v1 { */ export interface Schema$TransferConfig { /** - * The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. + * The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. */ dataRefreshWindowDays?: number | null; /** @@ -685,9 +685,7 @@ export namespace bigquerydatatransfer_v1 { * * // Do the magic * const res = await bigquerydatatransfer.projects.dataSources.checkValidCreds({ - * // Required. The data source in the form: - * // `projects/{project_id}/dataSources/{data_source_id}` or - * // `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. + * // Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. * name: 'projects/my-project/dataSources/my-dataSource', * * // Request body metadata @@ -838,9 +836,7 @@ export namespace bigquerydatatransfer_v1 { * * // Do the magic * const res = await bigquerydatatransfer.projects.dataSources.get({ - * // Required. The field will contain name of the resource requested, for example: - * // `projects/{project_id}/dataSources/{data_source_id}` or - * // `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}` + * // Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}` * name: 'projects/my-project/dataSources/my-dataSource', * }); * console.log(res.data); @@ -993,15 +989,9 @@ export namespace bigquerydatatransfer_v1 { * const res = await bigquerydatatransfer.projects.dataSources.list({ * // Page size. The default page size is the maximum value of 1000 results. * pageSize: 'placeholder-value', - * // Pagination token, which can be used to request a specific page - * // of `ListDataSourcesRequest` list results. For multiple-page - * // results, `ListDataSourcesResponse` outputs - * // a `next_page` token, which can be used as the - * // `page_token` value to request the next page of list results. + * // Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. * pageToken: 'placeholder-value', - * // Required. The BigQuery project id for which data sources should be returned. - * // Must be in the form: `projects/{project_id}` or - * // `projects/{project_id}/locations/{location_id} + * // Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id} * parent: 'projects/my-project', * }); * console.log(res.data); @@ -1521,9 +1511,7 @@ export namespace bigquerydatatransfer_v1 { * // Do the magic * const res = await bigquerydatatransfer.projects.locations.dataSources.checkValidCreds( * { - * // Required. The data source in the form: - * // `projects/{project_id}/dataSources/{data_source_id}` or - * // `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. + * // Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. * name: * 'projects/my-project/locations/my-location/dataSources/my-dataSource', * @@ -1676,9 +1664,7 @@ export namespace bigquerydatatransfer_v1 { * * // Do the magic * const res = await bigquerydatatransfer.projects.locations.dataSources.get({ - * // Required. The field will contain name of the resource requested, for example: - * // `projects/{project_id}/dataSources/{data_source_id}` or - * // `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}` + * // Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}` * name: 'projects/my-project/locations/my-location/dataSources/my-dataSource', * }); * console.log(res.data); @@ -1831,15 +1817,9 @@ export namespace bigquerydatatransfer_v1 { * const res = await bigquerydatatransfer.projects.locations.dataSources.list({ * // Page size. The default page size is the maximum value of 1000 results. * pageSize: 'placeholder-value', - * // Pagination token, which can be used to request a specific page - * // of `ListDataSourcesRequest` list results. For multiple-page - * // results, `ListDataSourcesResponse` outputs - * // a `next_page` token, which can be used as the - * // `page_token` value to request the next page of list results. + * // Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. * pageToken: 'placeholder-value', - * // Required. The BigQuery project id for which data sources should be returned. - * // Must be in the form: `projects/{project_id}` or - * // `projects/{project_id}/locations/{location_id} + * // Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id} * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); @@ -2026,39 +2006,13 @@ export namespace bigquerydatatransfer_v1 { * // Do the magic * const res = await bigquerydatatransfer.projects.locations.transferConfigs.create( * { - * // Optional OAuth2 authorization code to use with this transfer configuration. - * // This is required if new credentials are needed, as indicated by - * // `CheckValidCreds`. - * // In order to obtain authorization_code, please make a - * // request to - * // https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= - * // - * // * client_id should be OAuth client_id of BigQuery DTS API for the given - * // data source returned by ListDataSources method. - * // * data_source_scopes are the scopes returned by ListDataSources method. - * // * redirect_uri is an optional parameter. If not specified, then - * // authorization code is posted to the opener of authorization flow window. - * // Otherwise it will be sent to the redirect uri. A special value of - * // urn:ietf:wg:oauth:2.0:oob means that authorization code should be - * // returned in the title bar of the browser, with the page text prompting - * // the user to copy the code and paste it in the application. + * // Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. * authorizationCode: 'placeholder-value', - * // Required. The BigQuery project id where the transfer configuration should be created. - * // Must be in the format projects/{project_id}/locations/{location_id} or - * // projects/{project_id}. If specified location and location of the - * // destination bigquery dataset do not match - the request will fail. + * // Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail. * parent: 'projects/my-project/locations/my-location', - * // Optional service account name. If this field is set, transfer config will - * // be created with this service account credentials. It requires that - * // requesting user calling this API has permissions to act as this service - * // account. + * // Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account. * serviceAccountName: 'placeholder-value', - * // Optional version info. If users want to find a very recent access token, - * // that is, immediately after approving access, users have to set the - * // version_info claim in the token request. To obtain the version_info, users - * // must use the "none+gsession" response type. which be return a - * // version_info back in the authorization response which be be put in a JWT - * // claim in the token request. + * // Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. * versionInfo: 'placeholder-value', * * // Request body metadata @@ -2117,7 +2071,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. + * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. * @param {string} params.parent Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail. * @param {string=} params.serviceAccountName Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account. * @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. @@ -2237,9 +2191,7 @@ export namespace bigquerydatatransfer_v1 { * // Do the magic * const res = await bigquerydatatransfer.projects.locations.transferConfigs.delete( * { - * // Required. The field will contain name of the resource requested, for example: - * // `projects/{project_id}/transferConfigs/{config_id}` or - * // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` + * // Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` * name: * 'projects/my-project/locations/my-location/transferConfigs/my-transferConfig', * } @@ -2374,9 +2326,7 @@ export namespace bigquerydatatransfer_v1 { * // Do the magic * const res = await bigquerydatatransfer.projects.locations.transferConfigs.get( * { - * // Required. The field will contain name of the resource requested, for example: - * // `projects/{project_id}/transferConfigs/{config_id}` or - * // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` + * // Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` * name: * 'projects/my-project/locations/my-location/transferConfigs/my-transferConfig', * } @@ -2532,15 +2482,9 @@ export namespace bigquerydatatransfer_v1 { * dataSourceIds: 'placeholder-value', * // Page size. The default page size is the maximum value of 1000 results. * pageSize: 'placeholder-value', - * // Pagination token, which can be used to request a specific page - * // of `ListTransfersRequest` list results. For multiple-page - * // results, `ListTransfersResponse` outputs - * // a `next_page` token, which can be used as the - * // `page_token` value to request the next page of list results. + * // Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. * pageToken: 'placeholder-value', - * // Required. The BigQuery project id for which data sources - * // should be returned: `projects/{project_id}` or - * // `projects/{project_id}/locations/{location_id}` + * // Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}` * parent: 'projects/my-project/locations/my-location', * } * ); @@ -2685,46 +2629,16 @@ export namespace bigquerydatatransfer_v1 { * // Do the magic * const res = await bigquerydatatransfer.projects.locations.transferConfigs.patch( * { - * // Optional OAuth2 authorization code to use with this transfer configuration. - * // If it is provided, the transfer configuration will be associated with the - * // authorizing user. - * // In order to obtain authorization_code, please make a - * // request to - * // https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= - * // - * // * client_id should be OAuth client_id of BigQuery DTS API for the given - * // data source returned by ListDataSources method. - * // * data_source_scopes are the scopes returned by ListDataSources method. - * // * redirect_uri is an optional parameter. If not specified, then - * // authorization code is posted to the opener of authorization flow window. - * // Otherwise it will be sent to the redirect uri. A special value of - * // urn:ietf:wg:oauth:2.0:oob means that authorization code should be - * // returned in the title bar of the browser, with the page text prompting - * // the user to copy the code and paste it in the application. + * // Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. * authorizationCode: 'placeholder-value', - * // The resource name of the transfer config. - * // Transfer config names have the form of - * // `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. - * // The name is automatically generated based on the config_id specified in - * // CreateTransferConfigRequest along with project_id and region. If config_id - * // is not provided, usually a uuid, even though it is not guaranteed or - * // required, will be generated for config_id. + * // The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id. * name: * 'projects/my-project/locations/my-location/transferConfigs/my-transferConfig', - * // Optional service account name. If this field is set and - * // "service_account_name" is set in update_mask, transfer config will be - * // updated to use this service account credentials. It requires that - * // requesting user calling this API has permissions to act as this service - * // account. + * // Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account. * serviceAccountName: 'placeholder-value', * // Required. Required list of fields to be updated in this request. * updateMask: 'placeholder-value', - * // Optional version info. If users want to find a very recent access token, - * // that is, immediately after approving access, users have to set the - * // version_info claim in the token request. To obtain the version_info, users - * // must use the "none+gsession" response type. which be return a - * // version_info back in the authorization response which be be put in a JWT - * // claim in the token request. + * // Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. * versionInfo: 'placeholder-value', * * // Request body metadata @@ -2783,7 +2697,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. + * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. * @param {string} params.name The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id. * @param {string=} params.serviceAccountName Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account. * @param {string=} params.updateMask Required. Required list of fields to be updated in this request. @@ -2901,9 +2815,7 @@ export namespace bigquerydatatransfer_v1 { * // Do the magic * const res = await bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns( * { - * // Required. Transfer configuration name in the form: - * // `projects/{project_id}/transferConfigs/{config_id}` or - * // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. + * // Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. * parent: * 'projects/my-project/locations/my-location/transferConfigs/my-transferConfig', * @@ -3060,9 +2972,7 @@ export namespace bigquerydatatransfer_v1 { * // Do the magic * const res = await bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns( * { - * // Transfer configuration name in the form: - * // `projects/{project_id}/transferConfigs/{config_id}` or - * // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. + * // Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. * parent: * 'projects/my-project/locations/my-location/transferConfigs/my-transferConfig', * @@ -3192,7 +3102,7 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Locations$Transferconfigs$Create extends StandardParameters { /** - * Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. + * Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. */ authorizationCode?: string; /** @@ -3249,7 +3159,7 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Locations$Transferconfigs$Patch extends StandardParameters { /** - * Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. + * Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. */ authorizationCode?: string; /** @@ -3340,9 +3250,7 @@ export namespace bigquerydatatransfer_v1 { * // Do the magic * const res = await bigquerydatatransfer.projects.locations.transferConfigs.runs.delete( * { - * // Required. The field will contain name of the resource requested, for example: - * // `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or - * // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` + * // Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` * name: * 'projects/my-project/locations/my-location/transferConfigs/my-transferConfig/runs/my-run', * } @@ -3477,9 +3385,7 @@ export namespace bigquerydatatransfer_v1 { * // Do the magic * const res = await bigquerydatatransfer.projects.locations.transferConfigs.runs.get( * { - * // Required. The field will contain name of the resource requested, for example: - * // `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or - * // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` + * // Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` * name: * 'projects/my-project/locations/my-location/transferConfigs/my-transferConfig/runs/my-run', * } @@ -3632,16 +3538,9 @@ export namespace bigquerydatatransfer_v1 { * { * // Page size. The default page size is the maximum value of 1000 results. * pageSize: 'placeholder-value', - * // Pagination token, which can be used to request a specific page - * // of `ListTransferRunsRequest` list results. For multiple-page - * // results, `ListTransferRunsResponse` outputs - * // a `next_page` token, which can be used as the - * // `page_token` value to request the next page of list results. + * // Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. * pageToken: 'placeholder-value', - * // Required. Name of transfer configuration for which transfer runs should be retrieved. - * // Format of transfer configuration resource name is: - * // `projects/{project_id}/transferConfigs/{config_id}` or - * // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. + * // Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. * parent: * 'projects/my-project/locations/my-location/transferConfigs/my-transferConfig', * // Indicates how run attempts are to be pulled. @@ -3837,20 +3736,13 @@ export namespace bigquerydatatransfer_v1 { * // Do the magic * const res = await bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list( * { - * // Message types to return. If not populated - INFO, WARNING and ERROR - * // messages are returned. + * // Message types to return. If not populated - INFO, WARNING and ERROR messages are returned. * messageTypes: 'placeholder-value', * // Page size. The default page size is the maximum value of 1000 results. * pageSize: 'placeholder-value', - * // Pagination token, which can be used to request a specific page - * // of `ListTransferLogsRequest` list results. For multiple-page - * // results, `ListTransferLogsResponse` outputs - * // a `next_page` token, which can be used as the - * // `page_token` value to request the next page of list results. + * // Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. * pageToken: 'placeholder-value', - * // Required. Transfer run name in the form: - * // `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or - * // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` + * // Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` * parent: * 'projects/my-project/locations/my-location/transferConfigs/my-transferConfig/runs/my-run', * } @@ -4022,39 +3914,13 @@ export namespace bigquerydatatransfer_v1 { * * // Do the magic * const res = await bigquerydatatransfer.projects.transferConfigs.create({ - * // Optional OAuth2 authorization code to use with this transfer configuration. - * // This is required if new credentials are needed, as indicated by - * // `CheckValidCreds`. - * // In order to obtain authorization_code, please make a - * // request to - * // https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= - * // - * // * client_id should be OAuth client_id of BigQuery DTS API for the given - * // data source returned by ListDataSources method. - * // * data_source_scopes are the scopes returned by ListDataSources method. - * // * redirect_uri is an optional parameter. If not specified, then - * // authorization code is posted to the opener of authorization flow window. - * // Otherwise it will be sent to the redirect uri. A special value of - * // urn:ietf:wg:oauth:2.0:oob means that authorization code should be - * // returned in the title bar of the browser, with the page text prompting - * // the user to copy the code and paste it in the application. + * // Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. * authorizationCode: 'placeholder-value', - * // Required. The BigQuery project id where the transfer configuration should be created. - * // Must be in the format projects/{project_id}/locations/{location_id} or - * // projects/{project_id}. If specified location and location of the - * // destination bigquery dataset do not match - the request will fail. + * // Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail. * parent: 'projects/my-project', - * // Optional service account name. If this field is set, transfer config will - * // be created with this service account credentials. It requires that - * // requesting user calling this API has permissions to act as this service - * // account. + * // Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account. * serviceAccountName: 'placeholder-value', - * // Optional version info. If users want to find a very recent access token, - * // that is, immediately after approving access, users have to set the - * // version_info claim in the token request. To obtain the version_info, users - * // must use the "none+gsession" response type. which be return a - * // version_info back in the authorization response which be be put in a JWT - * // claim in the token request. + * // Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. * versionInfo: 'placeholder-value', * * // Request body metadata @@ -4112,7 +3978,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. + * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. * @param {string} params.parent Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail. * @param {string=} params.serviceAccountName Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account. * @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. @@ -4231,9 +4097,7 @@ export namespace bigquerydatatransfer_v1 { * * // Do the magic * const res = await bigquerydatatransfer.projects.transferConfigs.delete({ - * // Required. The field will contain name of the resource requested, for example: - * // `projects/{project_id}/transferConfigs/{config_id}` or - * // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` + * // Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` * name: 'projects/my-project/transferConfigs/my-transferConfig', * }); * console.log(res.data); @@ -4365,9 +4229,7 @@ export namespace bigquerydatatransfer_v1 { * * // Do the magic * const res = await bigquerydatatransfer.projects.transferConfigs.get({ - * // Required. The field will contain name of the resource requested, for example: - * // `projects/{project_id}/transferConfigs/{config_id}` or - * // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` + * // Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` * name: 'projects/my-project/transferConfigs/my-transferConfig', * }); * console.log(res.data); @@ -4520,15 +4382,9 @@ export namespace bigquerydatatransfer_v1 { * dataSourceIds: 'placeholder-value', * // Page size. The default page size is the maximum value of 1000 results. * pageSize: 'placeholder-value', - * // Pagination token, which can be used to request a specific page - * // of `ListTransfersRequest` list results. For multiple-page - * // results, `ListTransfersResponse` outputs - * // a `next_page` token, which can be used as the - * // `page_token` value to request the next page of list results. + * // Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. * pageToken: 'placeholder-value', - * // Required. The BigQuery project id for which data sources - * // should be returned: `projects/{project_id}` or - * // `projects/{project_id}/locations/{location_id}` + * // Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}` * parent: 'projects/my-project', * }); * console.log(res.data); @@ -4671,45 +4527,15 @@ export namespace bigquerydatatransfer_v1 { * * // Do the magic * const res = await bigquerydatatransfer.projects.transferConfigs.patch({ - * // Optional OAuth2 authorization code to use with this transfer configuration. - * // If it is provided, the transfer configuration will be associated with the - * // authorizing user. - * // In order to obtain authorization_code, please make a - * // request to - * // https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= - * // - * // * client_id should be OAuth client_id of BigQuery DTS API for the given - * // data source returned by ListDataSources method. - * // * data_source_scopes are the scopes returned by ListDataSources method. - * // * redirect_uri is an optional parameter. If not specified, then - * // authorization code is posted to the opener of authorization flow window. - * // Otherwise it will be sent to the redirect uri. A special value of - * // urn:ietf:wg:oauth:2.0:oob means that authorization code should be - * // returned in the title bar of the browser, with the page text prompting - * // the user to copy the code and paste it in the application. + * // Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. * authorizationCode: 'placeholder-value', - * // The resource name of the transfer config. - * // Transfer config names have the form of - * // `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. - * // The name is automatically generated based on the config_id specified in - * // CreateTransferConfigRequest along with project_id and region. If config_id - * // is not provided, usually a uuid, even though it is not guaranteed or - * // required, will be generated for config_id. + * // The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id. * name: 'projects/my-project/transferConfigs/my-transferConfig', - * // Optional service account name. If this field is set and - * // "service_account_name" is set in update_mask, transfer config will be - * // updated to use this service account credentials. It requires that - * // requesting user calling this API has permissions to act as this service - * // account. + * // Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account. * serviceAccountName: 'placeholder-value', * // Required. Required list of fields to be updated in this request. * updateMask: 'placeholder-value', - * // Optional version info. If users want to find a very recent access token, - * // that is, immediately after approving access, users have to set the - * // version_info claim in the token request. To obtain the version_info, users - * // must use the "none+gsession" response type. which be return a - * // version_info back in the authorization response which be be put in a JWT - * // claim in the token request. + * // Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. * versionInfo: 'placeholder-value', * * // Request body metadata @@ -4767,7 +4593,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. + * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. * @param {string} params.name The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id. * @param {string=} params.serviceAccountName Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account. * @param {string=} params.updateMask Required. Required list of fields to be updated in this request. @@ -4884,9 +4710,7 @@ export namespace bigquerydatatransfer_v1 { * * // Do the magic * const res = await bigquerydatatransfer.projects.transferConfigs.scheduleRuns({ - * // Required. Transfer configuration name in the form: - * // `projects/{project_id}/transferConfigs/{config_id}` or - * // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. + * // Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. * parent: 'projects/my-project/transferConfigs/my-transferConfig', * * // Request body metadata @@ -5041,9 +4865,7 @@ export namespace bigquerydatatransfer_v1 { * // Do the magic * const res = await bigquerydatatransfer.projects.transferConfigs.startManualRuns( * { - * // Transfer configuration name in the form: - * // `projects/{project_id}/transferConfigs/{config_id}` or - * // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. + * // Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. * parent: 'projects/my-project/transferConfigs/my-transferConfig', * * // Request body metadata @@ -5172,7 +4994,7 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Transferconfigs$Create extends StandardParameters { /** - * Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. + * Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. */ authorizationCode?: string; /** @@ -5229,7 +5051,7 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Transferconfigs$Patch extends StandardParameters { /** - * Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. + * Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. */ authorizationCode?: string; /** @@ -5319,9 +5141,7 @@ export namespace bigquerydatatransfer_v1 { * * // Do the magic * const res = await bigquerydatatransfer.projects.transferConfigs.runs.delete({ - * // Required. The field will contain name of the resource requested, for example: - * // `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or - * // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` + * // Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` * name: 'projects/my-project/transferConfigs/my-transferConfig/runs/my-run', * }); * console.log(res.data); @@ -5453,9 +5273,7 @@ export namespace bigquerydatatransfer_v1 { * * // Do the magic * const res = await bigquerydatatransfer.projects.transferConfigs.runs.get({ - * // Required. The field will contain name of the resource requested, for example: - * // `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or - * // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` + * // Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` * name: 'projects/my-project/transferConfigs/my-transferConfig/runs/my-run', * }); * console.log(res.data); @@ -5605,16 +5423,9 @@ export namespace bigquerydatatransfer_v1 { * const res = await bigquerydatatransfer.projects.transferConfigs.runs.list({ * // Page size. The default page size is the maximum value of 1000 results. * pageSize: 'placeholder-value', - * // Pagination token, which can be used to request a specific page - * // of `ListTransferRunsRequest` list results. For multiple-page - * // results, `ListTransferRunsResponse` outputs - * // a `next_page` token, which can be used as the - * // `page_token` value to request the next page of list results. + * // Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. * pageToken: 'placeholder-value', - * // Required. Name of transfer configuration for which transfer runs should be retrieved. - * // Format of transfer configuration resource name is: - * // `projects/{project_id}/transferConfigs/{config_id}` or - * // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. + * // Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. * parent: 'projects/my-project/transferConfigs/my-transferConfig', * // Indicates how run attempts are to be pulled. * runAttempt: 'placeholder-value', @@ -5808,20 +5619,13 @@ export namespace bigquerydatatransfer_v1 { * // Do the magic * const res = await bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list( * { - * // Message types to return. If not populated - INFO, WARNING and ERROR - * // messages are returned. + * // Message types to return. If not populated - INFO, WARNING and ERROR messages are returned. * messageTypes: 'placeholder-value', * // Page size. The default page size is the maximum value of 1000 results. * pageSize: 'placeholder-value', - * // Pagination token, which can be used to request a specific page - * // of `ListTransferLogsRequest` list results. For multiple-page - * // results, `ListTransferLogsResponse` outputs - * // a `next_page` token, which can be used as the - * // `page_token` value to request the next page of list results. + * // Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. * pageToken: 'placeholder-value', - * // Required. Transfer run name in the form: - * // `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or - * // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` + * // Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` * parent: * 'projects/my-project/transferConfigs/my-transferConfig/runs/my-run', * } diff --git a/src/apis/cloudasset/v1.ts b/src/apis/cloudasset/v1.ts index c77c23e889..8ac6f5be87 100644 --- a/src/apis/cloudasset/v1.ts +++ b/src/apis/cloudasset/v1.ts @@ -326,7 +326,7 @@ export namespace cloudasset_v1 { */ assetTypes?: string[] | null; /** - * A condition which determines whether an asset update should be published. If specified, an asset will be returned only when the expression evaluates to true. When set, `expression` field in the `Expr` must be a valid [CEL expression] (https://github.com/google/cel-spec) on a TemporalAsset with name `temporal_asset`. Example: a Feed with expression ("temporal_asset.deleted == true") will only publish Asset deletions. Other fields of `Expr` are optional. + * A condition which determines whether an asset update should be published. If specified, an asset will be returned only when the expression evaluates to true. When set, `expression` field in the `Expr` must be a valid [CEL expression] (https://github.com/google/cel-spec) on a TemporalAsset with name `temporal_asset`. Example: a Feed with expression ("temporal_asset.deleted == true") will only publish Asset deletions. Other fields of `Expr` are optional. See our [user guide](https://cloud.google.com/asset-inventory/docs/monitoring-asset-changes#feed_with_condition) for detailed instructions. */ condition?: Schema$Expr; /** @@ -637,7 +637,7 @@ export namespace cloudasset_v1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices { /** - * The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. + * The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter. */ allowedServices?: string[] | null; /** diff --git a/src/apis/cloudasset/v1beta1.ts b/src/apis/cloudasset/v1beta1.ts index 7f284f4fe0..d9da6a5977 100644 --- a/src/apis/cloudasset/v1beta1.ts +++ b/src/apis/cloudasset/v1beta1.ts @@ -548,7 +548,7 @@ export namespace cloudasset_v1beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices { /** - * The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. + * The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter. */ allowedServices?: string[] | null; /** diff --git a/src/apis/cloudasset/v1p5beta1.ts b/src/apis/cloudasset/v1p5beta1.ts index 0da23ba9f9..a1e2ba3d98 100644 --- a/src/apis/cloudasset/v1p5beta1.ts +++ b/src/apis/cloudasset/v1p5beta1.ts @@ -505,7 +505,7 @@ export namespace cloudasset_v1p5beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices { /** - * The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. + * The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter. */ allowedServices?: string[] | null; /** diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index e009358bf1..9f2a088a6e 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -134,7 +134,7 @@ export namespace cloudbuild_v1 { */ export interface Schema$ArtifactObjects { /** - * Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. + * Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. */ location?: string | null; /** @@ -164,16 +164,16 @@ export namespace cloudbuild_v1 { */ export interface Schema$Artifacts { /** - * A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. + * A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. */ images?: string[] | null; /** - * A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. + * A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. */ objects?: Schema$ArtifactObjects; } /** - * A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. + * A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. */ export interface Schema$Build { /** @@ -189,7 +189,7 @@ export namespace cloudbuild_v1 { */ createTime?: string | null; /** - * Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. + * Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. */ finishTime?: string | null; /** @@ -197,7 +197,7 @@ export namespace cloudbuild_v1 { */ id?: string | null; /** - * A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. + * A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. */ images?: string[] | null; /** @@ -217,7 +217,7 @@ export namespace cloudbuild_v1 { */ projectId?: string | null; /** - * TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time. + * TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time. */ queueTtl?: string | null; /** @@ -261,11 +261,11 @@ export namespace cloudbuild_v1 { */ tags?: string[] | null; /** - * Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is ten minutes. + * Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is ten minutes. */ timeout?: string | null; /** - * Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. + * Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. */ timing?: {[key: string]: Schema$TimeSpan} | null; } @@ -287,11 +287,11 @@ export namespace cloudbuild_v1 { */ diskSizeGb?: string | null; /** - * Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + * Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. */ dynamicSubstitutions?: boolean | null; /** - * A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". + * A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ env?: string[] | null; /** @@ -319,15 +319,15 @@ export namespace cloudbuild_v1 { */ sourceProvenanceHash?: string[] | null; /** - * Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. + * Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. */ substitutionOption?: string | null; /** - * Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. + * Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. */ volumes?: Schema$Volume[]; /** - * Option to specify a `WorkerPool` for the build. Format: projects/{project}/workerPools/{workerPool} This field is experimental. + * Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is experimental. */ workerPool?: string | null; } @@ -336,11 +336,11 @@ export namespace cloudbuild_v1 { */ export interface Schema$BuildStep { /** - * A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. + * A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. */ args?: string[] | null; /** - * Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. + * Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. */ dir?: string | null; /** @@ -348,7 +348,7 @@ export namespace cloudbuild_v1 { */ entrypoint?: string | null; /** - * A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". + * A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ env?: string[] | null; /** @@ -356,7 +356,7 @@ export namespace cloudbuild_v1 { */ id?: string | null; /** - * Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. + * Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. */ name?: string | null; /** @@ -380,7 +380,7 @@ export namespace cloudbuild_v1 { */ timing?: Schema$TimeSpan; /** - * List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. + * List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. */ volumes?: Schema$Volume[]; /** @@ -413,7 +413,7 @@ export namespace cloudbuild_v1 { */ filename?: string | null; /** - * GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`. + * GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`. */ github?: Schema$GitHubEventsConfig; /** @@ -421,15 +421,15 @@ export namespace cloudbuild_v1 { */ id?: string | null; /** - * ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build. + * ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build. */ ignoredFiles?: string[] | null; /** - * If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build. + * If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build. */ includedFiles?: string[] | null; /** - * User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. + * User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. */ name?: string | null; /** @@ -441,7 +441,7 @@ export namespace cloudbuild_v1 { */ tags?: string[] | null; /** - * Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. Mutually exclusive with `github`. + * Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. Mutually exclusive with `github`. */ triggerTemplate?: Schema$RepoSource; } @@ -471,7 +471,7 @@ export namespace cloudbuild_v1 { */ export interface Schema$CancelOperationRequest {} /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -484,7 +484,7 @@ export namespace cloudbuild_v1 { fileHash?: Schema$Hash[]; } /** - * GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental. + * GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental. */ export interface Schema$GitHubEventsConfig { /** @@ -611,7 +611,7 @@ export namespace cloudbuild_v1 { */ name?: string | null; /** - * The string representing the name and version of notifier to deploy. Expected to be of the form of "<registry-path>/<name>:<version>". For example: "gcr.io/my-project/notifiers/smtp:1.2.34". + * The string representing the name and version of notifier to deploy. Expected to be of the form of "/:". For example: "gcr.io/my-project/notifiers/smtp:1.2.34". */ notifier?: string | null; } @@ -663,7 +663,7 @@ export namespace cloudbuild_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any} | null; /** @@ -671,7 +671,7 @@ export namespace cloudbuild_v1 { */ name?: string | null; /** - * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any} | null; } @@ -680,7 +680,7 @@ export namespace cloudbuild_v1 { */ export interface Schema$PullRequestFilter { /** - * Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax + * Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ branch?: string | null; /** @@ -697,7 +697,7 @@ export namespace cloudbuild_v1 { */ export interface Schema$PushFilter { /** - * Regexes matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax + * Regexes matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ branch?: string | null; /** @@ -705,7 +705,7 @@ export namespace cloudbuild_v1 { */ invertRegex?: boolean | null; /** - * Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax + * Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ tag?: string | null; } @@ -714,7 +714,7 @@ export namespace cloudbuild_v1 { */ export interface Schema$RepoSource { /** - * Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax + * Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ branchName?: string | null; /** @@ -722,7 +722,7 @@ export namespace cloudbuild_v1 { */ commitSha?: string | null; /** - * Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. + * Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. */ dir?: string | null; /** @@ -742,7 +742,7 @@ export namespace cloudbuild_v1 { */ substitutions?: {[key: string]: string} | null; /** - * Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax + * Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ tagName?: string | null; } @@ -763,7 +763,7 @@ export namespace cloudbuild_v1 { */ buildStepImages?: string[] | null; /** - * List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored. + * List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored. */ buildStepOutputs?: string[] | null; /** @@ -788,7 +788,7 @@ export namespace cloudbuild_v1 { */ kmsKeyName?: string | null; /** - * Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. + * Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. */ secretEnv?: {[key: string]: string} | null; } @@ -848,7 +848,7 @@ export namespace cloudbuild_v1 { */ export interface Schema$SourceProvenance { /** - * Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. + * Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. */ fileHashes?: {[key: string]: Schema$FileHashes} | null; /** @@ -861,7 +861,7 @@ export namespace cloudbuild_v1 { resolvedStorageSource?: Schema$StorageSource; } /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -869,7 +869,7 @@ export namespace cloudbuild_v1 { */ code?: number | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}> | null; /** @@ -890,7 +890,7 @@ export namespace cloudbuild_v1 { */ generation?: string | null; /** - * Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. + * Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. */ object?: string | null; } @@ -912,11 +912,11 @@ export namespace cloudbuild_v1 { */ export interface Schema$Volume { /** - * Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. + * Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. */ name?: string | null; /** - * Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. + * Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. */ path?: string | null; } @@ -929,7 +929,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @example * // Before running the sample: * // - Enable the API at: @@ -1062,7 +1062,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * // Before running the sample: * // - Enable the API at: @@ -1394,7 +1394,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.builds.create - * @desc Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). + * @desc Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). * @example * // Before running the sample: * // - Enable the API at: @@ -1560,7 +1560,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.builds.get - * @desc Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. + * @desc Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. * @example * // Before running the sample: * // - Enable the API at: @@ -1716,7 +1716,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.builds.list - * @desc Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. + * @desc Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. * @example * // Before running the sample: * // - Enable the API at: @@ -1860,7 +1860,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.builds.retry - * @desc 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. + * @desc 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. * @example * // Before running the sample: * // - Enable the API at: @@ -2097,7 +2097,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.locations.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @example * // Before running the sample: * // - Enable the API at: @@ -2230,7 +2230,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.locations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * // Before running the sample: * // - Enable the API at: @@ -2389,7 +2389,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.triggers.create - * @desc Creates a new `BuildTrigger`. This API is experimental. + * @desc Creates a new `BuildTrigger`. This API is experimental. * @example * // Before running the sample: * // - Enable the API at: @@ -2553,7 +2553,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.triggers.delete - * @desc Deletes a `BuildTrigger` by its project ID and trigger ID. This API is experimental. + * @desc Deletes a `BuildTrigger` by its project ID and trigger ID. This API is experimental. * @example * // Before running the sample: * // - Enable the API at: @@ -2684,7 +2684,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.triggers.get - * @desc Returns information about a `BuildTrigger`. This API is experimental. + * @desc Returns information about a `BuildTrigger`. This API is experimental. * @example * // Before running the sample: * // - Enable the API at: @@ -2829,7 +2829,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.triggers.list - * @desc Lists existing `BuildTrigger`s. This API is experimental. + * @desc Lists existing `BuildTrigger`s. This API is experimental. * @example * // Before running the sample: * // - Enable the API at: @@ -2974,7 +2974,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.triggers.patch - * @desc Updates a `BuildTrigger` by its project ID and trigger ID. This API is experimental. + * @desc Updates a `BuildTrigger` by its project ID and trigger ID. This API is experimental. * @example * // Before running the sample: * // - Enable the API at: diff --git a/src/apis/cloudbuild/v1alpha1.ts b/src/apis/cloudbuild/v1alpha1.ts index 5e73c46e81..66bb064aaf 100644 --- a/src/apis/cloudbuild/v1alpha1.ts +++ b/src/apis/cloudbuild/v1alpha1.ts @@ -132,7 +132,7 @@ export namespace cloudbuild_v1alpha1 { */ export interface Schema$ArtifactObjects { /** - * Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. + * Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. */ location?: string | null; /** @@ -162,16 +162,16 @@ export namespace cloudbuild_v1alpha1 { */ export interface Schema$Artifacts { /** - * A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. + * A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. */ images?: string[] | null; /** - * A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. + * A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. */ objects?: Schema$ArtifactObjects; } /** - * A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. + * A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. */ export interface Schema$Build { /** @@ -187,7 +187,7 @@ export namespace cloudbuild_v1alpha1 { */ createTime?: string | null; /** - * Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. + * Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. */ finishTime?: string | null; /** @@ -195,7 +195,7 @@ export namespace cloudbuild_v1alpha1 { */ id?: string | null; /** - * A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. + * A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. */ images?: string[] | null; /** @@ -215,7 +215,7 @@ export namespace cloudbuild_v1alpha1 { */ projectId?: string | null; /** - * TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time. + * TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time. */ queueTtl?: string | null; /** @@ -259,11 +259,11 @@ export namespace cloudbuild_v1alpha1 { */ tags?: string[] | null; /** - * Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is ten minutes. + * Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is ten minutes. */ timeout?: string | null; /** - * Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. + * Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. */ timing?: {[key: string]: Schema$TimeSpan} | null; } @@ -285,11 +285,11 @@ export namespace cloudbuild_v1alpha1 { */ diskSizeGb?: string | null; /** - * Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + * Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. */ dynamicSubstitutions?: boolean | null; /** - * A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". + * A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ env?: string[] | null; /** @@ -317,15 +317,15 @@ export namespace cloudbuild_v1alpha1 { */ sourceProvenanceHash?: string[] | null; /** - * Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. + * Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. */ substitutionOption?: string | null; /** - * Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. + * Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. */ volumes?: Schema$Volume[]; /** - * Option to specify a `WorkerPool` for the build. Format: projects/{project}/workerPools/{workerPool} This field is experimental. + * Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is experimental. */ workerPool?: string | null; } @@ -334,11 +334,11 @@ export namespace cloudbuild_v1alpha1 { */ export interface Schema$BuildStep { /** - * A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. + * A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. */ args?: string[] | null; /** - * Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. + * Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. */ dir?: string | null; /** @@ -346,7 +346,7 @@ export namespace cloudbuild_v1alpha1 { */ entrypoint?: string | null; /** - * A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". + * A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ env?: string[] | null; /** @@ -354,7 +354,7 @@ export namespace cloudbuild_v1alpha1 { */ id?: string | null; /** - * Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. + * Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. */ name?: string | null; /** @@ -378,7 +378,7 @@ export namespace cloudbuild_v1alpha1 { */ timing?: Schema$TimeSpan; /** - * List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. + * List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. */ volumes?: Schema$Volume[]; /** @@ -408,7 +408,7 @@ export namespace cloudbuild_v1alpha1 { */ export interface Schema$CancelOperationRequest {} /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -523,7 +523,7 @@ export namespace cloudbuild_v1alpha1 { */ name?: string | null; /** - * The string representing the name and version of notifier to deploy. Expected to be of the form of "<registry-path>/<name>:<version>". For example: "gcr.io/my-project/notifiers/smtp:1.2.34". + * The string representing the name and version of notifier to deploy. Expected to be of the form of "/:". For example: "gcr.io/my-project/notifiers/smtp:1.2.34". */ notifier?: string | null; } @@ -575,7 +575,7 @@ export namespace cloudbuild_v1alpha1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any} | null; /** @@ -583,7 +583,7 @@ export namespace cloudbuild_v1alpha1 { */ name?: string | null; /** - * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any} | null; } @@ -592,7 +592,7 @@ export namespace cloudbuild_v1alpha1 { */ export interface Schema$RepoSource { /** - * Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax + * Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ branchName?: string | null; /** @@ -600,7 +600,7 @@ export namespace cloudbuild_v1alpha1 { */ commitSha?: string | null; /** - * Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. + * Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. */ dir?: string | null; /** @@ -620,7 +620,7 @@ export namespace cloudbuild_v1alpha1 { */ substitutions?: {[key: string]: string} | null; /** - * Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax + * Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ tagName?: string | null; } @@ -641,7 +641,7 @@ export namespace cloudbuild_v1alpha1 { */ buildStepImages?: string[] | null; /** - * List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored. + * List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored. */ buildStepOutputs?: string[] | null; /** @@ -662,7 +662,7 @@ export namespace cloudbuild_v1alpha1 { */ kmsKeyName?: string | null; /** - * Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. + * Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. */ secretEnv?: {[key: string]: string} | null; } @@ -722,7 +722,7 @@ export namespace cloudbuild_v1alpha1 { */ export interface Schema$SourceProvenance { /** - * Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. + * Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. */ fileHashes?: {[key: string]: Schema$FileHashes} | null; /** @@ -735,7 +735,7 @@ export namespace cloudbuild_v1alpha1 { resolvedStorageSource?: Schema$StorageSource; } /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -743,7 +743,7 @@ export namespace cloudbuild_v1alpha1 { */ code?: number | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}> | null; /** @@ -764,7 +764,7 @@ export namespace cloudbuild_v1alpha1 { */ generation?: string | null; /** - * Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. + * Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. */ object?: string | null; } @@ -786,11 +786,11 @@ export namespace cloudbuild_v1alpha1 { */ export interface Schema$Volume { /** - * Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. + * Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. */ name?: string | null; /** - * Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. + * Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. */ path?: string | null; } @@ -816,7 +816,7 @@ export namespace cloudbuild_v1alpha1 { tag?: string | null; } /** - * Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool. + * Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool. */ export interface Schema$WorkerPool { /** @@ -891,7 +891,7 @@ export namespace cloudbuild_v1alpha1 { /** * cloudbuild.projects.locations.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @example * // Before running the sample: * // - Enable the API at: @@ -1027,7 +1027,7 @@ export namespace cloudbuild_v1alpha1 { /** * cloudbuild.projects.locations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * // Before running the sample: * // - Enable the API at: @@ -1369,8 +1369,7 @@ export namespace cloudbuild_v1alpha1 { * * // Do the magic * const res = await cloudbuild.projects.workerPools.delete({ - * // The field will contain name of the resource requested, for example: - * // "projects/project-1/workerPools/workerpool-name" + * // The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name" * name: 'projects/my-project/workerPools/my-workerPool', * }); * console.log(res.data); @@ -1496,8 +1495,7 @@ export namespace cloudbuild_v1alpha1 { * * // Do the magic * const res = await cloudbuild.projects.workerPools.get({ - * // The field will contain name of the resource requested, for example: - * // "projects/project-1/workerPools/workerpool-name" + * // The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name" * name: 'projects/my-project/workerPools/my-workerPool', * }); * console.log(res.data); @@ -1770,8 +1768,7 @@ export namespace cloudbuild_v1alpha1 { * * // Do the magic * const res = await cloudbuild.projects.workerPools.patch({ - * // The field will contain name of the resource requested, for example: - * // "projects/project-1/workerPools/workerpool-name" + * // The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name" * name: 'projects/my-project/workerPools/my-workerPool', * * // Request body metadata diff --git a/src/apis/cloudbuild/v1alpha2.ts b/src/apis/cloudbuild/v1alpha2.ts index 25829ecfa4..280e77fcb1 100644 --- a/src/apis/cloudbuild/v1alpha2.ts +++ b/src/apis/cloudbuild/v1alpha2.ts @@ -132,7 +132,7 @@ export namespace cloudbuild_v1alpha2 { */ export interface Schema$ArtifactObjects { /** - * Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. + * Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. */ location?: string | null; /** @@ -162,16 +162,16 @@ export namespace cloudbuild_v1alpha2 { */ export interface Schema$Artifacts { /** - * A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. + * A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. */ images?: string[] | null; /** - * A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. + * A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. */ objects?: Schema$ArtifactObjects; } /** - * A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. + * A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. */ export interface Schema$Build { /** @@ -187,7 +187,7 @@ export namespace cloudbuild_v1alpha2 { */ createTime?: string | null; /** - * Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. + * Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. */ finishTime?: string | null; /** @@ -195,7 +195,7 @@ export namespace cloudbuild_v1alpha2 { */ id?: string | null; /** - * A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. + * A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. */ images?: string[] | null; /** @@ -215,7 +215,7 @@ export namespace cloudbuild_v1alpha2 { */ projectId?: string | null; /** - * TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time. + * TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time. */ queueTtl?: string | null; /** @@ -259,11 +259,11 @@ export namespace cloudbuild_v1alpha2 { */ tags?: string[] | null; /** - * Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is ten minutes. + * Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is ten minutes. */ timeout?: string | null; /** - * Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. + * Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. */ timing?: {[key: string]: Schema$TimeSpan} | null; } @@ -285,11 +285,11 @@ export namespace cloudbuild_v1alpha2 { */ diskSizeGb?: string | null; /** - * Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + * Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. */ dynamicSubstitutions?: boolean | null; /** - * A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". + * A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ env?: string[] | null; /** @@ -317,15 +317,15 @@ export namespace cloudbuild_v1alpha2 { */ sourceProvenanceHash?: string[] | null; /** - * Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. + * Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. */ substitutionOption?: string | null; /** - * Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. + * Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. */ volumes?: Schema$Volume[]; /** - * Option to specify a `WorkerPool` for the build. Format: projects/{project}/workerPools/{workerPool} This field is experimental. + * Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is experimental. */ workerPool?: string | null; } @@ -334,11 +334,11 @@ export namespace cloudbuild_v1alpha2 { */ export interface Schema$BuildStep { /** - * A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. + * A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. */ args?: string[] | null; /** - * Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. + * Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. */ dir?: string | null; /** @@ -346,7 +346,7 @@ export namespace cloudbuild_v1alpha2 { */ entrypoint?: string | null; /** - * A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". + * A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ env?: string[] | null; /** @@ -354,7 +354,7 @@ export namespace cloudbuild_v1alpha2 { */ id?: string | null; /** - * Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. + * Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. */ name?: string | null; /** @@ -378,7 +378,7 @@ export namespace cloudbuild_v1alpha2 { */ timing?: Schema$TimeSpan; /** - * List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. + * List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. */ volumes?: Schema$Volume[]; /** @@ -408,7 +408,7 @@ export namespace cloudbuild_v1alpha2 { */ export interface Schema$CancelOperationRequest {} /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -515,7 +515,7 @@ export namespace cloudbuild_v1alpha2 { */ name?: string | null; /** - * The string representing the name and version of notifier to deploy. Expected to be of the form of "<registry-path>/<name>:<version>". For example: "gcr.io/my-project/notifiers/smtp:1.2.34". + * The string representing the name and version of notifier to deploy. Expected to be of the form of "/:". For example: "gcr.io/my-project/notifiers/smtp:1.2.34". */ notifier?: string | null; } @@ -567,7 +567,7 @@ export namespace cloudbuild_v1alpha2 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any} | null; /** @@ -575,7 +575,7 @@ export namespace cloudbuild_v1alpha2 { */ name?: string | null; /** - * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any} | null; } @@ -584,7 +584,7 @@ export namespace cloudbuild_v1alpha2 { */ export interface Schema$RepoSource { /** - * Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax + * Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ branchName?: string | null; /** @@ -592,7 +592,7 @@ export namespace cloudbuild_v1alpha2 { */ commitSha?: string | null; /** - * Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. + * Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. */ dir?: string | null; /** @@ -612,7 +612,7 @@ export namespace cloudbuild_v1alpha2 { */ substitutions?: {[key: string]: string} | null; /** - * Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax + * Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ tagName?: string | null; } @@ -633,7 +633,7 @@ export namespace cloudbuild_v1alpha2 { */ buildStepImages?: string[] | null; /** - * List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored. + * List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored. */ buildStepOutputs?: string[] | null; /** @@ -654,7 +654,7 @@ export namespace cloudbuild_v1alpha2 { */ kmsKeyName?: string | null; /** - * Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. + * Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. */ secretEnv?: {[key: string]: string} | null; } @@ -714,7 +714,7 @@ export namespace cloudbuild_v1alpha2 { */ export interface Schema$SourceProvenance { /** - * Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. + * Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. */ fileHashes?: {[key: string]: Schema$FileHashes} | null; /** @@ -727,7 +727,7 @@ export namespace cloudbuild_v1alpha2 { resolvedStorageSource?: Schema$StorageSource; } /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -735,7 +735,7 @@ export namespace cloudbuild_v1alpha2 { */ code?: number | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}> | null; /** @@ -756,7 +756,7 @@ export namespace cloudbuild_v1alpha2 { */ generation?: string | null; /** - * Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. + * Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. */ object?: string | null; } @@ -778,11 +778,11 @@ export namespace cloudbuild_v1alpha2 { */ export interface Schema$Volume { /** - * Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. + * Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. */ name?: string | null; /** - * Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. + * Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. */ path?: string | null; } @@ -800,7 +800,7 @@ export namespace cloudbuild_v1alpha2 { machineType?: string | null; } /** - * Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool. + * Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool. */ export interface Schema$WorkerPool { /** @@ -820,7 +820,7 @@ export namespace cloudbuild_v1alpha2 { */ networkConfig?: Schema$NetworkConfig; /** - * Required. Immutable. The region where the `WorkerPool` runs. Only "us-central1" is currently supported. Note that `region` cannot be changed once the `WorkerPool` is created. + * Required. Immutable. The region where the `WorkerPool` runs. Only "us-central1" is currently supported. Note that `region` cannot be changed once the `WorkerPool` is created. */ region?: string | null; /** @@ -867,7 +867,7 @@ export namespace cloudbuild_v1alpha2 { /** * cloudbuild.projects.locations.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @example * // Before running the sample: * // - Enable the API at: @@ -1003,7 +1003,7 @@ export namespace cloudbuild_v1alpha2 { /** * cloudbuild.projects.locations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * // Before running the sample: * // - Enable the API at: @@ -1187,14 +1187,9 @@ export namespace cloudbuild_v1alpha2 { * * // Do the magic * const res = await cloudbuild.projects.workerPools.create({ - * // Required. The parent resource where this book will be created. - * // Format: projects/{project} + * // Required. The parent resource where this book will be created. Format: projects/{project} * parent: 'projects/my-project', - * // Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component - * // of the resource name. - * // - * // This value should be 1-63 characters, and valid characters - * // are /a-z-/. + * // Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/. * workerPoolId: 'placeholder-value', * * // Request body metadata @@ -1237,7 +1232,7 @@ export namespace cloudbuild_v1alpha2 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The parent resource where this book will be created. Format: projects/{project} - * @param {string=} params.workerPoolId Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/. + * @param {string=} params.workerPoolId Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/. * @param {().WorkerPool} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1349,8 +1344,7 @@ export namespace cloudbuild_v1alpha2 { * * // Do the magic * const res = await cloudbuild.projects.workerPools.delete({ - * // Required. The name of the `WorkerPool` to delete. - * // Format: projects/{project}/workerPools/{workerPool} + * // Required. The name of the `WorkerPool` to delete. Format: projects/{project}/workerPools/{workerPool} * name: 'projects/my-project/workerPools/my-workerPool', * }); * console.log(res.data); @@ -1476,8 +1470,7 @@ export namespace cloudbuild_v1alpha2 { * * // Do the magic * const res = await cloudbuild.projects.workerPools.get({ - * // Required. The name of the `WorkerPool` to retrieve. - * // Format: projects/{project}/workerPools/{workerPool} + * // Required. The name of the `WorkerPool` to retrieve. Format: projects/{project}/workerPools/{workerPool} * name: 'projects/my-project/workerPools/my-workerPool', * }); * console.log(res.data); @@ -1612,8 +1605,7 @@ export namespace cloudbuild_v1alpha2 { * * // Do the magic * const res = await cloudbuild.projects.workerPools.list({ - * // Required. The parent, which owns this collection of `WorkerPools`. - * // Format: projects/{project} + * // Required. The parent, which owns this collection of `WorkerPools`. Format: projects/{project} * parent: 'projects/my-project', * }); * console.log(res.data); @@ -1749,10 +1741,7 @@ export namespace cloudbuild_v1alpha2 { * * // Do the magic * const res = await cloudbuild.projects.workerPools.patch({ - * // Output only. The resource name of the `WorkerPool`. - * // Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`, - * // where the value of {worker_pool_id} is provided in the CreateWorkerPool - * // request. + * // Output only. The resource name of the `WorkerPool`. Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`, where the value of {worker_pool_id} is provided in the CreateWorkerPool request. * name: 'projects/my-project/workerPools/my-workerPool', * // A mask specifying which fields in `WorkerPool` should be updated. * updateMask: 'placeholder-value', @@ -1887,7 +1876,7 @@ export namespace cloudbuild_v1alpha2 { */ parent?: string; /** - * Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/. + * Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/. */ workerPoolId?: string; diff --git a/src/apis/cloudfunctions/README.md b/src/apis/cloudfunctions/README.md index 8b3e7796e4..5b3f1289a4 100644 --- a/src/apis/cloudfunctions/README.md +++ b/src/apis/cloudfunctions/README.md @@ -4,6 +4,15 @@ > Manages lightweight user-provided functions executed in response to events. +## Support status +**Note**: Google provides multiple libraries for this service. This library is in +maintenance mode, and will continue to be made available for users who have +existing applications. If you're building a new application, or modernizing a +legacy application, please use [@google-cloud/functions](https://www.npmjs.com/package/@google-cloud/functions) instead. +The [@google-cloud/functions](https://www.npmjs.com/package/@google-cloud/functions) library is faster, easier to use, and better maintained. + +To learn more, see [Client Libraries Explained](https://cloud.google.com/apis/docs/client-libraries-explained). + ## Installation ```sh diff --git a/src/apis/cloudshell/v1.ts b/src/apis/cloudshell/v1.ts index 15ac4a27ff..a15005ec7f 100644 --- a/src/apis/cloudshell/v1.ts +++ b/src/apis/cloudshell/v1.ts @@ -132,62 +132,9 @@ export namespace cloudshell_v1 { */ export interface Schema$CancelOperationRequest {} /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} - /** - * A Cloud Shell environment, which is defined as the combination of a Docker image specifying what is installed on the environment and a home directory containing the user's data that will remain across sessions. Each user has a single environment with the ID "default". - */ - export interface Schema$Environment { - /** - * Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest". - */ - dockerImage?: string | null; - /** - * Output only. The environment's identifier, unique among the user's environments. - */ - id?: string | null; - /** - * Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the email address of the user to whom this environment belongs, and `{environment_id}` is the identifier of this environment. For example, `users/someone@example.com/environments/default`. - */ - name?: string | null; - /** - * Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the CreatePublicKey and DeletePublicKey methods. - */ - publicKeys?: Schema$PublicKey[]; - /** - * Indicates the size of the backing VM running the environment. If set to something other than DEFAULT, it will be reverted to the default VM size after vm_size_expire_time. - */ - size?: string | null; - /** - * Output only. Host to which clients can connect to initiate SSH sessions with the environment. - */ - sshHost?: string | null; - /** - * Output only. Port to which clients can connect to initiate SSH sessions with the environment. - */ - sshPort?: number | null; - /** - * Output only. Username that clients should use when initiating SSH sessions with the environment. - */ - sshUsername?: string | null; - /** - * Output only. Current execution state of this environment. - */ - state?: string | null; - /** - * Output only. The time when the Environment will expire back to the default VM size. - */ - vmSizeExpireTime?: string | null; - /** - * Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment. - */ - webHost?: string | null; - /** - * Output only. Ports to which clients can connect to initiate HTTPS or WSS connections with the environment. - */ - webPorts?: number[] | null; - } /** * The response message for Operations.ListOperations. */ @@ -214,7 +161,7 @@ export namespace cloudshell_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any} | null; /** @@ -222,47 +169,12 @@ export namespace cloudshell_v1 { */ name?: string | null; /** - * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any} | null; } /** - * A public SSH key, corresponding to a private SSH key held by the client. - */ - export interface Schema$PublicKey { - /** - * Required. Format of this key's content. - */ - format?: string | null; - /** - * Required. Content of this key. - */ - key?: string | null; - /** - * Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. `{owner_email}` is the email address of the user to whom the key belongs. `{environment_id}` is the identifier of the environment to which the key grants access. `{key_id}` is the unique identifier of the key. For example, `users/someone@example.com/environments/default/publicKeys/myKey`. - */ - name?: string | null; - } - /** - * Message included in the metadata field of operations returned from StartEnvironment. - */ - export interface Schema$StartEnvironmentMetadata { - /** - * Current state of the environment being started. - */ - state?: string | null; - } - /** - * Message included in the response field of operations returned from StartEnvironment once the operation is complete. - */ - export interface Schema$StartEnvironmentResponse { - /** - * Environment that was started. - */ - environment?: Schema$Environment; - } - /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -270,7 +182,7 @@ export namespace cloudshell_v1 { */ code?: number | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}> | null; /** @@ -287,7 +199,7 @@ export namespace cloudshell_v1 { /** * cloudshell.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @example * // Before running the sample: * // - Enable the API at: @@ -546,7 +458,7 @@ export namespace cloudshell_v1 { /** * cloudshell.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * // Before running the sample: * // - Enable the API at: @@ -677,7 +589,7 @@ export namespace cloudshell_v1 { /** * cloudshell.operations.list - * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @example * // Before running the sample: * // - Enable the API at: diff --git a/src/apis/cloudshell/v1alpha1.ts b/src/apis/cloudshell/v1alpha1.ts index c185be9fdb..45b49a4951 100644 --- a/src/apis/cloudshell/v1alpha1.ts +++ b/src/apis/cloudshell/v1alpha1.ts @@ -154,7 +154,7 @@ export namespace cloudshell_v1alpha1 { key?: Schema$PublicKey; } /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -178,7 +178,7 @@ export namespace cloudshell_v1alpha1 { */ publicKeys?: Schema$PublicKey[]; /** - * Indicates the size of the backing VM running the environment. If set to something other than DEFAULT, it will be reverted to the default VM size after vm_size_expire_time. + * Indicates the size of the backing VM running the environment. If set to something other than DEFAULT, it will be reverted to the default VM size after vm_size_expire_time. */ size?: string | null; /** @@ -223,7 +223,7 @@ export namespace cloudshell_v1alpha1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any} | null; /** @@ -231,7 +231,7 @@ export namespace cloudshell_v1alpha1 { */ name?: string | null; /** - * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any} | null; } @@ -284,7 +284,7 @@ export namespace cloudshell_v1alpha1 { environment?: Schema$Environment; } /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -292,7 +292,7 @@ export namespace cloudshell_v1alpha1 { */ code?: number | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}> | null; /** @@ -347,9 +347,7 @@ export namespace cloudshell_v1alpha1 { * * // Do the magic * const res = await cloudshell.users.environments.authorize({ - * // Name of the resource that should receive the credentials, for example - * // `users/me/environments/default` or - * // `users/someone@example.com/environments/default`. + * // Name of the resource that should receive the credentials, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. * name: 'users/my-user/environments/my-environment', * * // Request body metadata @@ -489,8 +487,7 @@ export namespace cloudshell_v1alpha1 { * * // Do the magic * const res = await cloudshell.users.environments.get({ - * // Name of the requested resource, for example `users/me/environments/default` - * // or `users/someone@example.com/environments/default`. + * // Name of the requested resource, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. * name: 'users/my-user/environments/my-environment', * }); * console.log(res.data); @@ -629,9 +626,7 @@ export namespace cloudshell_v1alpha1 { * * // Do the magic * const res = await cloudshell.users.environments.patch({ - * // Name of the resource to be updated, for example - * // `users/me/environments/default` or - * // `users/someone@example.com/environments/default`. + * // Name of the resource to be updated, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. * name: 'users/my-user/environments/my-environment', * // Mask specifying which fields in the environment should be updated. * updateMask: 'placeholder-value', @@ -793,9 +788,7 @@ export namespace cloudshell_v1alpha1 { * * // Do the magic * const res = await cloudshell.users.environments.start({ - * // Name of the resource that should be started, for example - * // `users/me/environments/default` or - * // `users/someone@example.com/environments/default`. + * // Name of the resource that should be started, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. * name: 'users/my-user/environments/my-environment', * * // Request body metadata @@ -1137,8 +1130,7 @@ export namespace cloudshell_v1alpha1 { * * // Do the magic * const res = await cloudshell.users.environments.publicKeys.delete({ - * // Name of the resource to be deleted, e.g. - * // `users/me/environments/default/publicKeys/my-key`. + * // Name of the resource to be deleted, e.g. `users/me/environments/default/publicKeys/my-key`. * name: 'users/my-user/environments/my-environment/publicKeys/my-publicKey', * }); * console.log(res.data); diff --git a/src/apis/dataproc/v1beta2.ts b/src/apis/dataproc/v1beta2.ts index 8baa62a4ea..cd300070fa 100644 --- a/src/apis/dataproc/v1beta2.ts +++ b/src/apis/dataproc/v1beta2.ts @@ -307,6 +307,10 @@ export namespace dataproc_v1beta2 { * Optional. The Compute Engine config settings for the master instance in a cluster. */ masterConfig?: Schema$InstanceGroupConfig; + /** + * Optional. Metastore configuration. + */ + metastoreConfig?: Schema$MetastoreConfig; /** * Optional. The Compute Engine config settings for additional worker instances in a cluster. */ @@ -1096,6 +1100,15 @@ export namespace dataproc_v1beta2 { */ instanceTemplateName?: string | null; } + /** + * Specifies the metastore configuration. + */ + export interface Schema$MetastoreConfig { + /** + * Optional. Relative resource name of an existing Dataproc Metastore service. + */ + dataprocMetastoreService?: string | null; + } /** * A full, namespace-isolated deployment target for an existing GKE cluster. */ diff --git a/src/apis/doubleclickbidmanager/v1.1.ts b/src/apis/doubleclickbidmanager/v1.1.ts index 1b6a050679..c30a4f0b6d 100644 --- a/src/apis/doubleclickbidmanager/v1.1.ts +++ b/src/apis/doubleclickbidmanager/v1.1.ts @@ -133,6 +133,32 @@ export namespace doubleclickbidmanager_v1_1 { } } + /** + * A channel grouping defines a set of rules that can be used to categorize events in a path report. + */ + export interface Schema$ChannelGrouping { + /** + * The name to apply to an event that does not match any of the rules in the channel grouping. + */ + fallbackName?: string | null; + /** + * Channel Grouping name. + */ + name?: string | null; + /** + * Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping. + */ + rules?: Schema$Rule[]; + } + /** + * DisjunctiveMatchStatement that OR's all contained filters. + */ + export interface Schema$DisjunctiveMatchStatement { + /** + * Filters. There is a limit of 100 filters that can be set per disjunctive match statement. + */ + eventFilters?: Schema$EventFilter[]; + } /** * Request to fetch stored line items. */ @@ -210,6 +236,15 @@ export namespace doubleclickbidmanager_v1_1 { */ lineItems?: string | null; } + /** + * Defines the type of filter to be applied to the path, a DV360 event dimension filter. + */ + export interface Schema$EventFilter { + /** + * Filter on a dimension. + */ + dimensionFilter?: Schema$PathQueryOptionsFilter; + } /** * Filter used to match traffic data in your report. */ @@ -265,6 +300,10 @@ export namespace doubleclickbidmanager_v1_1 { * Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items. */ includeOnlyTargetedUserLists?: boolean | null; + /** + * Options that contain Path Filters and Custom Channel Groupings. + */ + pathQueryOptions?: Schema$PathQueryOptions; } /** * Parameters of a query or report. @@ -295,6 +334,49 @@ export namespace doubleclickbidmanager_v1_1 { */ type?: string | null; } + /** + * Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions.<br><br> When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded. + */ + export interface Schema$PathFilter { + /** + * Filter on an event to be applied to some part of the path. + */ + eventFilters?: Schema$EventFilter[]; + /** + * Indicates the position of the path the filter should match to (first, last, or any event in path). + */ + pathMatchPosition?: string | null; + } + /** + * Path Query Options for Report Options. + */ + export interface Schema$PathQueryOptions { + /** + * Custom Channel Groupings. + */ + channelGrouping?: Schema$ChannelGrouping; + /** + * Path Filters. There is a limit of 100 path filters that can be set per report. + */ + pathFilters?: Schema$PathFilter[]; + } + /** + * Dimension Filter for a Path Filter. + */ + export interface Schema$PathQueryOptionsFilter { + /** + * Dimension the filter is applied to. + */ + filter?: string | null; + /** + * Indicates how the filter should be matched to the value. + */ + match?: string | null; + /** + * Value to filter on. + */ + values?: string[] | null; + } /** * Represents a query. */ @@ -516,6 +598,16 @@ export namespace doubleclickbidmanager_v1_1 { */ rowNumber?: number | null; } + /** + * A Rule defines a name, and a boolean expression in [conjunctive normal form](http: //mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be // applied to a path event to determine if that name should be applied. + */ + export interface Schema$Rule { + disjunctiveMatchStatements?: Schema$DisjunctiveMatchStatement[]; + /** + * Rule name. + */ + name?: string | null; + } /** * Request to run a stored query to generate a report. */ diff --git a/src/apis/genomics/v1.ts b/src/apis/genomics/v1.ts index d49e677071..0591b2602e 100644 --- a/src/apis/genomics/v1.ts +++ b/src/apis/genomics/v1.ts @@ -191,7 +191,7 @@ export namespace genomics_v1 { */ exitStatus?: number | null; /** - * The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere. + * The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere. */ stderr?: string | null; } @@ -209,7 +209,7 @@ export namespace genomics_v1 { metrics?: string[] | null; } /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -272,7 +272,7 @@ export namespace genomics_v1 { */ metadata?: {[key: string]: any} | null; /** - * The server-assigned name, which is only unique within the same service that originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` + * The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` */ name?: string | null; /** @@ -370,7 +370,7 @@ export namespace genomics_v1 { computeEngine?: Schema$ComputeEngine; } /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -378,7 +378,7 @@ export namespace genomics_v1 { */ code?: number | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}> | null; /** @@ -438,7 +438,7 @@ export namespace genomics_v1 { /** * genomics.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel` + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel` * @example * // Before running the sample: * // - Enable the API at: @@ -574,7 +574,7 @@ export namespace genomics_v1 { /** * genomics.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get` + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get` * @example * // Before running the sample: * // - Enable the API at: @@ -708,7 +708,7 @@ export namespace genomics_v1 { /** * genomics.operations.list - * @desc Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list` + * @desc Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list` * @example * // Before running the sample: * // - Enable the API at: @@ -736,36 +736,7 @@ export namespace genomics_v1 { * * // Do the magic * const res = await genomics.operations.list({ - * // A string for filtering Operations. - * // In v2alpha1, the following filter fields are supported: - * // - * // * createTime: The time this job was created - * // * events: The set of event (names) that have occurred while running - * // the pipeline. The : operator can be used to determine if a - * // particular event has occurred. - * // * error: If the pipeline is running, this value is NULL. Once the - * // pipeline finishes, the value is the standard Google error code. - * // * labels.key or labels."key with space" where key is a label key. - * // * done: If the pipeline is running, this value is false. Once the - * // pipeline finishes, the value is true. - * // - * // In v1 and v1alpha2, the following filter fields are supported: - * // - * // * projectId: Required. Corresponds to - * // OperationMetadata.projectId. - * // * createTime: The time this job was created, in seconds from the - * // [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` - * // operators. - * // * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only - * // one status may be specified. - * // * labels.key where key is a label key. - * // - * // Examples: - * // - * // * `projectId = my-project AND createTime >= 1432140000` - * // * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` - * // * `projectId = my-project AND labels.color = *` - * // * `projectId = my-project AND labels.color = red` + * // A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` * filter: 'placeholder-value', * // The name of the operation's parent resource. * name: 'operations', @@ -792,7 +763,7 @@ export namespace genomics_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` + * @param {string=} params.filter A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` * @param {string} params.name The name of the operation's parent resource. * @param {integer=} params.pageSize The maximum number of results to return. The maximum value is 256. * @param {string=} params.pageToken The standard list page token. @@ -901,7 +872,7 @@ export namespace genomics_v1 { } export interface Params$Resource$Operations$List extends StandardParameters { /** - * A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` + * A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` */ filter?: string; /** diff --git a/src/apis/genomics/v1alpha2.ts b/src/apis/genomics/v1alpha2.ts index 63904c6c96..96a871fbc8 100644 --- a/src/apis/genomics/v1alpha2.ts +++ b/src/apis/genomics/v1alpha2.ts @@ -193,7 +193,7 @@ export namespace genomics_v1alpha2 { */ exitStatus?: number | null; /** - * The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere. + * The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere. */ stderr?: string | null; } @@ -261,7 +261,7 @@ export namespace genomics_v1alpha2 { */ export interface Schema$DockerExecutor { /** - * Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384. + * Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384. */ cmd?: string | null; /** @@ -270,7 +270,7 @@ export namespace genomics_v1alpha2 { imageName?: string | null; } /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -368,7 +368,7 @@ export namespace genomics_v1alpha2 { */ metadata?: {[key: string]: any} | null; /** - * The server-assigned name, which is only unique within the same service that originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` + * The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` */ name?: string | null; /** @@ -467,12 +467,12 @@ export namespace genomics_v1alpha2 { */ projectId?: string | null; /** - * Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb + * Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb */ resources?: Schema$PipelineResources; } /** - * Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: <table> <thead> <tr><th>Google Cloud storage path</th><th>Local path</th></tr> </thead> <tbody> <tr><td>file</td><td>file</td></tr> <tr><td>glob</td><td>directory</td></tr> </tbody> </table> For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are: <table> <thead> <tr><th>Local path</th><th>Google Cloud Storage path</th></tr> </thead> <tbody> <tr><td>file</td><td>file</td></tr> <tr> <td>file</td> <td>directory - directory must already exist</td> </tr> <tr> <td>glob</td> <td>directory - directory will be created if it doesn't exist</td></tr> </tbody> </table> One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file. + * Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path file file glob directory For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are: Local pathGoogle Cloud Storage path file file file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file. */ export interface Schema$PipelineParameter { /** @@ -521,7 +521,7 @@ export namespace genomics_v1alpha2 { */ minimumRamGb?: number | null; /** - * Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. Before using this, you must [configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips). + * Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. Before using this, you must [configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips). */ noAddress?: boolean | null; /** @@ -563,7 +563,7 @@ export namespace genomics_v1alpha2 { */ clientId?: string | null; /** - * Pipeline input arguments; keys are defined in the pipeline documentation. All input parameters that do not have default values must be specified. If parameters with defaults are specified here, the defaults will be overridden. + * Pipeline input arguments; keys are defined in the pipeline documentation. All input parameters that do not have default values must be specified. If parameters with defaults are specified here, the defaults will be overridden. */ inputs?: {[key: string]: string} | null; /** @@ -579,7 +579,7 @@ export namespace genomics_v1alpha2 { */ logging?: Schema$LoggingOptions; /** - * Pipeline output arguments; keys are defined in the pipeline documentation. All output parameters of without default values must be specified. If parameters with defaults are specified here, the defaults will be overridden. + * Pipeline output arguments; keys are defined in the pipeline documentation. All output parameters of without default values must be specified. If parameters with defaults are specified here, the defaults will be overridden. */ outputs?: {[key: string]: string} | null; /** @@ -634,7 +634,7 @@ export namespace genomics_v1alpha2 { */ email?: string | null; /** - * List of scopes to be enabled for this service account on the VM. The following scopes are automatically included: * https://www.googleapis.com/auth/compute * https://www.googleapis.com/auth/devstorage.full_control * https://www.googleapis.com/auth/genomics * https://www.googleapis.com/auth/logging.write * https://www.googleapis.com/auth/monitoring.write + * List of scopes to be enabled for this service account on the VM. The following scopes are automatically included: * https://www.googleapis.com/auth/compute * https://www.googleapis.com/auth/devstorage.full_control * https://www.googleapis.com/auth/genomics * https://www.googleapis.com/auth/logging.write * https://www.googleapis.com/auth/monitoring.write */ scopes?: string[] | null; } @@ -649,7 +649,7 @@ export namespace genomics_v1alpha2 { validationToken?: string | null; } /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -657,7 +657,7 @@ export namespace genomics_v1alpha2 { */ code?: number | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}> | null; /** @@ -730,7 +730,7 @@ export namespace genomics_v1alpha2 { /** * genomics.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel` + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel` * @example * // Before running the sample: * // - Enable the API at: @@ -869,7 +869,7 @@ export namespace genomics_v1alpha2 { /** * genomics.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get` + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get` * @example * // Before running the sample: * // - Enable the API at: @@ -1003,7 +1003,7 @@ export namespace genomics_v1alpha2 { /** * genomics.operations.list - * @desc Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list` + * @desc Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list` * @example * // Before running the sample: * // - Enable the API at: @@ -1031,36 +1031,7 @@ export namespace genomics_v1alpha2 { * * // Do the magic * const res = await genomics.operations.list({ - * // A string for filtering Operations. - * // In v2alpha1, the following filter fields are supported: - * // - * // * createTime: The time this job was created - * // * events: The set of event (names) that have occurred while running - * // the pipeline. The : operator can be used to determine if a - * // particular event has occurred. - * // * error: If the pipeline is running, this value is NULL. Once the - * // pipeline finishes, the value is the standard Google error code. - * // * labels.key or labels."key with space" where key is a label key. - * // * done: If the pipeline is running, this value is false. Once the - * // pipeline finishes, the value is true. - * // - * // In v1 and v1alpha2, the following filter fields are supported: - * // - * // * projectId: Required. Corresponds to - * // OperationMetadata.projectId. - * // * createTime: The time this job was created, in seconds from the - * // [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` - * // operators. - * // * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only - * // one status may be specified. - * // * labels.key where key is a label key. - * // - * // Examples: - * // - * // * `projectId = my-project AND createTime >= 1432140000` - * // * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` - * // * `projectId = my-project AND labels.color = *` - * // * `projectId = my-project AND labels.color = red` + * // A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` * filter: 'placeholder-value', * // The name of the operation's parent resource. * name: 'operations', @@ -1087,7 +1058,7 @@ export namespace genomics_v1alpha2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` + * @param {string=} params.filter A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` * @param {string} params.name The name of the operation's parent resource. * @param {integer=} params.pageSize The maximum number of results to return. The maximum value is 256. * @param {string=} params.pageToken The standard list page token. @@ -1196,7 +1167,7 @@ export namespace genomics_v1alpha2 { } export interface Params$Resource$Operations$List extends StandardParameters { /** - * A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` + * A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` */ filter?: string; /** @@ -1221,7 +1192,7 @@ export namespace genomics_v1alpha2 { /** * genomics.pipelines.create - * @desc Creates a pipeline that can be run later. Create takes a Pipeline that has all fields other than `pipelineId` populated, and then returns the same pipeline with `pipelineId` populated. This id can be used to run the pipeline. Caller must have WRITE permission to the project. + * @desc Creates a pipeline that can be run later. Create takes a Pipeline that has all fields other than `pipelineId` populated, and then returns the same pipeline with `pipelineId` populated. This id can be used to run the pipeline. Caller must have WRITE permission to the project. * @example * // Before running the sample: * // - Enable the API at: @@ -1373,7 +1344,7 @@ export namespace genomics_v1alpha2 { /** * genomics.pipelines.delete - * @desc Deletes a pipeline based on ID. Caller must have WRITE permission to the project. + * @desc Deletes a pipeline based on ID. Caller must have WRITE permission to the project. * @example * // Before running the sample: * // - Enable the API at: @@ -1401,8 +1372,7 @@ export namespace genomics_v1alpha2 { * * // Do the magic * const res = await genomics.pipelines.delete({ - * // Caller must have WRITE access to the project in which this pipeline - * // is defined. + * // Caller must have WRITE access to the project in which this pipeline is defined. * pipelineId: 'placeholder-value', * }); * console.log(res.data); @@ -1505,7 +1475,7 @@ export namespace genomics_v1alpha2 { /** * genomics.pipelines.get - * @desc Retrieves a pipeline based on ID. Caller must have READ permission to the project. + * @desc Retrieves a pipeline based on ID. Caller must have READ permission to the project. * @example * // Before running the sample: * // - Enable the API at: @@ -1533,8 +1503,7 @@ export namespace genomics_v1alpha2 { * * // Do the magic * const res = await genomics.pipelines.get({ - * // Caller must have READ access to the project in which this pipeline - * // is defined. + * // Caller must have READ access to the project in which this pipeline is defined. * pipelineId: 'placeholder-value', * }); * console.log(res.data); @@ -1792,7 +1761,7 @@ export namespace genomics_v1alpha2 { /** * genomics.pipelines.list - * @desc Lists pipelines. Caller must have READ permission to the project. + * @desc Lists pipelines. Caller must have READ permission to the project. * @example * // Before running the sample: * // - Enable the API at: @@ -1820,18 +1789,13 @@ export namespace genomics_v1alpha2 { * * // Do the magic * const res = await genomics.pipelines.list({ - * // Pipelines with names that match this prefix should be - * // returned. If unspecified, all pipelines in the project, up to - * // `pageSize`, will be returned. + * // Pipelines with names that match this prefix should be returned. If unspecified, all pipelines in the project, up to `pageSize`, will be returned. * namePrefix: 'placeholder-value', - * // Number of pipelines to return at once. Defaults to 256, and max - * // is 2048. + * // Number of pipelines to return at once. Defaults to 256, and max is 2048. * pageSize: 'placeholder-value', - * // Token to use to indicate where to start getting results. - * // If unspecified, returns the first page of results. + * // Token to use to indicate where to start getting results. If unspecified, returns the first page of results. * pageToken: 'placeholder-value', - * // Required. The name of the project to search for pipelines. Caller - * // must have READ access to this project. + * // Required. The name of the project to search for pipelines. Caller must have READ access to this project. * projectId: 'placeholder-value', * }); * console.log(res.data); @@ -1852,7 +1816,7 @@ export namespace genomics_v1alpha2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.namePrefix Pipelines with names that match this prefix should be returned. If unspecified, all pipelines in the project, up to `pageSize`, will be returned. + * @param {string=} params.namePrefix Pipelines with names that match this prefix should be returned. If unspecified, all pipelines in the project, up to `pageSize`, will be returned. * @param {integer=} params.pageSize Number of pipelines to return at once. Defaults to 256, and max is 2048. * @param {string=} params.pageToken Token to use to indicate where to start getting results. If unspecified, returns the first page of results. * @param {string=} params.projectId Required. The name of the project to search for pipelines. Caller must have READ access to this project. @@ -1945,7 +1909,7 @@ export namespace genomics_v1alpha2 { /** * genomics.pipelines.run - * @desc Runs a pipeline. If `pipelineId` is specified in the request, then run a saved pipeline. If `ephemeralPipeline` is specified, then run that pipeline once without saving a copy. The caller must have READ permission to the project where the pipeline is stored and WRITE permission to the project where the pipeline will be run, as VMs will be created and storage will be used. If a pipeline operation is still running after 6 days, it will be canceled. + * @desc Runs a pipeline. If `pipelineId` is specified in the request, then run a saved pipeline. If `ephemeralPipeline` is specified, then run that pipeline once without saving a copy. The caller must have READ permission to the project where the pipeline is stored and WRITE permission to the project where the pipeline will be run, as VMs will be created and storage will be used. If a pipeline operation is still running after 6 days, it will be canceled. * @example * // Before running the sample: * // - Enable the API at: @@ -2261,7 +2225,7 @@ export namespace genomics_v1alpha2 { } export interface Params$Resource$Pipelines$List extends StandardParameters { /** - * Pipelines with names that match this prefix should be returned. If unspecified, all pipelines in the project, up to `pageSize`, will be returned. + * Pipelines with names that match this prefix should be returned. If unspecified, all pipelines in the project, up to `pageSize`, will be returned. */ namePrefix?: string; /** diff --git a/src/apis/genomics/v2alpha1.ts b/src/apis/genomics/v2alpha1.ts index 82d5a4c084..4427aa0442 100644 --- a/src/apis/genomics/v2alpha1.ts +++ b/src/apis/genomics/v2alpha1.ts @@ -140,7 +140,7 @@ export namespace genomics_v2alpha1 { */ count?: string | null; /** - * The accelerator type string (for example, "nvidia-tesla-k80"). Only NVIDIA GPU accelerators are currently supported. If an NVIDIA GPU is attached, the required runtime libraries will be made available to all containers under `/usr/local/nvidia`. The driver version to install must be specified using the NVIDIA driver version parameter on the virtual machine specification. Note that attaching a GPU increases the worker VM startup time by a few minutes. + * The accelerator type string (for example, "nvidia-tesla-k80"). Only NVIDIA GPU accelerators are currently supported. If an NVIDIA GPU is attached, the required runtime libraries will be made available to all containers under `/usr/local/nvidia`. The driver version to install must be specified using the NVIDIA driver version parameter on the virtual machine specification. Note that attaching a GPU increases the worker VM startup time by a few minutes. */ type?: string | null; } @@ -153,7 +153,7 @@ export namespace genomics_v2alpha1 { */ commands?: string[] | null; /** - * If the specified image is hosted on a private registry other than Google Container Registry, the credentials required to pull the image must be specified here as an encrypted secret. The secret must decrypt to a JSON-encoded dictionary containing both `username` and `password` keys. + * If the specified image is hosted on a private registry other than Google Container Registry, the credentials required to pull the image must be specified here as an encrypted secret. The secret must decrypt to a JSON-encoded dictionary containing both `username` and `password` keys. */ credentials?: Schema$Secret; /** @@ -161,7 +161,7 @@ export namespace genomics_v2alpha1 { */ entrypoint?: string | null; /** - * The environment to pass into the container. This environment is merged with values specified in the google.genomics.v2alpha1.Pipeline message, overwriting any duplicate values. In addition to the values passed here, a few other values are automatically injected into the environment. These cannot be hidden or overwritten. `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline failed because an action has exited with a non-zero status (and did not have the `IGNORE_EXIT_STATUS` flag set). This can be used to determine if additional debug or logging actions should execute. `GOOGLE_LAST_EXIT_STATUS` will be set to the exit status of the last non-background action that executed. This can be used by workflow engine authors to determine whether an individual action has succeeded or failed. + * The environment to pass into the container. This environment is merged with values specified in the google.genomics.v2alpha1.Pipeline message, overwriting any duplicate values. In addition to the values passed here, a few other values are automatically injected into the environment. These cannot be hidden or overwritten. `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline failed because an action has exited with a non-zero status (and did not have the `IGNORE_EXIT_STATUS` flag set). This can be used to determine if additional debug or logging actions should execute. `GOOGLE_LAST_EXIT_STATUS` will be set to the exit status of the last non-background action that executed. This can be used by workflow engine authors to determine whether an individual action has succeeded or failed. */ environment?: {[key: string]: string} | null; /** @@ -169,7 +169,7 @@ export namespace genomics_v2alpha1 { */ flags?: string[] | null; /** - * Required. The URI to pull the container image from. Note that all images referenced by actions in the pipeline are pulled before the first action runs. If multiple actions reference the same image, it is only pulled once, ensuring that the same image is used for all actions in a single pipeline. The image URI can be either a complete host and image specification (e.g., quay.io/biocontainers/samtools), a library and image name (e.g., google/cloud-sdk) or a bare image name ('bash') to pull from the default library. No schema is required in any of these cases. If the specified image is not public, the service account specified for the Virtual Machine must have access to pull the images from GCR, or appropriate credentials must be specified in the google.genomics.v2alpha1.Action.credentials field. + * Required. The URI to pull the container image from. Note that all images referenced by actions in the pipeline are pulled before the first action runs. If multiple actions reference the same image, it is only pulled once, ensuring that the same image is used for all actions in a single pipeline. The image URI can be either a complete host and image specification (e.g., quay.io/biocontainers/samtools), a library and image name (e.g., google/cloud-sdk) or a bare image name ('bash') to pull from the default library. No schema is required in any of these cases. If the specified image is not public, the service account specified for the Virtual Machine must have access to pull the images from GCR, or appropriate credentials must be specified in the google.genomics.v2alpha1.Action.credentials field. */ imageUri?: string | null; /** @@ -177,7 +177,7 @@ export namespace genomics_v2alpha1 { */ labels?: {[key: string]: string} | null; /** - * A list of mounts to make available to the action. In addition to the values specified here, every action has a special virtual disk mounted under `/google` that contains log files and other operational components. <ul> <li><code>/google/logs</code> All logs written during the pipeline execution.</li> <li><code>/google/logs/output</code> The combined standard output and standard error of all actions run as part of the pipeline execution.</li> <li><code>/google/logs/action/x/stdout</code> The complete contents of each individual action's standard output.</li> <li><code>/google/logs/action/x/stderr</code> The complete contents of each individual action's standard error output.</li> </ul> + * A list of mounts to make available to the action. In addition to the values specified here, every action has a special virtual disk mounted under `/google` that contains log files and other operational components. - /google/logs All logs written during the pipeline execution. - /google/logs/output The combined standard output and standard error of all actions run as part of the pipeline execution. - /google/logs/action/x/stdout The complete contents of each individual action's standard output. - /google/logs/action/x/stderr The complete contents of each individual action's standard error output. */ mounts?: Schema$Mount[]; /** @@ -185,11 +185,11 @@ export namespace genomics_v2alpha1 { */ name?: string | null; /** - * An optional identifier for a PID namespace to run the action inside. Multiple actions should use the same string to share a namespace. If unspecified, a separate isolated namespace is used. + * An optional identifier for a PID namespace to run the action inside. Multiple actions should use the same string to share a namespace. If unspecified, a separate isolated namespace is used. */ pidNamespace?: string | null; /** - * A map of containers to host port mappings for this container. If the container already specifies exposed ports, use the `PUBLISH_EXPOSED_PORTS` flag instead. The host port number must be less than 65536. If it is zero, an unused random port is assigned. To determine the resulting port number, consult the `ContainerStartedEvent` in the operation metadata. + * A map of containers to host port mappings for this container. If the container already specifies exposed ports, use the `PUBLISH_EXPOSED_PORTS` flag instead. The host port number must be less than 65536. If it is zero, an unused random port is assigned. To determine the resulting port number, consult the `ContainerStartedEvent` in the operation metadata. */ portMappings?: {[key: string]: number} | null; /** @@ -221,6 +221,10 @@ export namespace genomics_v2alpha1 { * The operation has finished with the given result. */ result?: Schema$Status; + /** + * An SOS report for an unexpected VM failure. + */ + sosReport?: string | null; /** * Data about the status of the worker VM. */ @@ -231,7 +235,7 @@ export namespace genomics_v2alpha1 { */ export interface Schema$CheckInResponse { /** - * The deadline by which the worker must request an extension. The backend will allow for network transmission time and other delays, but the worker must attempt to transmit the extension request no later than the deadline. + * The deadline by which the worker must request an extension. The backend will allow for network transmission time and other delays, but the worker must attempt to transmit the extension request no later than the deadline. */ deadline?: string | null; /** @@ -299,7 +303,7 @@ export namespace genomics_v2alpha1 { */ exitStatus?: number | null; /** - * The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere. + * The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere. */ stderr?: string | null; } @@ -317,7 +321,7 @@ export namespace genomics_v2alpha1 { metrics?: string[] | null; } /** - * Carries information about a disk that can be attached to a VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations. + * Carries information about a disk that can be attached to a VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations. */ export interface Schema$Disk { /** @@ -325,7 +329,7 @@ export namespace genomics_v2alpha1 { */ name?: string | null; /** - * The size, in GB, of the disk to attach. If the size is not specified, a default is chosen to ensure reasonable I/O performance. If the disk type is specified as `local-ssd`, multiple local drives are automatically combined to provide the requested size. Note, however, that each physical SSD is 375GB in size, and no more than 8 drives can be attached to a single instance. + * The size, in GB, of the disk to attach. If the size is not specified, a default is chosen to ensure reasonable I/O performance. If the disk type is specified as `local-ssd`, multiple local drives are automatically combined to provide the requested size. Note, however, that each physical SSD is 375GB in size, and no more than 8 drives can be attached to a single instance. */ sizeGb?: number | null; /** @@ -351,7 +355,7 @@ export namespace genomics_v2alpha1 { totalSpaceBytes?: string | null; } /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -448,15 +452,15 @@ export namespace genomics_v2alpha1 { */ export interface Schema$Network { /** - * The network name to attach the VM's network interface to. The value will be prefixed with `global/networks/` unless it contains a `/`, in which case it is assumed to be a fully specified network resource URL. If unspecified, the global default network is used. + * The network name to attach the VM's network interface to. The value will be prefixed with `global/networks/` unless it contains a `/`, in which case it is assumed to be a fully specified network resource URL. If unspecified, the global default network is used. */ name?: string | null; /** - * If the specified network is configured for custom subnet creation, the name of the subnetwork to attach the instance to must be specified here. The value is prefixed with `regions/x/subnetworks/` unless it contains a `/`, in which case it is assumed to be a fully specified subnetwork resource URL. If the `*` character appears in the value, it is replaced with the region that the virtual machine has been allocated in. + * If the specified network is configured for custom subnet creation, the name of the subnetwork to attach the instance to must be specified here. The value is prefixed with `regions/x/subnetworks/` unless it contains a `/`, in which case it is assumed to be a fully specified subnetwork resource URL. If the `*` character appears in the value, it is replaced with the region that the virtual machine has been allocated in. */ subnetwork?: string | null; /** - * If set to true, do not attach a public IP address to the VM. Note that without a public IP address, additional configuration is required to allow the VM to access Google services. See https://cloud.google.com/vpc/docs/configure-private-google-access for more information. + * If set to true, do not attach a public IP address to the VM. Note that without a public IP address, additional configuration is required to allow the VM to access Google services. See https://cloud.google.com/vpc/docs/configure-private-google-access for more information. */ usePrivateAddress?: boolean | null; } @@ -477,7 +481,7 @@ export namespace genomics_v2alpha1 { */ metadata?: {[key: string]: any} | null; /** - * The server-assigned name, which is only unique within the same service that originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` + * The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` */ name?: string | null; /** @@ -560,7 +564,7 @@ export namespace genomics_v2alpha1 { */ resources?: Schema$Resources; /** - * The maximum amount of time to give the pipeline to complete. This includes the time spent waiting for a worker to be allocated. If the pipeline fails to complete before the timeout, it will be cancelled and the error code will be set to DEADLINE_EXCEEDED. If unspecified, it will default to 7 days. + * The maximum amount of time to give the pipeline to complete. This includes the time spent waiting for a worker to be allocated. If the pipeline fails to complete before the timeout, it will be cancelled and the error code will be set to DEADLINE_EXCEEDED. If unspecified, it will default to 7 days. */ timeout?: string | null; } @@ -583,7 +587,7 @@ export namespace genomics_v2alpha1 { imageUri?: string | null; } /** - * The system resources for the pipeline run. At least one zone or region must be specified or the pipeline run will fail. + * The system resources for the pipeline run. At least one zone or region must be specified or the pipeline run will fail. */ export interface Schema$Resources { /** @@ -608,7 +612,7 @@ export namespace genomics_v2alpha1 { */ export interface Schema$RunPipelineRequest { /** - * User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time. To associate labels with resources created while executing the operation, see the appropriate resource message (for example, `VirtualMachine`). + * User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time. To associate labels with resources created while executing the operation, see the appropriate resource message (for example, `VirtualMachine`). */ labels?: {[key: string]: string} | null; /** @@ -656,7 +660,7 @@ export namespace genomics_v2alpha1 { scopes?: string[] | null; } /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -664,7 +668,7 @@ export namespace genomics_v2alpha1 { */ code?: number | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}> | null; /** @@ -711,11 +715,11 @@ export namespace genomics_v2alpha1 { */ bootDiskSizeGb?: number | null; /** - * The host operating system image to use. Currently, only Container-Optimized OS images can be used. The default value is `projects/cos-cloud/global/images/family/cos-stable`, which selects the latest stable release of Container-Optimized OS. This option is provided to allow testing against the beta release of the operating system to ensure that the new version does not interact negatively with production pipelines. To test a pipeline against the beta release of Container-Optimized OS, use the value `projects/cos-cloud/global/images/family/cos-beta`. + * The host operating system image to use. Currently, only Container-Optimized OS images can be used. The default value is `projects/cos-cloud/global/images/family/cos-stable`, which selects the latest stable release of Container-Optimized OS. This option is provided to allow testing against the beta release of the operating system to ensure that the new version does not interact negatively with production pipelines. To test a pipeline against the beta release of Container-Optimized OS, use the value `projects/cos-cloud/global/images/family/cos-beta`. */ bootImage?: string | null; /** - * The CPU platform to request. An instance based on a newer platform can be allocated, but never one with fewer capabilities. The value of this parameter must be a valid Compute Engine CPU platform name (such as "Intel Skylake"). This parameter is only useful for carefully optimized work loads where the CPU platform has a significant impact. For more information about the effect of this parameter, see https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. + * The CPU platform to request. An instance based on a newer platform can be allocated, but never one with fewer capabilities. The value of this parameter must be a valid Compute Engine CPU platform name (such as "Intel Skylake"). This parameter is only useful for carefully optimized work loads where the CPU platform has a significant impact. For more information about the effect of this parameter, see https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. */ cpuPlatform?: string | null; /** @@ -731,7 +735,7 @@ export namespace genomics_v2alpha1 { */ enableStackdriverMonitoring?: boolean | null; /** - * Optional set of labels to apply to the VM and any attached disk resources. These labels must adhere to the [name and value restrictions](https://cloud.google.com/compute/docs/labeling-resources) on VM labels imposed by Compute Engine. Labels keys with the prefix 'google-' are reserved for use by Google. Labels applied at creation time to the VM. Applied on a best-effort basis to attached disk resources shortly after VM creation. + * Optional set of labels to apply to the VM and any attached disk resources. These labels must adhere to the [name and value restrictions](https://cloud.google.com/compute/docs/labeling-resources) on VM labels imposed by Compute Engine. Labels keys with the prefix 'google-' are reserved for use by Google. Labels applied at creation time to the VM. Applied on a best-effort basis to attached disk resources shortly after VM creation. */ labels?: {[key: string]: string} | null; /** @@ -819,7 +823,7 @@ export namespace genomics_v2alpha1 { /** * genomics.pipelines.run - * @desc Runs a pipeline. The returned Operation's metadata field will contain a google.genomics.v2alpha1.Metadata object describing the status of the pipeline execution. The [response] field will contain a google.genomics.v2alpha1.RunPipelineResponse object if the pipeline completes successfully. **Note:** Before you can use this method, the Genomics Service Agent must have access to your project. This is done automatically when the Cloud Genomics API is first enabled, but if you delete this permission, or if you enabled the Cloud Genomics API before the v2alpha1 API launch, you must disable and re-enable the API to grant the Genomics Service Agent the required permissions. Authorization requires the following [Google IAM](https://cloud.google.com/iam/) permission: * `genomics.operations.create` [1]: /genomics/gsa + * @desc Runs a pipeline. The returned Operation's metadata field will contain a google.genomics.v2alpha1.Metadata object describing the status of the pipeline execution. The [response] field will contain a google.genomics.v2alpha1.RunPipelineResponse object if the pipeline completes successfully. **Note:** Before you can use this method, the Genomics Service Agent must have access to your project. This is done automatically when the Cloud Genomics API is first enabled, but if you delete this permission, or if you enabled the Cloud Genomics API before the v2alpha1 API launch, you must disable and re-enable the API to grant the Genomics Service Agent the required permissions. Authorization requires the following [Google IAM](https://cloud.google.com/iam/) permission: * `genomics.operations.create` [1]: /genomics/gsa * @example * // Before running the sample: * // - Enable the API at: @@ -987,7 +991,7 @@ export namespace genomics_v2alpha1 { /** * genomics.projects.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel` + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel` * @example * // Before running the sample: * // - Enable the API at: @@ -1126,7 +1130,7 @@ export namespace genomics_v2alpha1 { /** * genomics.projects.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get` + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get` * @example * // Before running the sample: * // - Enable the API at: @@ -1261,7 +1265,7 @@ export namespace genomics_v2alpha1 { /** * genomics.projects.operations.list - * @desc Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list` + * @desc Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list` * @example * // Before running the sample: * // - Enable the API at: @@ -1289,36 +1293,7 @@ export namespace genomics_v2alpha1 { * * // Do the magic * const res = await genomics.projects.operations.list({ - * // A string for filtering Operations. - * // In v2alpha1, the following filter fields are supported: - * // - * // * createTime: The time this job was created - * // * events: The set of event (names) that have occurred while running - * // the pipeline. The : operator can be used to determine if a - * // particular event has occurred. - * // * error: If the pipeline is running, this value is NULL. Once the - * // pipeline finishes, the value is the standard Google error code. - * // * labels.key or labels."key with space" where key is a label key. - * // * done: If the pipeline is running, this value is false. Once the - * // pipeline finishes, the value is true. - * // - * // In v1 and v1alpha2, the following filter fields are supported: - * // - * // * projectId: Required. Corresponds to - * // OperationMetadata.projectId. - * // * createTime: The time this job was created, in seconds from the - * // [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` - * // operators. - * // * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only - * // one status may be specified. - * // * labels.key where key is a label key. - * // - * // Examples: - * // - * // * `projectId = my-project AND createTime >= 1432140000` - * // * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` - * // * `projectId = my-project AND labels.color = *` - * // * `projectId = my-project AND labels.color = red` + * // A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` * filter: 'placeholder-value', * // The name of the operation's parent resource. * name: 'projects/my-project/operations', @@ -1345,7 +1320,7 @@ export namespace genomics_v2alpha1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` + * @param {string=} params.filter A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` * @param {string} params.name The name of the operation's parent resource. * @param {integer=} params.pageSize The maximum number of results to return. The maximum value is 256. * @param {string=} params.pageToken The standard list page token. @@ -1457,7 +1432,7 @@ export namespace genomics_v2alpha1 { export interface Params$Resource$Projects$Operations$List extends StandardParameters { /** - * A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` + * A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` */ filter?: string; /** @@ -1510,8 +1485,7 @@ export namespace genomics_v2alpha1 { * * // Do the magic * const res = await genomics.projects.workers.checkIn({ - * // The VM identity token for authenticating the VM instance. - * // https://cloud.google.com/compute/docs/instances/verifying-instance-identity + * // The VM identity token for authenticating the VM instance. https://cloud.google.com/compute/docs/instances/verifying-instance-identity * id: 'projects/my-project/workers/my-worker', * * // Request body metadata @@ -1522,6 +1496,7 @@ export namespace genomics_v2alpha1 { * // "event": {}, * // "events": [], * // "result": {}, + * // "sosReport": "my_sosReport", * // "workerStatus": {} * // } * }, @@ -1679,8 +1654,7 @@ export namespace genomics_v2alpha1 { * * // Do the magic * const res = await genomics.workers.checkIn({ - * // The VM identity token for authenticating the VM instance. - * // https://cloud.google.com/compute/docs/instances/verifying-instance-identity + * // The VM identity token for authenticating the VM instance. https://cloud.google.com/compute/docs/instances/verifying-instance-identity * id: 'placeholder-value', * * // Request body metadata @@ -1691,6 +1665,7 @@ export namespace genomics_v2alpha1 { * // "event": {}, * // "events": [], * // "result": {}, + * // "sosReport": "my_sosReport", * // "workerStatus": {} * // } * }, diff --git a/src/apis/gmail/v1.ts b/src/apis/gmail/v1.ts index 9994a6285c..e7a9f7f22e 100644 --- a/src/apis/gmail/v1.ts +++ b/src/apis/gmail/v1.ts @@ -101,7 +101,7 @@ export namespace gmail_v1 { /** * Gmail API * - * The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels. + * The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels. * * @example * const {google} = require('googleapis'); @@ -136,7 +136,7 @@ export namespace gmail_v1 { */ disposition?: string | null; /** - * Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses. + * Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses. */ emailAddress?: string | null; /** @@ -165,7 +165,7 @@ export namespace gmail_v1 { removeLabelIds?: string[] | null; } /** - * Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See <a href="https://support.google.com/mail/answer/138350">"Set up mail delegation"</a> for more information about delegates. + * Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See "Set up mail delegation" for more information about delegates. */ export interface Schema$Delegate { /** @@ -173,7 +173,7 @@ export namespace gmail_v1 { */ delegateEmail?: string | null; /** - * Indicates whether this address has been verified and can act as a delegate for the account. Read-only. + * Indicates whether this address has been verified and can act as a delegate for the account. Read-only. */ verificationStatus?: string | null; } @@ -241,11 +241,11 @@ export namespace gmail_v1 { */ hasAttachment?: boolean | null; /** - * Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread"`. + * Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. */ negatedQuery?: string | null; /** - * Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread"`. + * Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. */ query?: string | null; /** @@ -274,7 +274,7 @@ export namespace gmail_v1 { */ forwardingEmail?: string | null; /** - * Indicates whether this address has been verified and is usable for forwarding. Read-only. + * Indicates whether this address has been verified and is usable for forwarding. Read-only. */ verificationStatus?: string | null; } @@ -295,7 +295,7 @@ export namespace gmail_v1 { */ labelsRemoved?: Schema$HistoryLabelRemoved[]; /** - * List of messages changed in this history record. The fields for specific change types, such as `messagesAdded` may duplicate messages in this field. We recommend using the specific change-type fields instead of this. + * List of messages changed in this history record. The fields for specific change types, such as `messagesAdded` may duplicate messages in this field. We recommend using the specific change-type fields instead of this. */ messages?: Schema$Message[]; /** @@ -332,7 +332,7 @@ export namespace gmail_v1 { */ export interface Schema$ImapSettings { /** - * If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted. + * If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted. */ autoExpunge?: boolean | null; /** @@ -344,7 +344,7 @@ export namespace gmail_v1 { */ expungeBehavior?: string | null; /** - * An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit. + * An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit. */ maxFolderSize?: number | null; } @@ -395,20 +395,20 @@ export namespace gmail_v1 { } export interface Schema$LabelColor { /** - * The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: <br/> # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 @mutable gmail.users.labels.create gmail.users.labels.update + * The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 @mutable gmail.users.labels.create gmail.users.labels.update */ backgroundColor?: string | null; /** - * The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: <br/> # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 @mutable gmail.users.labels.create gmail.users.labels.update + * The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 @mutable gmail.users.labels.create gmail.users.labels.update */ textColor?: string | null; } /** - * Language settings for an account. These settings correspond to the <a href="https://support.google.com/mail/answer/17091">"Language settings"</a> feature in the web interface. + * Language settings for an account. These settings correspond to the "Language settings" feature in the web interface. */ export interface Schema$LanguageSettings { /** - * The language to display Gmail in, formatted as an <a href="https://www.w3.org/International/articles/language-tags/">RFC 3066 Language Tag</a> (for example `en-GB`, `fr` or `ja` for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the <a href="https://mail.google.com/mail/u/0/#settings/general">Gmail settings </a> for all available options, as described in the <a href="https://support.google.com/mail/answer/17091">language settings help article</a>. A table of sample values is also provided in the <a href="/gmail/api/guides/language_settings#display_language">Managing Language Settings guide</a> Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default). + * The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example `en-GB`, `fr` or `ja` for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the Gmail settings for all available options, as described in the language settings help article. A table of sample values is also provided in the Managing Language Settings guide Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default). */ displayLanguage?: string | null; } @@ -423,7 +423,7 @@ export namespace gmail_v1 { } export interface Schema$ListDraftsResponse { /** - * List of drafts. Note that the `Message` property in each `Draft` resource only contains an `id` and a `threadId`. The <a href="/gmail/api/v1/reference/users/messages/get">messages.get</a> method can fetch additional message details. + * List of drafts. Note that the `Message` property in each `Draft` resource only contains an `id` and a `threadId`. The messages.get method can fetch additional message details. */ drafts?: Schema$Draft[]; /** @@ -455,7 +455,7 @@ export namespace gmail_v1 { } export interface Schema$ListHistoryResponse { /** - * List of history records. Any `messages` contained in the response will typically only have `id` and `threadId` fields populated. + * List of history records. Any `messages` contained in the response will typically only have `id` and `threadId` fields populated. */ history?: Schema$History[]; /** @@ -469,13 +469,13 @@ export namespace gmail_v1 { } export interface Schema$ListLabelsResponse { /** - * List of labels. Note that each label resource only contains an `id`, `name`, `messageListVisibility`, `labelListVisibility`, and `type`. The <a href="/gmail/api/v1/reference/users/labels/get">labels.get</a> method can fetch additional label details. + * List of labels. Note that each label resource only contains an `id`, `name`, `messageListVisibility`, `labelListVisibility`, and `type`. The labels.get method can fetch additional label details. */ labels?: Schema$Label[]; } export interface Schema$ListMessagesResponse { /** - * List of messages. Note that each message resource contains only an `id` and a `threadId`. Additional message details can be fetched using the <a href="/gmail/api/v1/reference/users/messages/get">messages.get</a> method. + * List of messages. Note that each message resource contains only an `id` and a `threadId`. Additional message details can be fetched using the messages.get method. */ messages?: Schema$Message[]; /** @@ -512,7 +512,7 @@ export namespace gmail_v1 { */ resultSizeEstimate?: number | null; /** - * List of threads. Note that each thread resource does not contain a list of `messages`. The list of `messages` for a given thread can be fetched using the <a href="/gmail/api/v1/reference/users/threads/get">threads.get</a> method. + * List of threads. Note that each thread resource does not contain a list of `messages`. The list of `messages` for a given thread can be fetched using the threads.get method. */ threads?: Schema$Thread[]; } @@ -529,7 +529,7 @@ export namespace gmail_v1 { */ id?: string | null; /** - * The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the `Date` header. However, for API-migrated mail, it can be configured by client to be based on the `Date` header. + * The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the `Date` header. However, for API-migrated mail, it can be configured by client to be based on the `Date` header. */ internalDate?: string | null; /** @@ -553,7 +553,7 @@ export namespace gmail_v1 { */ snippet?: string | null; /** - * The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: <ol><li>The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request.</li> <li>The `References` and `In-Reply-To` headers must be set in compliance with the <a href="https://tools.ietf.org/html/rfc2822">RFC 2822</a> standard.</li> <li>The `Subject` headers must match. @mutable gmail.users.messages.insert gmail.users.messages.send @mutable gmail.users.drafts.create gmail.users.drafts.update + * The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the RFC 2822 standard. 3. The `Subject` headers must match. @mutable gmail.users.messages.insert gmail.users.messages.send @mutable gmail.users.drafts.create gmail.users.drafts.update */ threadId?: string | null; } @@ -582,7 +582,7 @@ export namespace gmail_v1 { */ partId?: string | null; /** - * The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/x. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>. + * The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/x. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521. */ parts?: Schema$MessagePart[]; } @@ -668,7 +668,7 @@ export namespace gmail_v1 { threadsTotal?: number | null; } /** - * Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the <a href="https://support.google.com/mail/answer/22370">"Send Mail As"</a> feature in the web interface. + * Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface. */ export interface Schema$SendAs { /** @@ -676,19 +676,19 @@ export namespace gmail_v1 { */ displayName?: string | null; /** - * Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is `true`. Changing this from `false` to `true` for an address will result in this field becoming `false` for the other previous default address. + * Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is `true`. Changing this from `false` to `true` for an address will result in this field becoming `false` for the other previous default address. */ isDefault?: boolean | null; /** - * Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only. + * Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only. */ isPrimary?: boolean | null; /** - * An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header. + * An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header. */ replyToAddress?: string | null; /** - * The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create. + * The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create. */ sendAsEmail?: string | null; /** @@ -696,15 +696,15 @@ export namespace gmail_v1 { */ signature?: string | null; /** - * An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases. + * An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases. */ smtpMsa?: Schema$SmtpMsa; /** - * Whether Gmail should <a href="https://support.google.com/a/answer/1710338"> treat this address as an alias</a> for the user's primary email address. This setting only applies to custom "from" aliases. + * Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases. */ treatAsAlias?: boolean | null; /** - * Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases. + * Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases. */ verificationStatus?: string | null; } @@ -733,11 +733,11 @@ export namespace gmail_v1 { */ issuerCn?: string | null; /** - * PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key). + * PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key). */ pem?: string | null; /** - * PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately. + * PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately. */ pkcs12?: string | null; } @@ -746,7 +746,7 @@ export namespace gmail_v1 { */ export interface Schema$SmtpMsa { /** - * The hostname of the SMTP service. Required. + * The hostname of the SMTP service. Required. */ host?: string | null; /** @@ -754,11 +754,11 @@ export namespace gmail_v1 { */ password?: string | null; /** - * The port of the SMTP service. Required. + * The port of the SMTP service. Required. */ port?: number | null; /** - * The protocol that will be used to secure communication with the SMTP service. Required. + * The protocol that will be used to secure communication with the SMTP service. Required. */ securityMode?: string | null; /** @@ -788,7 +788,7 @@ export namespace gmail_v1 { snippet?: string | null; } /** - * Vacation auto-reply settings for an account. These settings correspond to the <a href="https://support.google.com/mail/answer/25922">"Vacation responder"</a> feature in the web interface. + * Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. */ export interface Schema$VacationSettings { /** @@ -796,11 +796,11 @@ export namespace gmail_v1 { */ enableAutoReply?: boolean | null; /** - * An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`. + * An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`. */ endTime?: string | null; /** - * Response body in HTML format. Gmail will sanitize the HTML before storing it. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used. + * Response body in HTML format. Gmail will sanitize the HTML before storing it. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used. */ responseBodyHtml?: string | null; /** @@ -808,7 +808,7 @@ export namespace gmail_v1 { */ responseBodyPlainText?: string | null; /** - * Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty. + * Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty. */ responseSubject?: string | null; /** @@ -820,7 +820,7 @@ export namespace gmail_v1 { */ restrictToDomain?: boolean | null; /** - * An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`. + * An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`. */ startTime?: string | null; } @@ -833,11 +833,11 @@ export namespace gmail_v1 { */ labelFilterAction?: string | null; /** - * List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated. + * List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated. */ labelIds?: string[] | null; /** - * A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name **must** already exist in Cloud Pub/Sub and you **must** have already granted gmail "publish" permission on it. For example, "projects/my-project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic naming format). Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request). + * A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name **must** already exist in Cloud Pub/Sub and you **must** have already granted gmail "publish" permission on it. For example, "projects/my-project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic naming format). Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request). */ topicName?: string | null; } @@ -906,8 +906,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.getProfile({ - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -1045,8 +1044,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.stop({ - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -1174,8 +1172,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.watch({ - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -1353,8 +1350,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.drafts.create({ - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -1514,8 +1510,7 @@ export namespace gmail_v1 { * const res = await gmail.users.drafts.delete({ * // The ID of the draft to delete. * id: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -1649,8 +1644,7 @@ export namespace gmail_v1 { * format: 'placeholder-value', * // The ID of the draft to retrieve. * id: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -1788,20 +1782,15 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.drafts.list({ - * // Include drafts from `SPAM` and `TRASH` - * // in the results. + * // Include drafts from `SPAM` and `TRASH` in the results. * includeSpamTrash: 'placeholder-value', * // Maximum number of drafts to return. * maxResults: 'placeholder-value', * // Page token to retrieve a specific page of results in the list. * pageToken: 'placeholder-value', - * // Only return draft messages matching the specified query. Supports the same - * // query format as the Gmail search box. For example, - * // `"from:someuser@example.com rfc822msgid: - * // is:unread"`. + * // Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. * q: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -1826,7 +1815,7 @@ export namespace gmail_v1 { * @param {boolean=} params.includeSpamTrash Include drafts from `SPAM` and `TRASH` in the results. * @param {integer=} params.maxResults Maximum number of drafts to return. * @param {string=} params.pageToken Page token to retrieve a specific page of results in the list. - * @param {string=} params.q Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. + * @param {string=} params.q Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. * @param {string} params.userId The user's email address. The special value `me` can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1946,8 +1935,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.drafts.send({ - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -2113,8 +2101,7 @@ export namespace gmail_v1 { * const res = await gmail.users.drafts.update({ * // The ID of the draft to update. * id: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -2308,7 +2295,7 @@ export namespace gmail_v1 { */ pageToken?: string; /** - * Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. + * Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. */ q?: string; /** @@ -2421,22 +2408,9 @@ export namespace gmail_v1 { * maxResults: 'placeholder-value', * // Page token to retrieve a specific page of results in the list. * pageToken: 'placeholder-value', - * // Required. Returns history records after the specified - * // `startHistoryId`. The supplied `startHistoryId` - * // should be obtained from the `historyId` of a message, thread, or - * // previous `list` response. History IDs increase - * // chronologically but are not contiguous with random gaps in between valid - * // IDs. Supplying an invalid or out of date `startHistoryId` - * // typically returns an `HTTP 404` error code. A - * // `historyId` is typically valid for at least a week, but in some - * // rare circumstances may be valid for only a few hours. If you receive an - * // `HTTP 404` error response, your application should perform a - * // full sync. If you receive no `nextPageToken` in the response, - * // there are no updates to retrieve and you can store the returned - * // `historyId` for a future request. + * // Required. Returns history records after the specified `startHistoryId`. The supplied `startHistoryId` should be obtained from the `historyId` of a message, thread, or previous `list` response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date `startHistoryId` typically returns an `HTTP 404` error code. A `historyId` is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an `HTTP 404` error response, your application should perform a full sync. If you receive no `nextPageToken` in the response, there are no updates to retrieve and you can store the returned `historyId` for a future request. * startHistoryId: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -2462,7 +2436,7 @@ export namespace gmail_v1 { * @param {string=} params.labelId Only return messages with a label matching the ID. * @param {integer=} params.maxResults The maximum number of history records to return. * @param {string=} params.pageToken Page token to retrieve a specific page of results in the list. - * @param {string=} params.startHistoryId Required. Returns history records after the specified `startHistoryId`. The supplied `startHistoryId` should be obtained from the `historyId` of a message, thread, or previous `list` response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date `startHistoryId` typically returns an `HTTP 404` error code. A `historyId` is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an `HTTP 404` error response, your application should perform a full sync. If you receive no `nextPageToken` in the response, there are no updates to retrieve and you can store the returned `historyId` for a future request. + * @param {string=} params.startHistoryId Required. Returns history records after the specified `startHistoryId`. The supplied `startHistoryId` should be obtained from the `historyId` of a message, thread, or previous `list` response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date `startHistoryId` typically returns an `HTTP 404` error code. A `historyId` is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an `HTTP 404` error response, your application should perform a full sync. If you receive no `nextPageToken` in the response, there are no updates to retrieve and you can store the returned `historyId` for a future request. * @param {string} params.userId The user's email address. The special value `me` can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2570,7 +2544,7 @@ export namespace gmail_v1 { */ pageToken?: string; /** - * Required. Returns history records after the specified `startHistoryId`. The supplied `startHistoryId` should be obtained from the `historyId` of a message, thread, or previous `list` response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date `startHistoryId` typically returns an `HTTP 404` error code. A `historyId` is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an `HTTP 404` error response, your application should perform a full sync. If you receive no `nextPageToken` in the response, there are no updates to retrieve and you can store the returned `historyId` for a future request. + * Required. Returns history records after the specified `startHistoryId`. The supplied `startHistoryId` should be obtained from the `historyId` of a message, thread, or previous `list` response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date `startHistoryId` typically returns an `HTTP 404` error code. A `historyId` is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an `HTTP 404` error response, your application should perform a full sync. If you receive no `nextPageToken` in the response, there are no updates to retrieve and you can store the returned `historyId` for a future request. */ startHistoryId?: string; /** @@ -2616,8 +2590,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.labels.create({ - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -2781,8 +2754,7 @@ export namespace gmail_v1 { * const res = await gmail.users.labels.delete({ * // The ID of the label to delete. * id: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -2915,8 +2887,7 @@ export namespace gmail_v1 { * const res = await gmail.users.labels.get({ * // The ID of the label to retrieve. * id: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -3062,8 +3033,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.labels.list({ - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -3203,8 +3173,7 @@ export namespace gmail_v1 { * const res = await gmail.users.labels.patch({ * // The ID of the label to update. * id: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -3369,8 +3338,7 @@ export namespace gmail_v1 { * const res = await gmail.users.labels.update({ * // The ID of the label to update. * id: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -3586,7 +3554,7 @@ export namespace gmail_v1 { /** * gmail.users.messages.batchDelete - * @desc Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all. + * @desc Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all. * @example * // Before running the sample: * // - Enable the API at: @@ -3611,8 +3579,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.messages.batchDelete({ - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -3747,8 +3714,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.messages.batchModify({ - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -3857,7 +3823,7 @@ export namespace gmail_v1 { /** * gmail.users.messages.delete - * @desc Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer `messages.trash` instead. + * @desc Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer `messages.trash` instead. * @example * // Before running the sample: * // - Enable the API at: @@ -3884,8 +3850,7 @@ export namespace gmail_v1 { * const res = await gmail.users.messages.delete({ * // The ID of the message to delete. * id: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -4022,11 +3987,9 @@ export namespace gmail_v1 { * format: 'placeholder-value', * // The ID of the message to retrieve. * id: 'placeholder-value', - * // When given and format is `METADATA`, only include headers - * // specified. + * // When given and format is `METADATA`, only include headers specified. * metadataHeaders: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -4172,21 +4135,15 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.messages.import({ - * // Mark the email as permanently deleted (not TRASH) and - * // only visible in - * // Google Vault to - * // a Vault administrator. Only used for G Suite accounts. + * // Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. * deleted: 'placeholder-value', * // Source for Gmail's internal date of the message. * internalDateSource: 'placeholder-value', - * // Ignore the Gmail spam classifier decision and never mark - * // this email as SPAM in the mailbox. + * // Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox. * neverMarkSpam: 'placeholder-value', - * // Process calendar invites in the email and add any extracted - * // meetings to the Google Calendar for this user. + * // Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user. * processForCalendar: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -4234,7 +4191,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.deleted Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. + * @param {boolean=} params.deleted Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. * @param {string=} params.internalDateSource Source for Gmail's internal date of the message. * @param {boolean=} params.neverMarkSpam Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox. * @param {boolean=} params.processForCalendar Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user. @@ -4360,15 +4317,11 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.messages.insert({ - * // Mark the email as permanently deleted (not TRASH) and - * // only visible in - * // Google Vault to - * // a Vault administrator. Only used for G Suite accounts. + * // Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. * deleted: 'placeholder-value', * // Source for Gmail's internal date of the message. * internalDateSource: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -4416,7 +4369,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.deleted Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. + * @param {boolean=} params.deleted Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. * @param {string=} params.internalDateSource Source for Gmail's internal date of the message. * @param {string} params.userId The user's email address. The special value `me` can be used to indicate the authenticated user. * @param {object} params.requestBody Media resource metadata @@ -4541,8 +4494,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.messages.list({ - * // Include messages from `SPAM` and `TRASH` - * // in the results. + * // Include messages from `SPAM` and `TRASH` in the results. * includeSpamTrash: 'placeholder-value', * // Only return messages with labels that match all of the specified label IDs. * labelIds: 'placeholder-value', @@ -4550,14 +4502,9 @@ export namespace gmail_v1 { * maxResults: 'placeholder-value', * // Page token to retrieve a specific page of results in the list. * pageToken: 'placeholder-value', - * // Only return messages matching the specified query. Supports the same - * // query format as the Gmail search box. For example, - * // `"from:someuser@example.com rfc822msgid: - * // is:unread"`. Parameter cannot be used when accessing the api - * // using the gmail.metadata scope. + * // Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope. * q: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -4583,7 +4530,7 @@ export namespace gmail_v1 { * @param {string=} params.labelIds Only return messages with labels that match all of the specified label IDs. * @param {integer=} params.maxResults Maximum number of messages to return. * @param {string=} params.pageToken Page token to retrieve a specific page of results in the list. - * @param {string=} params.q Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope. + * @param {string=} params.q Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope. * @param {string} params.userId The user's email address. The special value `me` can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4705,8 +4652,7 @@ export namespace gmail_v1 { * const res = await gmail.users.messages.modify({ * // The ID of the message to modify. * id: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -4861,8 +4807,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.messages.send({ - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -5033,8 +4978,7 @@ export namespace gmail_v1 { * const res = await gmail.users.messages.trash({ * // The ID of the message to Trash. * id: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -5178,8 +5122,7 @@ export namespace gmail_v1 { * const res = await gmail.users.messages.untrash({ * // The ID of the message to remove from Trash. * id: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -5349,7 +5292,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Messages$Import extends StandardParameters { /** - * Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. + * Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. */ deleted?: boolean; /** @@ -5392,7 +5335,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Messages$Insert extends StandardParameters { /** - * Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. + * Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. */ deleted?: boolean; /** @@ -5443,7 +5386,7 @@ export namespace gmail_v1 { */ pageToken?: string; /** - * Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope. + * Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope. */ q?: string; /** @@ -5560,8 +5503,7 @@ export namespace gmail_v1 { * id: 'placeholder-value', * // The ID of the message containing the attachment. * messageId: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -5734,8 +5676,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.getAutoForwarding({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -5757,7 +5698,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5874,8 +5815,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.getImap({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -5898,7 +5838,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6014,8 +5954,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.getLanguage({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -6035,7 +5974,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6150,8 +6089,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.getPop({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -6172,7 +6110,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6288,8 +6226,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.getVacation({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -6316,7 +6253,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6401,7 +6338,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.updateAutoForwarding - * @desc Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -6426,8 +6363,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.updateAutoForwarding({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -6459,7 +6395,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().AutoForwarding} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6572,8 +6508,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.updateImap({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -6607,7 +6542,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().ImapSettings} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6694,7 +6629,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.updateLanguage - * @desc Updates language settings. If successful, the return object contains the `displayLanguage` that was saved for the user, which may differ from the value passed into the request. This is because the requested `displayLanguage` may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead. + * @desc Updates language settings. If successful, the return object contains the `displayLanguage` that was saved for the user, which may differ from the value passed into the request. This is because the requested `displayLanguage` may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead. * @example * // Before running the sample: * // - Enable the API at: @@ -6719,8 +6654,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.updateLanguage({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -6748,7 +6682,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().LanguageSettings} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6861,8 +6795,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.updatePop({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -6892,7 +6825,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().PopSettings} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7004,8 +6937,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.updateVacation({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -7047,7 +6979,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().VacationSettings} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7137,42 +7069,42 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Settings$Getautoforwarding extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Settings$Getimap extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Settings$Getlanguage extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Settings$Getpop extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Settings$Getvacation extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Settings$Updateautoforwarding extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -7184,7 +7116,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Settings$Updateimap extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -7196,7 +7128,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Settings$Updatelanguage extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -7208,7 +7140,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Settings$Updatepop extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -7220,7 +7152,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Settings$Updatevacation extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -7238,7 +7170,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.delegates.create - * @desc Adds a delegate with its verification status set directly to `accepted`, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Adds a delegate with its verification status set directly to `accepted`, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -7263,8 +7195,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.delegates.create({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -7294,7 +7225,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().Delegate} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7380,7 +7311,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.delegates.delete - * @desc Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -7407,8 +7338,7 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.delegates.delete({ * // The email address of the user to be removed as a delegate. * delegateEmail: 'placeholder-value', - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -7424,7 +7354,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.delegateEmail The email address of the user to be removed as a delegate. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7508,7 +7438,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.delegates.get - * @desc Gets the specified delegate. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Gets the specified delegate. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -7538,11 +7468,9 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.delegates.get({ - * // The email address of the user whose delegate relationship is to be - * // retrieved. + * // The email address of the user whose delegate relationship is to be retrieved. * delegateEmail: 'placeholder-value', - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -7564,7 +7492,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.delegateEmail The email address of the user whose delegate relationship is to be retrieved. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7650,7 +7578,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.delegates.list - * @desc Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -7680,8 +7608,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.delegates.list({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -7701,7 +7628,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7793,7 +7720,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Settings$Delegates$Create extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -7809,7 +7736,7 @@ export namespace gmail_v1 { */ delegateEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -7820,14 +7747,14 @@ export namespace gmail_v1 { */ delegateEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Settings$Delegates$List extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -7865,8 +7792,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.filters.create({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -8011,8 +7937,7 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.filters.delete({ * // The ID of the filter to be deleted. * id: 'placeholder-value', - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -8143,8 +8068,7 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.filters.get({ * // The ID of the filter to be fetched. * id: 'placeholder-value', - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -8282,8 +8206,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.filters.list({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -8440,7 +8363,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.forwardingAddresses.create - * @desc Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to `pending`; otherwise, the resource will be created with verification status set to `accepted`. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to `pending`; otherwise, the resource will be created with verification status set to `accepted`. This method is only available to service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -8465,8 +8388,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.forwardingAddresses.create({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -8496,7 +8418,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().ForwardingAddress} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8585,7 +8507,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.forwardingAddresses.delete - * @desc Deletes the specified forwarding address and revokes any verification that may have been required. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Deletes the specified forwarding address and revokes any verification that may have been required. This method is only available to service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -8612,8 +8534,7 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.forwardingAddresses.delete({ * // The forwarding address to be deleted. * forwardingEmail: 'placeholder-value', - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -8629,7 +8550,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.forwardingEmail The forwarding address to be deleted. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -8745,8 +8666,7 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.forwardingAddresses.get({ * // The forwarding address to be retrieved. * forwardingEmail: 'placeholder-value', - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -8768,7 +8688,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.forwardingEmail The forwarding address to be retrieved. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -8887,8 +8807,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.forwardingAddresses.list({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -8908,7 +8827,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9004,7 +8923,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Settings$Forwardingaddresses$Create extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -9020,7 +8939,7 @@ export namespace gmail_v1 { */ forwardingEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -9031,14 +8950,14 @@ export namespace gmail_v1 { */ forwardingEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Settings$Forwardingaddresses$List extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -9055,7 +8974,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.create - * @desc Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to `pending`; otherwise, the resource will be created with verification status set to `accepted`. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to `pending`; otherwise, the resource will be created with verification status set to `accepted`. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method is only available to service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -9080,8 +8999,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.sendAs.create({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -9125,7 +9043,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().SendAs} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9212,7 +9130,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.delete - * @desc Deletes the specified send-as alias. Revokes any verification that may have been required for using it. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Deletes the specified send-as alias. Revokes any verification that may have been required for using it. This method is only available to service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -9239,8 +9157,7 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.sendAs.delete({ * // The send-as alias to be deleted. * sendAsEmail: 'placeholder-value', - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -9256,7 +9173,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The send-as alias to be deleted. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9339,7 +9256,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.get - * @desc Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. + * @desc Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. * @example * // Before running the sample: * // - Enable the API at: @@ -9371,8 +9288,7 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.sendAs.get({ * // The send-as alias to be retrieved. * sendAsEmail: 'placeholder-value', - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -9401,7 +9317,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The send-as alias to be retrieved. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9486,7 +9402,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.list - * @desc Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases. + * @desc Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases. * @example * // Before running the sample: * // - Enable the API at: @@ -9516,8 +9432,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.sendAs.list({ - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -9537,7 +9452,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9656,8 +9571,7 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.sendAs.patch({ * // The send-as alias to be updated. * sendAsEmail: 'placeholder-value', - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -9702,7 +9616,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The send-as alias to be updated. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().SendAs} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9788,7 +9702,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.update - * @desc Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. + * @desc Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -9818,8 +9732,7 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.sendAs.update({ * // The send-as alias to be updated. * sendAsEmail: 'placeholder-value', - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -9864,7 +9777,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The send-as alias to be updated. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().SendAs} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9950,7 +9863,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.verify - * @desc Sends a verification email to the specified send-as alias address. The verification status must be `pending`. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Sends a verification email to the specified send-as alias address. The verification status must be `pending`. This method is only available to service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -9977,8 +9890,7 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.sendAs.verify({ * // The send-as alias to be verified. * sendAsEmail: 'placeholder-value', - * // User's email address. The special value "me" - * // can be used to indicate the authenticated user. + * // User's email address. The special value "me" can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -9994,7 +9906,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The send-as alias to be verified. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -10080,7 +9992,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Settings$Sendas$Create extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -10096,7 +10008,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -10107,14 +10019,14 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Settings$Sendas$List extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -10125,7 +10037,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -10141,7 +10053,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -10157,7 +10069,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -10200,11 +10112,9 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.sendAs.smimeInfo.delete({ * // The immutable ID for the SmimeInfo. * id: 'placeholder-value', - * // The email address that appears in the "From:" header for mail sent using - * // this alias. + * // The email address that appears in the "From:" header for mail sent using this alias. * sendAsEmail: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -10338,11 +10248,9 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.sendAs.smimeInfo.get({ * // The immutable ID for the SmimeInfo. * id: 'placeholder-value', - * // The email address that appears in the "From:" header for mail sent using - * // this alias. + * // The email address that appears in the "From:" header for mail sent using this alias. * sendAsEmail: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -10484,11 +10392,9 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.sendAs.smimeInfo.insert({ - * // The email address that appears in the "From:" header for mail sent using - * // this alias. + * // The email address that appears in the "From:" header for mail sent using this alias. * sendAsEmail: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -10647,11 +10553,9 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.sendAs.smimeInfo.list({ - * // The email address that appears in the "From:" header for mail sent using - * // this alias. + * // The email address that appears in the "From:" header for mail sent using this alias. * sendAsEmail: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -10793,11 +10697,9 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.sendAs.smimeInfo.setDefault({ * // The immutable ID for the SmimeInfo. * id: 'placeholder-value', - * // The email address that appears in the "From:" header for mail sent using - * // this alias. + * // The email address that appears in the "From:" header for mail sent using this alias. * sendAsEmail: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -11005,8 +10907,7 @@ export namespace gmail_v1 { * const res = await gmail.users.threads.delete({ * // ID of the Thread to delete. * id: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -11145,8 +11046,7 @@ export namespace gmail_v1 { * id: 'placeholder-value', * // When given and format is METADATA, only include headers specified. * metadataHeaders: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -11288,8 +11188,7 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.threads.list({ - * // Include threads from `SPAM` and `TRASH` - * // in the results. + * // Include threads from `SPAM` and `TRASH` in the results. * includeSpamTrash: 'placeholder-value', * // Only return threads with labels that match all of the specified label IDs. * labelIds: 'placeholder-value', @@ -11297,14 +11196,9 @@ export namespace gmail_v1 { * maxResults: 'placeholder-value', * // Page token to retrieve a specific page of results in the list. * pageToken: 'placeholder-value', - * // Only return threads matching the specified query. Supports the same - * // query format as the Gmail search box. For example, - * // `"from:someuser@example.com rfc822msgid: - * // is:unread"`. Parameter cannot be used when accessing the api - * // using the gmail.metadata scope. + * // Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope. * q: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -11330,7 +11224,7 @@ export namespace gmail_v1 { * @param {string=} params.labelIds Only return threads with labels that match all of the specified label IDs. * @param {integer=} params.maxResults Maximum number of threads to return. * @param {string=} params.pageToken Page token to retrieve a specific page of results in the list. - * @param {string=} params.q Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope. + * @param {string=} params.q Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope. * @param {string} params.userId The user's email address. The special value `me` can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -11450,8 +11344,7 @@ export namespace gmail_v1 { * const res = await gmail.users.threads.modify({ * // The ID of the thread to modify. * id: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -11600,8 +11493,7 @@ export namespace gmail_v1 { * const res = await gmail.users.threads.trash({ * // The ID of the thread to Trash. * id: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -11740,8 +11632,7 @@ export namespace gmail_v1 { * const res = await gmail.users.threads.untrash({ * // The ID of the thread to remove from Trash. * id: 'placeholder-value', - * // The user's email address. The special value `me` - * // can be used to indicate the authenticated user. + * // The user's email address. The special value `me` can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -11898,7 +11789,7 @@ export namespace gmail_v1 { */ pageToken?: string; /** - * Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope. + * Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope. */ q?: string; /** diff --git a/src/apis/osconfig/v1.ts b/src/apis/osconfig/v1.ts index bbe4f3e4d5..75c2085634 100644 --- a/src/apis/osconfig/v1.ts +++ b/src/apis/osconfig/v1.ts @@ -152,6 +152,44 @@ export namespace osconfig_v1 { * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} + /** + * A resource that contains custom validation and enforcement steps. + */ + export interface Schema$ExecResource { + /** + * What to run to bring this resource into the desired state. Optional if policy is in validate only mode. + */ + enforce?: Schema$ExecResourceExec; + /** + * What to run to validate this resource is in the desired state. A successful exit code indicates resource is in the desired state. + */ + validate?: Schema$ExecResourceExec; + } + /** + * A file or script to execute. + */ + export interface Schema$ExecResourceExec { + /** + * Exit codes that indicate success. + */ + allowedSuccessCodes?: number[] | null; + /** + * Arguments to use. + */ + args?: string[] | null; + /** + * A remote or local file. + */ + file?: Schema$File; + /** + * The script interpreter to use. + */ + interpreter?: string | null; + /** + * An inline script. + */ + script?: string | null; + } /** * A step that runs an executable for a PatchJob. */ @@ -219,6 +257,107 @@ export namespace osconfig_v1 { */ rollout?: Schema$PatchRollout; } + /** + * A resource that extracts an archive + */ + export interface Schema$ExtractArchiveResource { + /** + * Local file path that signals this resource is in the desired state. The absence of this file will indicate whether the archive needs to be extracted. + */ + creates?: string | null; + /** + * Directory to extract archive to. + */ + destination?: string | null; + /** + * Whether to overwrite existing files during extraction. If this is set to true, any existing files in the destination location will be overwritten by the extraction. + */ + overwrite?: boolean | null; + /** + * The source archive to extract. + */ + source?: Schema$File; + /** + * The type of the archive to extract. + */ + type?: string | null; + } + /** + * A remote or local file. + */ + export interface Schema$File { + /** + * Defaults to false. When false, files will be subject to validations based on the file type: Remote: A checksum must be specified. GCS: An object generation number must be specified. + */ + allowInsecure?: boolean | null; + /** + * A GCS object. + */ + gcs?: Schema$FileGcs; + /** + * A local path to use. + */ + localPath?: string | null; + /** + * A generic remote file. + */ + remote?: Schema$FileRemote; + } + /** + * Specifies a file available as a GCS Object. + */ + export interface Schema$FileGcs { + /** + * Bucket of the GCS object. + */ + bucket?: string | null; + /** + * Generation number of the GCS object. + */ + generation?: string | null; + /** + * Name of the GCS object. + */ + object?: string | null; + } + /** + * Specifies a file available via some URI. + */ + export interface Schema$FileRemote { + /** + * SHA256 checksum of the remote file. + */ + sha256Checksum?: string | null; + /** + * URI from which to fetch the object. It should contain both the protocol and path following the format {protocol}://{location}. + */ + uri?: string | null; + } + /** + * A resource that manages the state of a file. + */ + export interface Schema$FileResource { + /** + * A a file with this content. + */ + content?: string | null; + /** + * A remote or local source. + */ + file?: Schema$File; + /** + * The absolute path of the file. + */ + path?: string | null; + /** + * Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4 + */ + permissions?: string | null; + /** + * Desired state of the file. + */ + state?: string | null; + } /** * Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. */ @@ -314,6 +453,122 @@ export namespace osconfig_v1 { */ executeTime?: string | null; } + /** + * A resource that manages a system package. + */ + export interface Schema$PackageResource { + /** + * A package managed by Apt. + */ + apt?: Schema$PackageResourceAPT; + /** + * A deb package file. + */ + deb?: Schema$PackageResourceDeb; + /** + * The desired_state the agent should maintain for this package. The default is to ensure the package is installed. + */ + desiredState?: string | null; + /** + * A package managed by GooGet. + */ + googet?: Schema$PackageResourceGooGet; + /** + * An MSI package. + */ + msi?: Schema$PackageResourceMSI; + /** + * An rpm package file. + */ + rpm?: Schema$PackageResourceRPM; + /** + * A package managed by YUM. + */ + yum?: Schema$PackageResourceYUM; + /** + * A package managed by Zypper. + */ + zypper?: Schema$PackageResourceZypper; + } + /** + * A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` + */ + export interface Schema$PackageResourceAPT { + /** + * Package name. + */ + name?: string | null; + } + /** + * A deb package file. dpkg packages only support INSTALLED state. + */ + export interface Schema$PackageResourceDeb { + /** + * Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb` + */ + pullDeps?: boolean | null; + /** + * A deb package. + */ + source?: Schema$File; + } + /** + * A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` + */ + export interface Schema$PackageResourceGooGet { + /** + * Package name. + */ + name?: string | null; + } + /** + * An MSI package. MSI packages only support INSTALLED state. Install msiexec /i /qn /norestart + */ + export interface Schema$PackageResourceMSI { + /** + * Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] + */ + allowedSuccessCodes?: number[] | null; + /** + * Flags to use during package install. Appended to the defalts of "/i /qn /norestart" + */ + flags?: string[] | null; + /** + * The MSI package. + */ + source?: Schema$File; + } + /** + * An RPM package file. RPM packages only support INSTALLED state. + */ + export interface Schema$PackageResourceRPM { + /** + * Whether dependencies should also be installed. install when false: `rpm --upgrade --replacepkgs package.rpm` install when true: `yum -y install package.rpm` or `zypper -y install package.rpm` + */ + pullDeps?: boolean | null; + /** + * An rpm package. + */ + source?: Schema$File; + } + /** + * A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` + */ + export interface Schema$PackageResourceYUM { + /** + * Package name. + */ + name?: string | null; + } + /** + * A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` + */ + export interface Schema$PackageResourceZypper { + /** + * Package name. + */ + name?: string | null; + } /** * Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. */ @@ -643,6 +898,111 @@ export namespace osconfig_v1 { */ weekly?: Schema$WeeklySchedule; } + /** + * A resource that manages a package repository. + */ + export interface Schema$RepositoryResource { + /** + * An Apt Repository. + */ + apt?: Schema$RepositoryResourceAptRepository; + /** + * A Goo Repository. + */ + goo?: Schema$RepositoryResourceGooRepository; + /** + * A Yum Repository. + */ + yum?: Schema$RepositoryResourceYumRepository; + /** + * A Zypper Repository. + */ + zypper?: Schema$RepositoryResourceZypperRepository; + } + /** + * Represents a single apt package repository. These will be added to a repo file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. + */ + export interface Schema$RepositoryResourceAptRepository { + /** + * Type of archive files in this repository. The default behavior is DEB. + */ + archiveType?: string | null; + /** + * List of components for this repository. Must contain at least one item. + */ + components?: string[] | null; + /** + * Distribution of this repository. + */ + distribution?: string | null; + /** + * URI of the key file for this repository. The agent will maintain a keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg. + */ + gpgKey?: string | null; + /** + * URI for this repository. + */ + uri?: string | null; + } + /** + * Represents a Goo package repository. These will be added to a repo file that will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo. + */ + export interface Schema$RepositoryResourceGooRepository { + /** + * The name of the repository. + */ + name?: string | null; + /** + * The url of the repository. + */ + url?: string | null; + } + /** + * Represents a single yum package repository. These will be added to a repo file that will be managed at /etc/yum.repos.d/google_osconfig.repo. + */ + export interface Schema$RepositoryResourceYumRepository { + /** + * The location of the repository directory. + */ + baseUrl?: string | null; + /** + * The display name of the repository. + */ + displayName?: string | null; + /** + * URIs of GPG keys. + */ + gpgKeys?: string[] | null; + /** + * A one word, unique name for this repository. This will be the `repo id` in the yum config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for resource conflicts. + */ + id?: string | null; + } + /** + * Represents a single zypper package repository. These will be added to a repo file that will be managed at /etc/zypp/repos.d/google_osconfig.repo. + */ + export interface Schema$RepositoryResourceZypperRepository { + /** + * The location of the repository directory. + */ + baseUrl?: string | null; + /** + * The display name of the repository. + */ + displayName?: string | null; + /** + * URIs of GPG keys. + */ + gpgKeys?: string[] | null; + /** + * A one word, unique name for this repository. This will be the `repo id` in the zypper config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for GuestPolicy conflicts. + */ + id?: string | null; + } + /** + * A resource that manages a system service. + */ + export interface Schema$ServiceResource {} /** * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. */ diff --git a/src/apis/osconfig/v1beta.ts b/src/apis/osconfig/v1beta.ts index 98198ed0da..890e6bbb4f 100644 --- a/src/apis/osconfig/v1beta.ts +++ b/src/apis/osconfig/v1beta.ts @@ -284,6 +284,44 @@ export namespace osconfig_v1beta { * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} + /** + * A resource that contains custom validation and enforcement steps. + */ + export interface Schema$ExecResource { + /** + * What to run to bring this resource into the desired state. Optional if policy is in validate only mode. + */ + enforce?: Schema$ExecResourceExec; + /** + * What to run to validate this resource is in the desired state. A successful exit code indicates resource is in the desired state. + */ + validate?: Schema$ExecResourceExec; + } + /** + * A file or script to execute. + */ + export interface Schema$ExecResourceExec { + /** + * Exit codes that indicate success. + */ + allowedSuccessCodes?: number[] | null; + /** + * Arguments to use. + */ + args?: string[] | null; + /** + * A remote or local file. + */ + file?: Schema$File; + /** + * The script interpreter to use. + */ + interpreter?: string | null; + /** + * An inline script. + */ + script?: string | null; + } /** * A step that runs an executable for a PatchJob. */ @@ -351,6 +389,107 @@ export namespace osconfig_v1beta { */ rollout?: Schema$PatchRollout; } + /** + * A resource that extracts an archive + */ + export interface Schema$ExtractArchiveResource { + /** + * Local file path that signals this resource is in the desired state. The absence of this file will indicate whether the archive needs to be extracted. + */ + creates?: string | null; + /** + * Directory to extract archive to. + */ + destination?: string | null; + /** + * Whether to overwrite existing files during extraction. If this is set to true, any existing files in the destination location will be overwritten by the extraction. + */ + overwrite?: boolean | null; + /** + * The source archive to extract. + */ + source?: Schema$File; + /** + * The type of the archive to extract. + */ + type?: string | null; + } + /** + * A remote or local file. + */ + export interface Schema$File { + /** + * Defaults to false. When false, files will be subject to validations based on the file type: Remote: A checksum must be specified. GCS: An object generation number must be specified. + */ + allowInsecure?: boolean | null; + /** + * A GCS object. + */ + gcs?: Schema$FileGcs; + /** + * A local path to use. + */ + localPath?: string | null; + /** + * A generic remote file. + */ + remote?: Schema$FileRemote; + } + /** + * Specifies a file available as a GCS Object. + */ + export interface Schema$FileGcs { + /** + * Bucket of the GCS object. + */ + bucket?: string | null; + /** + * Generation number of the GCS object. + */ + generation?: string | null; + /** + * Name of the GCS object. + */ + object?: string | null; + } + /** + * Specifies a file available via some URI. + */ + export interface Schema$FileRemote { + /** + * SHA256 checksum of the remote file. + */ + sha256Checksum?: string | null; + /** + * URI from which to fetch the object. It should contain both the protocol and path following the format {protocol}://{location}. + */ + uri?: string | null; + } + /** + * A resource that manages the state of a file. + */ + export interface Schema$FileResource { + /** + * A a file with this content. + */ + content?: string | null; + /** + * A remote or local source. + */ + file?: Schema$File; + /** + * The absolute path of the file. + */ + path?: string | null; + /** + * Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4 + */ + permissions?: string | null; + /** + * Desired state of the file. + */ + state?: string | null; + } /** * Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. */ @@ -568,6 +707,122 @@ export namespace osconfig_v1beta { */ zypper?: Schema$ZypperRepository; } + /** + * A resource that manages a system package. + */ + export interface Schema$PackageResource { + /** + * A package managed by Apt. + */ + apt?: Schema$PackageResourceAPT; + /** + * A deb package file. + */ + deb?: Schema$PackageResourceDeb; + /** + * The desired_state the agent should maintain for this package. The default is to ensure the package is installed. + */ + desiredState?: string | null; + /** + * A package managed by GooGet. + */ + googet?: Schema$PackageResourceGooGet; + /** + * An MSI package. + */ + msi?: Schema$PackageResourceMSI; + /** + * An rpm package file. + */ + rpm?: Schema$PackageResourceRPM; + /** + * A package managed by YUM. + */ + yum?: Schema$PackageResourceYUM; + /** + * A package managed by Zypper. + */ + zypper?: Schema$PackageResourceZypper; + } + /** + * A package managed by APT. install: `apt-get update && apt-get -y install [name]` remove: `apt-get -y remove [name]` + */ + export interface Schema$PackageResourceAPT { + /** + * Package name. + */ + name?: string | null; + } + /** + * A deb package file. dpkg packages only support INSTALLED state. + */ + export interface Schema$PackageResourceDeb { + /** + * Whether dependencies should also be installed. install when false: `dpkg -i package` install when true: `apt-get update && apt-get -y install package.deb` + */ + pullDeps?: boolean | null; + /** + * A deb package. + */ + source?: Schema$File; + } + /** + * A package managed by GooGet. install: `googet -noconfirm install package` remove: `googet -noconfirm remove package` + */ + export interface Schema$PackageResourceGooGet { + /** + * Package name. + */ + name?: string | null; + } + /** + * An MSI package. MSI packages only support INSTALLED state. Install msiexec /i /qn /norestart + */ + export interface Schema$PackageResourceMSI { + /** + * Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] + */ + allowedSuccessCodes?: number[] | null; + /** + * Flags to use during package install. Appended to the defalts of "/i /qn /norestart" + */ + flags?: string[] | null; + /** + * The MSI package. + */ + source?: Schema$File; + } + /** + * An RPM package file. RPM packages only support INSTALLED state. + */ + export interface Schema$PackageResourceRPM { + /** + * Whether dependencies should also be installed. install when false: `rpm --upgrade --replacepkgs package.rpm` install when true: `yum -y install package.rpm` or `zypper -y install package.rpm` + */ + pullDeps?: boolean | null; + /** + * An rpm package. + */ + source?: Schema$File; + } + /** + * A package managed by YUM. install: `yum -y install package` remove: `yum -y remove package` + */ + export interface Schema$PackageResourceYUM { + /** + * Package name. + */ + name?: string | null; + } + /** + * A package managed by Zypper. install: `zypper -y install package` remove: `zypper -y rm package` + */ + export interface Schema$PackageResourceZypper { + /** + * Package name. + */ + name?: string | null; + } /** * Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. */ @@ -897,6 +1152,111 @@ export namespace osconfig_v1beta { */ weekly?: Schema$WeeklySchedule; } + /** + * A resource that manages a package repository. + */ + export interface Schema$RepositoryResource { + /** + * An Apt Repository. + */ + apt?: Schema$RepositoryResourceAptRepository; + /** + * A Goo Repository. + */ + goo?: Schema$RepositoryResourceGooRepository; + /** + * A Yum Repository. + */ + yum?: Schema$RepositoryResourceYumRepository; + /** + * A Zypper Repository. + */ + zypper?: Schema$RepositoryResourceZypperRepository; + } + /** + * Represents a single apt package repository. These will be added to a repo file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. + */ + export interface Schema$RepositoryResourceAptRepository { + /** + * Type of archive files in this repository. The default behavior is DEB. + */ + archiveType?: string | null; + /** + * List of components for this repository. Must contain at least one item. + */ + components?: string[] | null; + /** + * Distribution of this repository. + */ + distribution?: string | null; + /** + * URI of the key file for this repository. The agent will maintain a keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg. + */ + gpgKey?: string | null; + /** + * URI for this repository. + */ + uri?: string | null; + } + /** + * Represents a Goo package repository. These will be added to a repo file that will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo. + */ + export interface Schema$RepositoryResourceGooRepository { + /** + * The name of the repository. + */ + name?: string | null; + /** + * The url of the repository. + */ + url?: string | null; + } + /** + * Represents a single yum package repository. These will be added to a repo file that will be managed at /etc/yum.repos.d/google_osconfig.repo. + */ + export interface Schema$RepositoryResourceYumRepository { + /** + * The location of the repository directory. + */ + baseUrl?: string | null; + /** + * The display name of the repository. + */ + displayName?: string | null; + /** + * URIs of GPG keys. + */ + gpgKeys?: string[] | null; + /** + * A one word, unique name for this repository. This will be the `repo id` in the yum config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for resource conflicts. + */ + id?: string | null; + } + /** + * Represents a single zypper package repository. These will be added to a repo file that will be managed at /etc/zypp/repos.d/google_osconfig.repo. + */ + export interface Schema$RepositoryResourceZypperRepository { + /** + * The location of the repository directory. + */ + baseUrl?: string | null; + /** + * The display name of the repository. + */ + displayName?: string | null; + /** + * URIs of GPG keys. + */ + gpgKeys?: string[] | null; + /** + * A one word, unique name for this repository. This will be the `repo id` in the zypper config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for GuestPolicy conflicts. + */ + id?: string | null; + } + /** + * A resource that manages a system service. + */ + export interface Schema$ServiceResource {} /** * A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is `UPDATED`, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step. */ diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index 4b2d31dbb8..7482d2a6a9 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -514,6 +514,10 @@ export namespace pubsub_v1 { * A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Cloud Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. */ deadLetterPolicy?: Schema$DeadLetterPolicy; + /** + * Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made. + */ + detached?: boolean | null; /** * If true, messages published with the same `ordering_key` in `PubsubMessage` will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. */ @@ -2090,6 +2094,7 @@ export namespace pubsub_v1 { * // { * // "ackDeadlineSeconds": 0, * // "deadLetterPolicy": {}, + * // "detached": false, * // "enableMessageOrdering": false, * // "expirationPolicy": {}, * // "filter": "my_filter", @@ -2109,6 +2114,7 @@ export namespace pubsub_v1 { * // { * // "ackDeadlineSeconds": 0, * // "deadLetterPolicy": {}, + * // "detached": false, * // "enableMessageOrdering": false, * // "expirationPolicy": {}, * // "filter": "my_filter", @@ -2526,6 +2532,7 @@ export namespace pubsub_v1 { * // { * // "ackDeadlineSeconds": 0, * // "deadLetterPolicy": {}, + * // "detached": false, * // "enableMessageOrdering": false, * // "expirationPolicy": {}, * // "filter": "my_filter", @@ -3272,6 +3279,7 @@ export namespace pubsub_v1 { * // { * // "ackDeadlineSeconds": 0, * // "deadLetterPolicy": {}, + * // "detached": false, * // "enableMessageOrdering": false, * // "expirationPolicy": {}, * // "filter": "my_filter", diff --git a/src/apis/recommendationengine/v1beta1.ts b/src/apis/recommendationengine/v1beta1.ts index 6b48ae066a..fd65184225 100644 --- a/src/apis/recommendationengine/v1beta1.ts +++ b/src/apis/recommendationengine/v1beta1.ts @@ -128,7 +128,7 @@ export namespace recommendationengine_v1beta1 { } /** - * Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. + * Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. */ export interface Schema$GoogleApiHttpBody { /** @@ -175,7 +175,7 @@ export namespace recommendationengine_v1beta1 { */ export interface Schema$GoogleCloudRecommendationengineV1beta1BigQuerySource { /** - * Optional. The schema to use when parsing the data from the source. Supported values for catalog imports: 1: "catalog_recommendations_ai" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#json (Default for catalogItems.import) 2: "catalog_merchant_center" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc Supported values for user event imports: 1: "user_events_recommendations_ai" using https://cloud.google.com/recommendations-ai/docs/manage-user-events#import (Default for userEvents.import) + * Optional. The schema to use when parsing the data from the source. Supported values for catalog imports: 1: "catalog_recommendations_ai" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#json (Default for catalogItems.import) 2: "catalog_merchant_center" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc Supported values for user event imports: 1: "user_events_recommendations_ai" using https://cloud.google.com/recommendations-ai/docs/manage-user-events#import (Default for userEvents.import) */ dataSchema?: string | null; /** @@ -204,7 +204,7 @@ export namespace recommendationengine_v1beta1 { */ catalogItemLevelConfig?: Schema$GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig; /** - * Required. The id of the default event store. + * Required. The ID of the default event store. */ defaultEventStoreId?: string | null; /** @@ -230,7 +230,7 @@ export namespace recommendationengine_v1beta1 { */ export interface Schema$GoogleCloudRecommendationengineV1beta1CatalogItem { /** - * Required. Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categoryHierarchies": [ { "categories": ["Shoes & Accessories", "Shoes"]}, { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] } ] + * Required. Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categoryHierarchies": [ { "categories": ["Shoes & Accessories", "Shoes"]}, { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] } ] */ categoryHierarchies?: Schema$GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy[]; /** @@ -238,7 +238,7 @@ export namespace recommendationengine_v1beta1 { */ description?: string | null; /** - * Required. Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog. + * Required. Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog. */ id?: string | null; /** @@ -246,7 +246,7 @@ export namespace recommendationengine_v1beta1 { */ itemAttributes?: Schema$GoogleCloudRecommendationengineV1beta1FeatureMap; /** - * Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id). + * Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id). */ itemGroupId?: string | null; /** @@ -258,7 +258,7 @@ export namespace recommendationengine_v1beta1 { */ productMetadata?: Schema$GoogleCloudRecommendationengineV1beta1ProductCatalogItem; /** - * Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter. + * Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter. */ tags?: string[] | null; /** @@ -271,20 +271,20 @@ export namespace recommendationengine_v1beta1 { */ export interface Schema$GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy { /** - * Required. Catalog item categories. Each category should be a UTF-8 encoded string with a length limit of 2 KiB. Note that the order in the list denotes the specificity (from least to most specific). + * Required. Catalog item categories. Each category should be a UTF-8 encoded string with a length limit of 2 KiB. Note that the order in the list denotes the specificity (from least to most specific). */ categories?: string[] | null; } /** - * Configures what level the catalog should be uploaded with regards to how users will be send events and how predictions will be made. + * Configures the catalog level that users send events to, and the level at which predictions are made. */ export interface Schema$GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig { /** - * Optional. What level of the catalog are events uploaded at. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details. + * Optional. Level of the catalog at which events are uploaded. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details. */ eventItemLevel?: string | null; /** - * Optional. What level of the catalog are predictions made at. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details. + * Optional. Level of the catalog at which predictions are made. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details. */ predictItemLevel?: string | null; } @@ -302,7 +302,7 @@ export namespace recommendationengine_v1beta1 { */ export interface Schema$GoogleCloudRecommendationengineV1beta1EventDetail { /** - * Optional. Extra user event features to include in the recommendation model. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc. + * Optional. Extra user event features to include in the recommendation model. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc. */ eventAttributes?: Schema$GoogleCloudRecommendationengineV1beta1FeatureMap; /** @@ -314,7 +314,7 @@ export namespace recommendationengine_v1beta1 { */ pageViewId?: string | null; /** - * Optional. Recommendation token included in the recommendation prediction response. This field enables accurate attribution of recommendation model performance. This token enables us to accurately attribute page view or purchase back to the event and the particular predict response containing this clicked/purchased item. If user clicks on product K in the recommendation results, pass the `PredictResponse.recommendationToken` property as a url parameter to product K's page. When recording events on product K's page, log the PredictResponse.recommendation_token to this field. Optional, but highly encouraged for user events that are the result of a recommendation prediction query. + * Optional. Recommendation token included in the recommendation prediction response. This field enables accurate attribution of recommendation model performance. This token enables us to accurately attribute page view or purchase back to the event and the particular predict response containing this clicked/purchased item. If user clicks on product K in the recommendation results, pass the `PredictResponse.recommendationToken` property as a url parameter to product K's page. When recording events on product K's page, log the PredictResponse.recommendation_token to this field. Optional, but highly encouraged for user events that are the result of a recommendation prediction query. */ recommendationToken?: string | null; /** @@ -331,7 +331,7 @@ export namespace recommendationengine_v1beta1 { */ export interface Schema$GoogleCloudRecommendationengineV1beta1FeatureMap { /** - * Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer. Feature names and values must be UTF-8 encoded strings. For example: `{ "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}` + * Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer. Feature names and values must be UTF-8 encoded strings. For example: `{ "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}` */ categoricalFeatures?: { [ @@ -339,7 +339,7 @@ export namespace recommendationengine_v1beta1 { ]: Schema$GoogleCloudRecommendationengineV1beta1FeatureMapStringList; } | null; /** - * Numerical features. Some examples would be the height/weight of a product, or age of a customer. Feature names must be UTF-8 encoded strings. For example: `{ "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }` + * Numerical features. Some examples would be the height/weight of a product, or age of a customer. Feature names must be UTF-8 encoded strings. For example: `{ "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }` */ numericalFeatures?: { [ @@ -374,23 +374,10 @@ export namespace recommendationengine_v1beta1 { */ inputUris?: string[] | null; /** - * Optional. The schema to use when parsing the data from the source. Supported values for catalog imports: 1: "catalog_recommendations_ai" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#json (Default for catalogItems.import) 2: "catalog_merchant_center" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc Supported values for user events imports: 1: "user_events_recommendations_ai" using https://cloud.google.com/recommendations-ai/docs/manage-user-events#import (Default for userEvents.import) + * Optional. The schema to use when parsing the data from the source. Supported values for catalog imports: 1: "catalog_recommendations_ai" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#json (Default for catalogItems.import) 2: "catalog_merchant_center" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc Supported values for user events imports: 1: "user_events_recommendations_ai" using https://cloud.google.com/recommendations-ai/docs/manage-user-events#import (Default for userEvents.import) */ jsonSchema?: string | null; } - /** - * Response message for GetCatalogItemsWithItemGroupId method. - */ - export interface Schema$GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse { - /** - * The canonical catalog item representing all items associated with the item group id. - */ - canonicalCatalogItem?: Schema$GoogleCloudRecommendationengineV1beta1CatalogItem; - /** - * The list of catalog items associated with the item group id. - */ - catalogItems?: Schema$GoogleCloudRecommendationengineV1beta1CatalogItem[]; - } /** * Catalog item thumbnail/detail image. */ @@ -605,11 +592,11 @@ export namespace recommendationengine_v1beta1 { */ dryRun?: boolean | null; /** - * Optional. Filter for restricting prediction results. Accepts values for tags and the `filterOutOfStockItems` flag. * Tag expressions. Restricts predictions to items that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. `-"tagA"` is also supported and is equivalent to `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings with a size limit of 1 KiB. * filterOutOfStockItems. Restricts predictions to items that do not have a stockState value of OUT_OF_STOCK. Examples: * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") * filterOutOfStockItems tag=(-"promotional") * filterOutOfStockItems If your filter blocks all prediction results, nothing will be returned. If you want generic (unfiltered) popular items to be returned instead, set `strictFiltering` to false in `PredictRequest.params`. + * Optional. Filter for restricting prediction results. Accepts values for tags and the `filterOutOfStockItems` flag. * Tag expressions. Restricts predictions to items that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. `-"tagA"` is also supported and is equivalent to `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings with a size limit of 1 KiB. * filterOutOfStockItems. Restricts predictions to items that do not have a stockState value of OUT_OF_STOCK. Examples: * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") * filterOutOfStockItems tag=(-"promotional") * filterOutOfStockItems If your filter blocks all prediction results, nothing will be returned. If you want generic (unfiltered) popular items to be returned instead, set `strictFiltering` to false in `PredictRequest.params`. */ filter?: string | null; /** - * Optional. The labels for the predict request. * Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels. + * Optional. The labels for the predict request. * Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels. */ labels?: {[key: string]: string} | null; /** @@ -621,7 +608,7 @@ export namespace recommendationengine_v1beta1 { */ pageToken?: string | null; /** - * Optional. Additional domain specific parameters for the predictions. Allowed values: * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem object will be returned in the `PredictResponse.PredictionResult.itemMetadata` object in the method response. * `returnItemScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in the `metadata` field in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular items instead of empty if your filter blocks all prediction results. + * Optional. Additional domain specific parameters for the predictions. Allowed values: * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem object will be returned in the `PredictResponse.PredictionResult.itemMetadata` object in the method response. * `returnItemScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in the `metadata` field in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular items instead of empty if your filter blocks all prediction results. */ params?: {[key: string]: any} | null; /** @@ -667,7 +654,7 @@ export namespace recommendationengine_v1beta1 { */ id?: string | null; /** - * Additional item metadata / annotations. Possible values: * `catalogItem`: JSON representation of the catalogItem. Will be set if `returnCatalogItem` is set to true in `PredictRequest.params`. * `score`: Prediction score in double value. Will be set if `returnItemScore` is set to true in `PredictRequest.params`. + * Additional item metadata / annotations. Possible values: * `catalogItem`: JSON representation of the catalogItem. Will be set if `returnCatalogItem` is set to true in `PredictRequest.params`. * `score`: Prediction score in double value. Will be set if `returnItemScore` is set to true in `PredictRequest.params`. */ itemMetadata?: {[key: string]: any} | null; } @@ -684,7 +671,7 @@ export namespace recommendationengine_v1beta1 { */ canonicalProductUri?: string | null; /** - * Optional. A map to pass the costs associated with the product. For example: {"manufacturing": 45.5} The profit of selling this item is computed like so: * If 'exactPrice' is provided, profit = displayPrice - sum(costs) * If 'priceRange' is provided, profit = minPrice - sum(costs) + * Optional. A map to pass the costs associated with the product. For example: {"manufacturing": 45.5} The profit of selling this item is computed like so: * If 'exactPrice' is provided, profit = displayPrice - sum(costs) * If 'priceRange' is provided, profit = minPrice - sum(costs) */ costs?: {[key: string]: number} | null; /** @@ -739,7 +726,7 @@ export namespace recommendationengine_v1beta1 { */ export interface Schema$GoogleCloudRecommendationengineV1beta1ProductDetail { /** - * Optional. Quantity of the products in stock when a user event happens. Optional. If provided, this overrides the available quantity in Catalog for this event. and can only be set if `stock_status` is set to `IN_STOCK`. Note that if an item is out of stock, you must set the `stock_state` field to be `OUT_OF_STOCK`. Leaving this field unspecified / as zero is not sufficient to mark the item out of stock. + * Optional. Quantity of the products in stock when a user event happens. Optional. If provided, this overrides the available quantity in Catalog for this event. and can only be set if `stock_status` is set to `IN_STOCK`. Note that if an item is out of stock, you must set the `stock_state` field to be `OUT_OF_STOCK`. Leaving this field unspecified / as zero is not sufficient to mark the item out of stock. */ availableQuantity?: number | null; /** @@ -776,7 +763,7 @@ export namespace recommendationengine_v1beta1 { */ export interface Schema$GoogleCloudRecommendationengineV1beta1ProductEventDetail { /** - * Optional. The id or name of the associated shopping cart. This id is used to associate multiple items added or present in the cart before purchase. This can only be set for `add-to-cart`, `remove-from-cart`, `checkout-start`, `purchase-complete`, or `shopping-cart-page-view` events. + * Optional. The id or name of the associated shopping cart. This id is used to associate multiple items added or present in the cart before purchase. This can only be set for `add-to-cart`, `remove-from-cart`, `checkout-start`, `purchase-complete`, or `shopping-cart-page-view` events. */ cartId?: string | null; /** @@ -788,7 +775,7 @@ export namespace recommendationengine_v1beta1 { */ pageCategories?: Schema$GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy[]; /** - * The main product details related to the event. This field is required for the following event types: * `add-to-cart` * `add-to-list` * `checkout-start` * `detail-page-view` * `purchase-complete` * `refund` * `remove-from-cart` * `remove-from-list` This field is optional for the following event types: * `page-visit` * `shopping-cart-page-view` - note that 'product_details' should be set for this unless the shopping cart is empty. * `search` (highly encouraged) In a `search` event, this field represents the products returned to the end user on the current page (the end user may have not finished broswing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new SEARCH event with different product_details is desired. The end user may have not finished broswing the whole page yet. This field is not allowed for the following event types: * `category-page-view` * `home-page-view` + * The main product details related to the event. This field is required for the following event types: * `add-to-cart` * `add-to-list` * `checkout-start` * `detail-page-view` * `purchase-complete` * `refund` * `remove-from-cart` * `remove-from-list` This field is optional for the following event types: * `page-visit` * `shopping-cart-page-view` - note that 'product_details' should be set for this unless the shopping cart is empty. * `search` (highly encouraged) In a `search` event, this field represents the products returned to the end user on the current page (the end user may have not finished broswing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new SEARCH event with different product_details is desired. The end user may have not finished broswing the whole page yet. This field is not allowed for the following event types: * `category-page-view` * `home-page-view` */ productDetails?: Schema$GoogleCloudRecommendationengineV1beta1ProductDetail[]; /** @@ -805,7 +792,7 @@ export namespace recommendationengine_v1beta1 { */ export interface Schema$GoogleCloudRecommendationengineV1beta1PurchaseTransaction { /** - * Optional. All the costs associated with the product. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs. Total product cost such that profit = revenue - (sum(taxes) + sum(costs)) If product_cost is not set, then profit = revenue - tax - shipping - sum(CatalogItem.costs). If CatalogItem.cost is not specified for one of the items, CatalogItem.cost based profit *cannot* be calculated for this Transaction. + * Optional. All the costs associated with the product. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs. Total product cost such that profit = revenue - (sum(taxes) + sum(costs)) If product_cost is not set, then profit = revenue - tax - shipping - sum(CatalogItem.costs). If CatalogItem.cost is not specified for one of the items, CatalogItem.cost based profit *cannot* be calculated for this Transaction. */ costs?: {[key: string]: number} | null; /** @@ -843,7 +830,7 @@ export namespace recommendationengine_v1beta1 { */ export interface Schema$GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest { /** - * Required. The filter string to specify the events to be deleted. Empty string filter is not allowed. The eligible fields for filtering are: * `eventType`: UserEvent.eventType field of type string. * `eventTime`: in ISO 8601 "zulu" format. * `visitorId`: field of type string. Specifying this will delete all events associated with a visitor. * `userId`: field of type string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Deleting specific eventType in time range: `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"` * Deleting all events for a specific visitor: `visitorId = "visitor1024"` The filtering fields are assumed to have an implicit AND. + * Required. The filter string to specify the events to be deleted. Empty string filter is not allowed. The eligible fields for filtering are: * `eventType`: UserEvent.eventType field of type string. * `eventTime`: in ISO 8601 "zulu" format. * `visitorId`: field of type string. Specifying this will delete all events associated with a visitor. * `userId`: field of type string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Deleting specific eventType in time range: `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"` * Deleting all events for a specific visitor: `visitorId = "visitor1024"` The filtering fields are assumed to have an implicit AND. */ filter?: string | null; /** @@ -890,11 +877,11 @@ export namespace recommendationengine_v1beta1 { */ eventTime?: string | null; /** - * Required. User event type. Allowed values are: * `add-to-cart` Products being added to cart. * `add-to-list` Items being added to a list (shopping list, favorites etc). * `category-page-view` Special pages such as sale or promotion pages viewed. * `checkout-start` User starting a checkout process. * `detail-page-view` Products detail page viewed. * `home-page-view` Homepage viewed. * `page-visit` Generic page visits not included in the event types above. * `purchase-complete` User finishing a purchase. * `refund` Purchased items being refunded or returned. * `remove-from-cart` Products being removed from cart. * `remove-from-list` Items being removed from a list. * `search` Product search. * `shopping-cart-page-view` User viewing a shopping cart. * `impression` List of items displayed. Used by Google Tag Manager. + * Required. User event type. Allowed values are: * `add-to-cart` Products being added to cart. * `add-to-list` Items being added to a list (shopping list, favorites etc). * `category-page-view` Special pages such as sale or promotion pages viewed. * `checkout-start` User starting a checkout process. * `detail-page-view` Products detail page viewed. * `home-page-view` Homepage viewed. * `page-visit` Generic page visits not included in the event types above. * `purchase-complete` User finishing a purchase. * `refund` Purchased items being refunded or returned. * `remove-from-cart` Products being removed from cart. * `remove-from-list` Items being removed from a list. * `search` Product search. * `shopping-cart-page-view` User viewing a shopping cart. * `impression` List of items displayed. Used by Google Tag Manager. */ eventType?: string | null; /** - * Optional. Retail product specific user event metadata. This field is required for the following event types: * `add-to-cart` * `add-to-list` * `category-page-view` * `checkout-start` * `detail-page-view` * `purchase-complete` * `refund` * `remove-from-cart` * `remove-from-list` * `search` This field is optional for the following event types: * `page-visit` * `shopping-cart-page-view` - note that 'product_event_detail' should be set for this unless the shopping cart is empty. This field is not allowed for the following event types: * `home-page-view` + * Optional. Retail product specific user event metadata. This field is required for the following event types: * `add-to-cart` * `add-to-list` * `category-page-view` * `checkout-start` * `detail-page-view` * `purchase-complete` * `refund` * `remove-from-cart` * `remove-from-list` * `search` This field is optional for the following event types: * `page-visit` * `shopping-cart-page-view` - note that 'product_event_detail' should be set for this unless the shopping cart is empty. This field is not allowed for the following event types: * `home-page-view` */ productEventDetail?: Schema$GoogleCloudRecommendationengineV1beta1ProductEventDetail; /** @@ -937,7 +924,7 @@ export namespace recommendationengine_v1beta1 { */ ipAddress?: string | null; /** - * Optional. User agent as included in the HTTP header. UTF-8 encoded string with a length limit of 1 KiB. This should *not* be set when using the JavaScript pixel or if `directUserRequest` is set. + * Optional. User agent as included in the HTTP header. UTF-8 encoded string with a length limit of 1 KiB. This should *not* be set when using the JavaScript pixel or if `directUserRequest` is set. */ userAgent?: string | null; /** @@ -945,7 +932,7 @@ export namespace recommendationengine_v1beta1 { */ userId?: string | null; /** - * Required. A unique identifier for tracking visitors with a length limit of 128 bytes. For example, this could be implemented with a http cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Maximum length 128 bytes. Cannot be empty. + * Required. A unique identifier for tracking visitors with a length limit of 128 bytes. For example, this could be implemented with a http cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Maximum length 128 bytes. Cannot be empty. */ visitorId?: string | null; } @@ -975,7 +962,7 @@ export namespace recommendationengine_v1beta1 { */ error?: Schema$GoogleRpcStatus; /** - * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any} | null; /** @@ -983,16 +970,16 @@ export namespace recommendationengine_v1beta1 { */ name?: string | null; /** - * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any} | null; } /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$GoogleProtobufEmpty {} /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$GoogleRpcStatus { /** @@ -1000,7 +987,7 @@ export namespace recommendationengine_v1beta1 { */ code?: number | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}> | null; /** @@ -1072,11 +1059,9 @@ export namespace recommendationengine_v1beta1 { * * // Do the magic * const res = await recommendationengine.projects.locations.catalogs.list({ - * // Optional. Maximum number of results to return. If unspecified, defaults - * // to 50. Max allowed value is 1000. + * // Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListCatalogs` - * // call. Provide this to retrieve the subsequent page. + * // Optional. A page token, received from a previous `ListCatalogs` call. Provide this to retrieve the subsequent page. * pageToken: 'placeholder-value', * // Required. The account resource name with an associated location. * parent: 'projects/my-project/locations/my-location', @@ -1241,8 +1226,7 @@ export namespace recommendationengine_v1beta1 { * const res = await recommendationengine.projects.locations.catalogs.patch({ * // The fully qualified resource name of the catalog. * name: 'projects/my-project/locations/my-location/catalogs/my-catalog', - * // Optional. Indicates which fields in the provided 'recommendation_model' to - * // update. If not set, will only update the catalog_item_level_config field. + * // Optional. Indicates which fields in the provided 'recommendation_model' to update. If not set, will only update the catalog_item_level_config field. * updateMask: 'placeholder-value', * * // Request body metadata @@ -1450,8 +1434,7 @@ export namespace recommendationengine_v1beta1 { * // Do the magic * const res = await recommendationengine.projects.locations.catalogs.catalogItems.create( * { - * // Required. The parent catalog resource name, such as - * // "projects/x/locations/global/catalogs/default_catalog". + * // Required. The parent catalog resource name, such as "projects/x/locations/global/catalogs/default_catalog". * parent: 'projects/my-project/locations/my-location/catalogs/my-catalog', * * // Request body metadata @@ -1632,8 +1615,7 @@ export namespace recommendationengine_v1beta1 { * // Do the magic * const res = await recommendationengine.projects.locations.catalogs.catalogItems.delete( * { - * // Required. Full resource name of catalog item, such as - * // "projects/x/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id". + * // Required. Full resource name of catalog item, such as "projects/x/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id". * name: * 'projects/my-project/locations/my-location/catalogs/my-catalog/catalogItems/.*', * } @@ -1766,8 +1748,7 @@ export namespace recommendationengine_v1beta1 { * // Do the magic * const res = await recommendationengine.projects.locations.catalogs.catalogItems.get( * { - * // Required. Full resource name of catalog item, such as - * // "projects/x/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id". + * // Required. Full resource name of catalog item, such as "projects/x/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id". * name: * 'projects/my-project/locations/my-location/catalogs/my-catalog/catalogItems/.*', * } @@ -1901,173 +1882,9 @@ export namespace recommendationengine_v1beta1 { } } - /** - * recommendationengine.projects.locations.catalogs.catalogItems.getGroupIdItems - * @desc Method for getting the catalog items associated with item group id. - * @example - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/recommendationengine.googleapis.com - * // - Login into gcloud by running: - * // `$ gcloud auth application-default login` - * // - Install the npm module by running: - * // `$ npm install googleapis` - * - * const {google} = require('googleapis'); - * const recommendationengine = google.recommendationengine('v1beta1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await recommendationengine.projects.locations.catalogs.catalogItems.getGroupIdItems( - * { - * // Required. Catalog item identifier for prediction results. - * itemGroupId: 'placeholder-value', - * // Required. Parent resource name of group id item, such as - * // "projects/x/locations/global/catalogs/default_catalog". - * parent: 'projects/my-project/locations/my-location/catalogs/my-catalog', - * } - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "canonicalCatalogItem": {}, - * // "catalogItems": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * @alias recommendationengine.projects.locations.catalogs.catalogItems.getGroupIdItems - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.itemGroupId Required. Catalog item identifier for prediction results. - * @param {string} params.parent Required. Parent resource name of group id item, such as "projects/x/locations/global/catalogs/default_catalog". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - getGroupIdItems( - params: Params$Resource$Projects$Locations$Catalogs$Catalogitems$Getgroupiditems, - options: StreamMethodOptions - ): GaxiosPromise; - getGroupIdItems( - params?: Params$Resource$Projects$Locations$Catalogs$Catalogitems$Getgroupiditems, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse - >; - getGroupIdItems( - params: Params$Resource$Projects$Locations$Catalogs$Catalogitems$Getgroupiditems, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getGroupIdItems( - params: Params$Resource$Projects$Locations$Catalogs$Catalogitems$Getgroupiditems, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse - > - ): void; - getGroupIdItems( - params: Params$Resource$Projects$Locations$Catalogs$Catalogitems$Getgroupiditems, - callback: BodyResponseCallback< - Schema$GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse - > - ): void; - getGroupIdItems( - callback: BodyResponseCallback< - Schema$GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse - > - ): void; - getGroupIdItems( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Catalogs$Catalogitems$Getgroupiditems - | BodyResponseCallback< - Schema$GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse - > - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback< - Schema$GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse - > - | BodyResponseCallback, - callback?: - | BodyResponseCallback< - Schema$GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse - > - | BodyResponseCallback - ): - | void - | GaxiosPromise< - Schema$GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse - > - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Catalogs$Catalogitems$Getgroupiditems; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Catalogs$Catalogitems$Getgroupiditems; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://recommendationengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1beta1/{+parent}/catalogItems:groupIdItems' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse - >(parameters, callback as BodyResponseCallback<{} | void>); - } else { - return createAPIRequest< - Schema$GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse - >(parameters); - } - } - /** * recommendationengine.projects.locations.catalogs.catalogItems.import - * @desc Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated. + * @desc Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated. * @example * // Before running the sample: * // - Enable the API at: @@ -2093,10 +1910,7 @@ export namespace recommendationengine_v1beta1 { * // Do the magic * const res = await recommendationengine.projects.locations.catalogs.catalogItems.import( * { - * // Required. "projects/1234/locations/global/catalogs/default_catalog" - * // - * // If no updateMask is specified, requires catalogItems.create permission. - * // If updateMask is specified, requires catalogItems.update permission. + * // Required. "projects/1234/locations/global/catalogs/default_catalog" If no updateMask is specified, requires catalogItems.create permission. If updateMask is specified, requires catalogItems.update permission. * parent: 'projects/my-project/locations/my-location/catalogs/my-catalog', * * // Request body metadata @@ -2132,7 +1946,7 @@ export namespace recommendationengine_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. "projects/1234/locations/global/catalogs/default_catalog" If no updateMask is specified, requires catalogItems.create permission. If updateMask is specified, requires catalogItems.update permission. + * @param {string} params.parent Required. "projects/1234/locations/global/catalogs/default_catalog" If no updateMask is specified, requires catalogItems.create permission. If updateMask is specified, requires catalogItems.update permission. * @param {().GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2255,13 +2069,11 @@ export namespace recommendationengine_v1beta1 { * { * // Optional. A filter to apply on the list results. * filter: 'placeholder-value', - * // Optional. Maximum number of results to return per page. If zero, the - * // service will choose a reasonable default. + * // Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default. * pageSize: 'placeholder-value', * // Optional. The previous ListCatalogItemsResponse.next_page_token. * pageToken: 'placeholder-value', - * // Required. The parent catalog resource name, such as - * // "projects/x/locations/global/catalogs/default_catalog". + * // Required. The parent catalog resource name, such as "projects/x/locations/global/catalogs/default_catalog". * parent: 'projects/my-project/locations/my-location/catalogs/my-catalog', * } * ); @@ -2425,12 +2237,10 @@ export namespace recommendationengine_v1beta1 { * // Do the magic * const res = await recommendationengine.projects.locations.catalogs.catalogItems.patch( * { - * // Required. Full resource name of catalog item, such as - * // "projects/x/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id". + * // Required. Full resource name of catalog item, such as "projects/x/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id". * name: * 'projects/my-project/locations/my-location/catalogs/my-catalog/catalogItems/.*', - * // Optional. Indicates which fields in the provided 'item' to update. If not - * // set, will by default update all fields. + * // Optional. Indicates which fields in the provided 'item' to update. If not set, will by default update all fields. * updateMask: 'placeholder-value', * * // Request body metadata @@ -2608,21 +2418,10 @@ export namespace recommendationengine_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Catalogs$Catalogitems$Getgroupiditems - extends StandardParameters { - /** - * Required. Catalog item identifier for prediction results. - */ - itemGroupId?: string; - /** - * Required. Parent resource name of group id item, such as "projects/x/locations/global/catalogs/default_catalog". - */ - parent?: string; - } export interface Params$Resource$Projects$Locations$Catalogs$Catalogitems$Import extends StandardParameters { /** - * Required. "projects/1234/locations/global/catalogs/default_catalog" If no updateMask is specified, requires catalogItems.create permission. If updateMask is specified, requires catalogItems.update permission. + * Required. "projects/1234/locations/global/catalogs/default_catalog" If no updateMask is specified, requires catalogItems.create permission. If updateMask is specified, requires catalogItems.update permission. */ parent?: string; @@ -2698,7 +2497,7 @@ export namespace recommendationengine_v1beta1 { /** * recommendationengine.projects.locations.catalogs.eventStores.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * // Before running the sample: * // - Enable the API at: @@ -2841,7 +2640,7 @@ export namespace recommendationengine_v1beta1 { /** * recommendationengine.projects.locations.catalogs.eventStores.operations.list - * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @example * // Before running the sample: * // - Enable the API at: @@ -3061,35 +2860,7 @@ export namespace recommendationengine_v1beta1 { * // Do the magic * const res = await recommendationengine.projects.locations.catalogs.eventStores.placements.predict( * { - * // Required. Full resource name of the format: - * // {name=projects/x/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/x} - * // The id of the recommendation engine placement. This id is used to identify - * // the set of models that will be used to make the prediction. - * // - * // We currently support three placements with the following IDs by default: - * // - * // * `shopping_cart`: Predicts items frequently bought together with one or - * // more catalog items in the same shopping session. Commonly displayed after - * // `add-to-cart` events, on product detail pages, or on the shopping cart - * // page. - * // - * // * `home_page`: Predicts the next product that a user will most likely - * // engage with or purchase based on the shopping or viewing history of the - * // specified `userId` or `visitorId`. For example - Recommendations for you. - * // - * // * `product_detail`: Predicts the next product that a user will most likely - * // engage with or purchase. The prediction is based on the shopping or - * // viewing history of the specified `userId` or `visitorId` and its - * // relevance to a specified `CatalogItem`. Typically used on product detail - * // pages. For example - More items like this. - * // - * // * `recently_viewed_default`: Returns up to 75 items recently viewed by the - * // specified `userId` or `visitorId`, most recent ones first. Returns - * // nothing if neither of them has viewed any items yet. For example - - * // Recently viewed. - * // - * // The full list of available placements can be seen at - * // https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard + * // Required. Full resource name of the format: {name=projects/x/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/x} The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default: * `shopping_cart`: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after `add-to-cart` events, on product detail pages, or on the shopping cart page. * `home_page`: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified `userId` or `visitorId`. For example - Recommendations for you. * `product_detail`: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified `userId` or `visitorId` and its relevance to a specified `CatalogItem`. Typically used on product detail pages. For example - More items like this. * `recently_viewed_default`: Returns up to 75 items recently viewed by the specified `userId` or `visitorId`, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard * name: * 'projects/my-project/locations/my-location/catalogs/my-catalog/eventStores/my-eventStore/placements/my-placement', * @@ -3130,7 +2901,7 @@ export namespace recommendationengine_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Full resource name of the format: {name=projects/x/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/x} The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default: * `shopping_cart`: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after `add-to-cart` events, on product detail pages, or on the shopping cart page. * `home_page`: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified `userId` or `visitorId`. For example - Recommendations for you. * `product_detail`: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified `userId` or `visitorId` and its relevance to a specified `CatalogItem`. Typically used on product detail pages. For example - More items like this. * `recently_viewed_default`: Returns up to 75 items recently viewed by the specified `userId` or `visitorId`, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard + * @param {string} params.name Required. Full resource name of the format: {name=projects/x/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/x} The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default: * `shopping_cart`: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after `add-to-cart` events, on product detail pages, or on the shopping cart page. * `home_page`: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified `userId` or `visitorId`. For example - Recommendations for you. * `product_detail`: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified `userId` or `visitorId` and its relevance to a specified `CatalogItem`. Typically used on product detail pages. For example - More items like this. * `recently_viewed_default`: Returns up to 75 items recently viewed by the specified `userId` or `visitorId`, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard * @param {().GoogleCloudRecommendationengineV1beta1PredictRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3246,7 +3017,7 @@ export namespace recommendationengine_v1beta1 { export interface Params$Resource$Projects$Locations$Catalogs$Eventstores$Placements$Predict extends StandardParameters { /** - * Required. Full resource name of the format: {name=projects/x/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/x} The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default: * `shopping_cart`: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after `add-to-cart` events, on product detail pages, or on the shopping cart page. * `home_page`: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified `userId` or `visitorId`. For example - Recommendations for you. * `product_detail`: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified `userId` or `visitorId` and its relevance to a specified `CatalogItem`. Typically used on product detail pages. For example - More items like this. * `recently_viewed_default`: Returns up to 75 items recently viewed by the specified `userId` or `visitorId`, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard + * Required. Full resource name of the format: {name=projects/x/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/x} The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default: * `shopping_cart`: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after `add-to-cart` events, on product detail pages, or on the shopping cart page. * `home_page`: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified `userId` or `visitorId`. For example - Recommendations for you. * `product_detail`: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified `userId` or `visitorId` and its relevance to a specified `CatalogItem`. Typically used on product detail pages. For example - More items like this. * `recently_viewed_default`: Returns up to 75 items recently viewed by the specified `userId` or `visitorId`, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard */ name?: string; @@ -3290,8 +3061,7 @@ export namespace recommendationengine_v1beta1 { * // Do the magic * const res = await recommendationengine.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.create( * { - * // Required. The parent resource path. - * // "projects/x/locations/global/catalogs/default_catalog/eventStores/default_event_store". + * // Required. The parent resource path. "projects/x/locations/global/catalogs/default_catalog/eventStores/default_event_store". * parent: * 'projects/my-project/locations/my-location/catalogs/my-catalog/eventStores/my-eventStore', * @@ -3460,8 +3230,7 @@ export namespace recommendationengine_v1beta1 { * // Do the magic * const res = await recommendationengine.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.delete( * { - * // Required. The API key to unregister including full resource path. - * // "projects/x/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/" + * // Required. The API key to unregister including full resource path. "projects/x/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/" * name: * 'projects/my-project/locations/my-location/catalogs/my-catalog/eventStores/my-eventStore/predictionApiKeyRegistrations/my-predictionApiKeyRegistration', * } @@ -3481,7 +3250,7 @@ export namespace recommendationengine_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The API key to unregister including full resource path. "projects/x/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/" + * @param {string} params.name Required. The API key to unregister including full resource path. "projects/x/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/" * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3594,13 +3363,11 @@ export namespace recommendationengine_v1beta1 { * // Do the magic * const res = await recommendationengine.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.list( * { - * // Optional. Maximum number of results to return per page. If unset, the - * // service will choose a reasonable default. + * // Optional. Maximum number of results to return per page. If unset, the service will choose a reasonable default. * pageSize: 'placeholder-value', * // Optional. The previous `ListPredictionApiKeyRegistration.nextPageToken`. * pageToken: 'placeholder-value', - * // Required. The parent placement resource name such as - * // "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store" + * // Required. The parent placement resource name such as "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store" * parent: * 'projects/my-project/locations/my-location/catalogs/my-catalog/eventStores/my-eventStore', * } @@ -3751,7 +3518,7 @@ export namespace recommendationengine_v1beta1 { export interface Params$Resource$Projects$Locations$Catalogs$Eventstores$Predictionapikeyregistrations$Delete extends StandardParameters { /** - * Required. The API key to unregister including full resource path. "projects/x/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/" + * Required. The API key to unregister including full resource path. "projects/x/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/" */ name?: string; } @@ -3779,7 +3546,7 @@ export namespace recommendationengine_v1beta1 { /** * recommendationengine.projects.locations.catalogs.eventStores.userEvents.collect - * @desc Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Recommendations AI JavaScript pixel. Users should not call this method directly. + * @desc Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Recommendations AI JavaScript pixel. Users should not call this method directly. * @example * // Before running the sample: * // - Enable the API at: @@ -3805,18 +3572,12 @@ export namespace recommendationengine_v1beta1 { * // Do the magic * const res = await recommendationengine.projects.locations.catalogs.eventStores.userEvents.collect( * { - * // Optional. The event timestamp in milliseconds. This prevents browser caching of - * // otherwise identical get requests. The name is abbreviated to reduce the - * // payload bytes. + * // Optional. The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. * ets: 'placeholder-value', - * // Required. The parent eventStore name, such as - * // "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store". + * // Required. The parent eventStore name, such as "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store". * parent: * 'projects/my-project/locations/my-location/catalogs/my-catalog/eventStores/my-eventStore', - * // Optional. The url including cgi-parameters but excluding the hash fragment. The URL - * // must be truncated to 1.5K bytes to conservatively be under the 2K bytes. - * // This is often more useful than the referer url, because many browsers only - * // send the domain for 3rd party requests. + * // Optional. The url including cgi-parameters but excluding the hash fragment. The URL must be truncated to 1.5K bytes to conservatively be under the 2K bytes. This is often more useful than the referer url, because many browsers only send the domain for 3rd party requests. * uri: 'placeholder-value', * // Required. URL encoded UserEvent proto. * userEvent: 'placeholder-value', @@ -3934,7 +3695,7 @@ export namespace recommendationengine_v1beta1 { /** * recommendationengine.projects.locations.catalogs.eventStores.userEvents.import - * @desc Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. + * @desc Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. * @example * // Before running the sample: * // - Enable the API at: @@ -4091,7 +3852,7 @@ export namespace recommendationengine_v1beta1 { /** * recommendationengine.projects.locations.catalogs.eventStores.userEvents.list - * @desc Gets a list of user events within a time range, with potential filtering. The method does not list unjoined user events. Unjoined user event definition: when a user event is ingested from Recommendations AI User Event APIs, the catalog item included in the user event is connected with the current catalog. If a catalog item of the ingested event is not in the current catalog, it could lead to degraded model quality. This is called an unjoined event. + * @desc Gets a list of user events within a time range, with potential filtering. The method does not list unjoined user events. Unjoined user event definition: when a user event is ingested from Recommendations AI User Event APIs, the catalog item included in the user event is connected with the current catalog. If a catalog item of the ingested event is not in the current catalog, it could lead to degraded model quality. This is called an unjoined event. * @example * // Before running the sample: * // - Enable the API at: @@ -4117,46 +3878,13 @@ export namespace recommendationengine_v1beta1 { * // Do the magic * const res = await recommendationengine.projects.locations.catalogs.eventStores.userEvents.list( * { - * // Optional. Filtering expression to specify restrictions over - * // returned events. This is a sequence of terms, where each term applies some - * // kind of a restriction to the returned user events. Use this expression to - * // restrict results to a specific time range, or filter events by eventType. - * // eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems - * // eventTime<"2012-04-23T18:25:43.511Z" eventType=search - * // - * // We expect only 3 types of fields: - * // - * // * eventTime: this can be specified a maximum of 2 times, once with a - * // less than operator and once with a greater than operator. The - * // eventTime restrict should result in one contiguous valid eventTime - * // range. - * // - * // * eventType: only 1 eventType restriction can be specified. - * // - * // * eventsMissingCatalogItems: specififying this will restrict results - * // to events for which catalog items were not found in the catalog. The - * // default behavior is to return only those events for which catalog - * // items were found. - * // - * // Some examples of valid filters expressions: - * // - * // * Example 1: eventTime > "2012-04-23T18:25:43.511Z" - * // eventTime < "2012-04-23T18:30:43.511Z" - * // * Example 2: eventTime > "2012-04-23T18:25:43.511Z" - * // eventType = detail-page-view - * // * Example 3: eventsMissingCatalogItems - * // eventType = search eventTime < "2018-04-23T18:30:43.511Z" - * // * Example 4: eventTime > "2012-04-23T18:25:43.511Z" - * // * Example 5: eventType = search - * // * Example 6: eventsMissingCatalogItems + * // Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search We expect only 3 types of fields: * eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range. * eventType: only 1 eventType restriction can be specified. * eventsMissingCatalogItems: specififying this will restrict results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" * Example 2: eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view * Example 3: eventsMissingCatalogItems eventType = search eventTime < "2018-04-23T18:30:43.511Z" * Example 4: eventTime > "2012-04-23T18:25:43.511Z" * Example 5: eventType = search * Example 6: eventsMissingCatalogItems * filter: 'placeholder-value', - * // Optional. Maximum number of results to return per page. If zero, the - * // service will choose a reasonable default. + * // Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default. * pageSize: 'placeholder-value', * // Optional. The previous ListUserEventsResponse.next_page_token. * pageToken: 'placeholder-value', - * // Required. The parent eventStore resource name, such as - * // "projects/x/locations/x/catalogs/default_catalog/eventStores/default_event_store". + * // Required. The parent eventStore resource name, such as "projects/x/locations/x/catalogs/default_catalog/eventStores/default_event_store". * parent: * 'projects/my-project/locations/my-location/catalogs/my-catalog/eventStores/my-eventStore', * } @@ -4179,7 +3907,7 @@ export namespace recommendationengine_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search We expect only 3 types of fields: * eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range. * eventType: only 1 eventType restriction can be specified. * eventsMissingCatalogItems: specififying this will restrict results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" * Example 2: eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view * Example 3: eventsMissingCatalogItems eventType = search eventTime < "2018-04-23T18:30:43.511Z" * Example 4: eventTime > "2012-04-23T18:25:43.511Z" * Example 5: eventType = search * Example 6: eventsMissingCatalogItems + * @param {string=} params.filter Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search We expect only 3 types of fields: * eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range. * eventType: only 1 eventType restriction can be specified. * eventsMissingCatalogItems: specififying this will restrict results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" * Example 2: eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view * Example 3: eventsMissingCatalogItems eventType = search eventTime < "2018-04-23T18:30:43.511Z" * Example 4: eventTime > "2012-04-23T18:25:43.511Z" * Example 5: eventType = search * Example 6: eventsMissingCatalogItems * @param {integer=} params.pageSize Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default. * @param {string=} params.pageToken Optional. The previous ListUserEventsResponse.next_page_token. * @param {string} params.parent Required. The parent eventStore resource name, such as "projects/x/locations/x/catalogs/default_catalog/eventStores/default_event_store". @@ -4321,9 +4049,7 @@ export namespace recommendationengine_v1beta1 { * // Do the magic * const res = await recommendationengine.projects.locations.catalogs.eventStores.userEvents.purge( * { - * // Required. The resource name of the event_store under which the events are - * // created. The format is - * // "projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}" + * // Required. The resource name of the event_store under which the events are created. The format is "projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}" * parent: * 'projects/my-project/locations/my-location/catalogs/my-catalog/eventStores/my-eventStore', * @@ -4479,8 +4205,7 @@ export namespace recommendationengine_v1beta1 { * // Do the magic * const res = await recommendationengine.projects.locations.catalogs.eventStores.userEvents.rejoin( * { - * // Required. Full resource name of user event, such as - * // "projects/x/locations/x/catalogs/default_catalog/eventStores/default_event_store". + * // Required. Full resource name of user event, such as "projects/x/locations/x/catalogs/default_catalog/eventStores/default_event_store". * parent: * 'projects/my-project/locations/my-location/catalogs/my-catalog/eventStores/my-eventStore', * @@ -4635,8 +4360,7 @@ export namespace recommendationengine_v1beta1 { * // Do the magic * const res = await recommendationengine.projects.locations.catalogs.eventStores.userEvents.write( * { - * // Required. The parent eventStore resource name, such as - * // "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store". + * // Required. The parent eventStore resource name, such as "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store". * parent: * 'projects/my-project/locations/my-location/catalogs/my-catalog/eventStores/my-eventStore', * @@ -4819,7 +4543,7 @@ export namespace recommendationengine_v1beta1 { export interface Params$Resource$Projects$Locations$Catalogs$Eventstores$Userevents$List extends StandardParameters { /** - * Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search We expect only 3 types of fields: * eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range. * eventType: only 1 eventType restriction can be specified. * eventsMissingCatalogItems: specififying this will restrict results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" * Example 2: eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view * Example 3: eventsMissingCatalogItems eventType = search eventTime < "2018-04-23T18:30:43.511Z" * Example 4: eventTime > "2012-04-23T18:25:43.511Z" * Example 5: eventType = search * Example 6: eventsMissingCatalogItems + * Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search We expect only 3 types of fields: * eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range. * eventType: only 1 eventType restriction can be specified. * eventsMissingCatalogItems: specififying this will restrict results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" * Example 2: eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view * Example 3: eventsMissingCatalogItems eventType = search eventTime < "2018-04-23T18:30:43.511Z" * Example 4: eventTime > "2012-04-23T18:25:43.511Z" * Example 5: eventType = search * Example 6: eventsMissingCatalogItems */ filter?: string; /** @@ -4880,7 +4604,7 @@ export namespace recommendationengine_v1beta1 { /** * recommendationengine.projects.locations.catalogs.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * // Before running the sample: * // - Enable the API at: @@ -5023,7 +4747,7 @@ export namespace recommendationengine_v1beta1 { /** * recommendationengine.projects.locations.catalogs.operations.list - * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @example * // Before running the sample: * // - Enable the API at: diff --git a/src/apis/recommender/v1.ts b/src/apis/recommender/v1.ts index ca4ab156bb..aa3ca81b30 100644 --- a/src/apis/recommender/v1.ts +++ b/src/apis/recommender/v1.ts @@ -259,7 +259,7 @@ export namespace recommender_v1 { */ etag?: string | null; /** - * Optional. State properties user wish to include with this state. Full replace of the current state_metadata. + * Optional. State properties user wish to include with this state. Full replace of the current state_metadata. */ stateMetadata?: {[key: string]: string} | null; } @@ -303,7 +303,7 @@ export namespace recommender_v1 { stateMetadata?: {[key: string]: string} | null; } /** - * Contains an operation for a resource loosely based on the JSON-PATCH format with support for: * Custom filters for describing partial array patch. * Extended path values for describing nested arrays. * Custom fields for describing the resource for which the operation is being described. * Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC. + * Contains an operation for a resource loosely based on the JSON-PATCH format with support for: * Custom filters for describing partial array patch. * Extended path values for describing nested arrays. * Custom fields for describing the resource for which the operation is being described. * Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC. */ export interface Schema$GoogleCloudRecommenderV1Operation { /** @@ -315,7 +315,7 @@ export namespace recommender_v1 { */ path?: string | null; /** - * Set of filters to apply if `path` refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers. * Example: { "/versions/x/name" : "it-123" "/versions/x/targetSize/percent": 20 } * Example: { "/bindings/x/role": "roles/admin" "/bindings/x/condition" : null } * Example: { "/bindings/x/role": "roles/admin" "/bindings/x/members/*" : ["x@google.com", "y@google.com"] } When both path_filters and path_value_matchers are set, an implicit AND must be performed. + * Set of filters to apply if `path` refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers. * Example: { "/versions/x/name" : "it-123" "/versions/x/targetSize/percent": 20 } * Example: { "/bindings/x/role": "roles/admin" "/bindings/x/condition" : null } * Example: { "/bindings/x/role": "roles/admin" "/bindings/x/members/*" : ["x@google.com", "y@google.com"] } When both path_filters and path_value_matchers are set, an implicit AND must be performed. */ pathFilters?: {[key: string]: any} | null; /** @@ -337,7 +337,7 @@ export namespace recommender_v1 { */ sourcePath?: string | null; /** - * Can be set with action 'copy' to copy resource configuration across different resources of the same type. Example: A resource clone can be done via action = 'copy', path = "/", from = "/", source_resource = <source> and resource_name = <target>. This field is empty for all other values of `action`. + * Can be set with action 'copy' to copy resource configuration across different resources of the same type. Example: A resource clone can be done via action = 'copy', path = "/", from = "/", source_resource = and resource_name = . This field is empty for all other values of `action`. */ sourceResource?: string | null; /** @@ -395,7 +395,7 @@ export namespace recommender_v1 { */ primaryImpact?: Schema$GoogleCloudRecommenderV1Impact; /** - * Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" + * Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" */ recommenderSubtype?: string | null; /** @@ -677,27 +677,13 @@ export namespace recommender_v1 { * * // Do the magic * const res = await recommender.projects.locations.insightTypes.insights.list({ - * // Optional. Filter expression to restrict the insights returned. Supported - * // filter fields: state - * // Eg: `state:"DISMISSED" or state:"ACTIVE" + * // Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE" * filter: 'placeholder-value', - * // Optional. The maximum number of results to return from this request. Non-positive - * // values are ignored. If not specified, the server will determine the number - * // of results to return. + * // Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. * pageSize: 'placeholder-value', - * // Optional. If present, retrieves the next batch of results from the preceding call to - * // this method. `page_token` must be the value of `next_page_token` from the - * // previous response. The values of other method parameters must be identical - * // to those in the previous call. + * // Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call. * pageToken: 'placeholder-value', - * // Required. The container resource on which to execute the request. - * // Acceptable formats: - * // - * // 1. - * // "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", - * // - * // LOCATION here refers to GCP Locations: - * // https://cloud.google.com/about/locations/ + * // Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ * parent: * 'projects/my-project/locations/my-location/insightTypes/my-insightType', * }); @@ -720,9 +706,9 @@ export namespace recommender_v1 { * * @param {object} params Parameters for request * @param {string=} params.filter Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE" - * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. + * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. * @param {string=} params.pageToken Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call. - * @param {string} params.parent Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ + * @param {string} params.parent Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -831,7 +817,7 @@ export namespace recommender_v1 { /** * recommender.projects.locations.insightTypes.insights.markAccepted - * @desc Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight. + * @desc Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight. * @example * // Before running the sample: * // - Enable the API at: @@ -1007,7 +993,7 @@ export namespace recommender_v1 { */ filter?: string; /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. */ pageSize?: number; /** @@ -1015,7 +1001,7 @@ export namespace recommender_v1 { */ pageToken?: string; /** - * Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ + * Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ */ parent?: string; } @@ -1232,27 +1218,13 @@ export namespace recommender_v1 { * // Do the magic * const res = await recommender.projects.locations.recommenders.recommendations.list( * { - * // Filter expression to restrict the recommendations returned. Supported - * // filter fields: state_info.state - * // Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED" + * // Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED" * filter: 'placeholder-value', - * // Optional. The maximum number of results to return from this request. Non-positive - * // values are ignored. If not specified, the server will determine the number - * // of results to return. + * // Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. * pageSize: 'placeholder-value', - * // Optional. If present, retrieves the next batch of results from the preceding call to - * // this method. `page_token` must be the value of `next_page_token` from the - * // previous response. The values of other method parameters must be identical - * // to those in the previous call. + * // Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call. * pageToken: 'placeholder-value', - * // Required. The container resource on which to execute the request. - * // Acceptable formats: - * // - * // 1. - * // "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", - * // - * // LOCATION here refers to GCP Locations: - * // https://cloud.google.com/about/locations/ + * // Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ * parent: * 'projects/my-project/locations/my-location/recommenders/my-recommender', * } @@ -1276,9 +1248,9 @@ export namespace recommender_v1 { * * @param {object} params Parameters for request * @param {string=} params.filter Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED" - * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. + * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. * @param {string=} params.pageToken Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call. - * @param {string} params.parent Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ + * @param {string} params.parent Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1390,7 +1362,7 @@ export namespace recommender_v1 { /** * recommender.projects.locations.recommenders.recommendations.markClaimed - * @desc Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. + * @desc Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. * @example * // Before running the sample: * // - Enable the API at: @@ -1558,7 +1530,7 @@ export namespace recommender_v1 { /** * recommender.projects.locations.recommenders.recommendations.markFailed - * @desc Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. + * @desc Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. * @example * // Before running the sample: * // - Enable the API at: @@ -1726,7 +1698,7 @@ export namespace recommender_v1 { /** * recommender.projects.locations.recommenders.recommendations.markSucceeded - * @desc Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. + * @desc Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. * @example * // Before running the sample: * // - Enable the API at: @@ -1907,7 +1879,7 @@ export namespace recommender_v1 { */ filter?: string; /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. */ pageSize?: number; /** @@ -1915,7 +1887,7 @@ export namespace recommender_v1 { */ pageToken?: string; /** - * Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ + * Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ */ parent?: string; } diff --git a/src/apis/recommender/v1beta1.ts b/src/apis/recommender/v1beta1.ts index 03b84573da..cac3c5c66a 100644 --- a/src/apis/recommender/v1beta1.ts +++ b/src/apis/recommender/v1beta1.ts @@ -259,7 +259,7 @@ export namespace recommender_v1beta1 { */ etag?: string | null; /** - * Optional. State properties user wish to include with this state. Full replace of the current state_metadata. + * Optional. State properties user wish to include with this state. Full replace of the current state_metadata. */ stateMetadata?: {[key: string]: string} | null; } @@ -303,7 +303,7 @@ export namespace recommender_v1beta1 { stateMetadata?: {[key: string]: string} | null; } /** - * Contains an operation for a resource loosely based on the JSON-PATCH format with support for: * Custom filters for describing partial array patch. * Extended path values for describing nested arrays. * Custom fields for describing the resource for which the operation is being described. * Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC. + * Contains an operation for a resource loosely based on the JSON-PATCH format with support for: * Custom filters for describing partial array patch. * Extended path values for describing nested arrays. * Custom fields for describing the resource for which the operation is being described. * Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC. */ export interface Schema$GoogleCloudRecommenderV1beta1Operation { /** @@ -315,7 +315,7 @@ export namespace recommender_v1beta1 { */ path?: string | null; /** - * Set of filters to apply if `path` refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers. * Example: { "/versions/x/name" : "it-123" "/versions/x/targetSize/percent": 20 } * Example: { "/bindings/x/role": "roles/admin" "/bindings/x/condition" : null } * Example: { "/bindings/x/role": "roles/admin" "/bindings/x/members/*" : ["x@google.com", "y@google.com"] } When both path_filters and path_value_matchers are set, an implicit AND must be performed. + * Set of filters to apply if `path` refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers. * Example: { "/versions/x/name" : "it-123" "/versions/x/targetSize/percent": 20 } * Example: { "/bindings/x/role": "roles/admin" "/bindings/x/condition" : null } * Example: { "/bindings/x/role": "roles/admin" "/bindings/x/members/*" : ["x@google.com", "y@google.com"] } When both path_filters and path_value_matchers are set, an implicit AND must be performed. */ pathFilters?: {[key: string]: any} | null; /** @@ -337,7 +337,7 @@ export namespace recommender_v1beta1 { */ sourcePath?: string | null; /** - * Can be set with action 'copy' to copy resource configuration across different resources of the same type. Example: A resource clone can be done via action = 'copy', path = "/", from = "/", source_resource = <source> and resource_name = <target>. This field is empty for all other values of `action`. + * Can be set with action 'copy' to copy resource configuration across different resources of the same type. Example: A resource clone can be done via action = 'copy', path = "/", from = "/", source_resource = and resource_name = . This field is empty for all other values of `action`. */ sourceResource?: string | null; /** @@ -395,7 +395,7 @@ export namespace recommender_v1beta1 { */ primaryImpact?: Schema$GoogleCloudRecommenderV1beta1Impact; /** - * Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" + * Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" */ recommenderSubtype?: string | null; /** @@ -683,27 +683,13 @@ export namespace recommender_v1beta1 { * * // Do the magic * const res = await recommender.projects.locations.insightTypes.insights.list({ - * // Optional. Filter expression to restrict the insights returned. Supported - * // filter fields: state - * // Eg: `state:"DISMISSED" or state:"ACTIVE" + * // Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE" * filter: 'placeholder-value', - * // Optional. The maximum number of results to return from this request. Non-positive - * // values are ignored. If not specified, the server will determine the number - * // of results to return. + * // Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. * pageSize: 'placeholder-value', - * // Optional. If present, retrieves the next batch of results from the preceding call to - * // this method. `page_token` must be the value of `next_page_token` from the - * // previous response. The values of other method parameters must be identical - * // to those in the previous call. + * // Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call. * pageToken: 'placeholder-value', - * // Required. The container resource on which to execute the request. - * // Acceptable formats: - * // - * // 1. - * // "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", - * // - * // LOCATION here refers to GCP Locations: - * // https://cloud.google.com/about/locations/ + * // Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ * parent: * 'projects/my-project/locations/my-location/insightTypes/my-insightType', * }); @@ -726,9 +712,9 @@ export namespace recommender_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.filter Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE" - * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. + * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. * @param {string=} params.pageToken Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call. - * @param {string} params.parent Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ + * @param {string} params.parent Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -836,7 +822,7 @@ export namespace recommender_v1beta1 { /** * recommender.projects.locations.insightTypes.insights.markAccepted - * @desc Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight. + * @desc Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight. * @example * // Before running the sample: * // - Enable the API at: @@ -1018,7 +1004,7 @@ export namespace recommender_v1beta1 { */ filter?: string; /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. */ pageSize?: number; /** @@ -1026,7 +1012,7 @@ export namespace recommender_v1beta1 { */ pageToken?: string; /** - * Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ + * Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ */ parent?: string; } @@ -1251,27 +1237,13 @@ export namespace recommender_v1beta1 { * // Do the magic * const res = await recommender.projects.locations.recommenders.recommendations.list( * { - * // Filter expression to restrict the recommendations returned. Supported - * // filter fields: state_info.state - * // Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED" + * // Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED" * filter: 'placeholder-value', - * // Optional. The maximum number of results to return from this request. Non-positive - * // values are ignored. If not specified, the server will determine the number - * // of results to return. + * // Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. * pageSize: 'placeholder-value', - * // Optional. If present, retrieves the next batch of results from the preceding call to - * // this method. `page_token` must be the value of `next_page_token` from the - * // previous response. The values of other method parameters must be identical - * // to those in the previous call. + * // Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call. * pageToken: 'placeholder-value', - * // Required. The container resource on which to execute the request. - * // Acceptable formats: - * // - * // 1. - * // "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", - * // - * // LOCATION here refers to GCP Locations: - * // https://cloud.google.com/about/locations/ + * // Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ * parent: * 'projects/my-project/locations/my-location/recommenders/my-recommender', * } @@ -1295,9 +1267,9 @@ export namespace recommender_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.filter Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED" - * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. + * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. * @param {string=} params.pageToken Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call. - * @param {string} params.parent Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ + * @param {string} params.parent Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1409,7 +1381,7 @@ export namespace recommender_v1beta1 { /** * recommender.projects.locations.recommenders.recommendations.markClaimed - * @desc Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. + * @desc Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. * @example * // Before running the sample: * // - Enable the API at: @@ -1585,7 +1557,7 @@ export namespace recommender_v1beta1 { /** * recommender.projects.locations.recommenders.recommendations.markFailed - * @desc Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. + * @desc Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. * @example * // Before running the sample: * // - Enable the API at: @@ -1761,7 +1733,7 @@ export namespace recommender_v1beta1 { /** * recommender.projects.locations.recommenders.recommendations.markSucceeded - * @desc Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. + * @desc Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. * @example * // Before running the sample: * // - Enable the API at: @@ -1950,7 +1922,7 @@ export namespace recommender_v1beta1 { */ filter?: string; /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. */ pageSize?: number; /** @@ -1958,7 +1930,7 @@ export namespace recommender_v1beta1 { */ pageToken?: string; /** - * Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ + * Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ */ parent?: string; } diff --git a/src/apis/runtimeconfig/v1.ts b/src/apis/runtimeconfig/v1.ts index 7b4dfa7a25..c0a3d20619 100644 --- a/src/apis/runtimeconfig/v1.ts +++ b/src/apis/runtimeconfig/v1.ts @@ -132,7 +132,7 @@ export namespace runtimeconfig_v1 { */ export interface Schema$CancelOperationRequest {} /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -161,7 +161,7 @@ export namespace runtimeconfig_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any} | null; /** @@ -169,12 +169,12 @@ export namespace runtimeconfig_v1 { */ name?: string | null; /** - * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any} | null; } /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -182,7 +182,7 @@ export namespace runtimeconfig_v1 { */ code?: number | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}> | null; /** @@ -199,7 +199,7 @@ export namespace runtimeconfig_v1 { /** * runtimeconfig.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @example * // Before running the sample: * // - Enable the API at: @@ -466,7 +466,7 @@ export namespace runtimeconfig_v1 { /** * runtimeconfig.operations.list - * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @example * // Before running the sample: * // - Enable the API at: diff --git a/src/apis/runtimeconfig/v1beta1.ts b/src/apis/runtimeconfig/v1beta1.ts index f26b0a2c63..28a7b688c8 100644 --- a/src/apis/runtimeconfig/v1beta1.ts +++ b/src/apis/runtimeconfig/v1beta1.ts @@ -132,11 +132,11 @@ export namespace runtimeconfig_v1beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -145,7 +145,7 @@ export namespace runtimeconfig_v1beta1 { role?: string | null; } /** - * A Cardinality condition for the Waiter resource. A cardinality condition is met when the number of variables under a specified path prefix reaches a predefined number. For example, if you set a Cardinality condition where the `path` is set to `/foo` and the number of paths is set to `2`, the following variables would meet the condition in a RuntimeConfig resource: + `/foo/variable1 = "value1"` + `/foo/variable2 = "value2"` + `/bar/variable3 = "value3"` It would not satisfy the same condition with the `number` set to `3`, however, because there is only 2 paths that start with `/foo`. Cardinality conditions are recursive; all subtrees under the specific path prefix are counted. + * A Cardinality condition for the Waiter resource. A cardinality condition is met when the number of variables under a specified path prefix reaches a predefined number. For example, if you set a Cardinality condition where the `path` is set to `/foo` and the number of paths is set to `2`, the following variables would meet the condition in a RuntimeConfig resource: + `/foo/variable1 = "value1"` + `/foo/variable2 = "value2"` + `/bar/variable3 = "value3"` It would not satisfy the same condition with the `number` set to `3`, however, because there is only 2 paths that start with `/foo`. Cardinality conditions are recursive; all subtrees under the specific path prefix are counted. */ export interface Schema$Cardinality { /** @@ -158,7 +158,7 @@ export namespace runtimeconfig_v1beta1 { path?: string | null; } /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -171,7 +171,7 @@ export namespace runtimeconfig_v1beta1 { cardinality?: Schema$Cardinality; } /** - * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** @@ -243,7 +243,7 @@ export namespace runtimeconfig_v1beta1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any} | null; /** @@ -251,12 +251,12 @@ export namespace runtimeconfig_v1beta1 { */ name?: string | null; /** - * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any} | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -264,11 +264,11 @@ export namespace runtimeconfig_v1beta1 { */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } @@ -281,7 +281,7 @@ export namespace runtimeconfig_v1beta1 { */ description?: string | null; /** - * The resource name of a runtime config. The name must have the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME] The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an arbitrary name that matches the `[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression. The length of `[CONFIG_NAME]` must be less than 64 characters. You pick the RuntimeConfig resource name, but the server will validate that the name adheres to this format. After you create the resource, you cannot change the resource's name. + * The resource name of a runtime config. The name must have the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME] The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an arbitrary name that matches the `[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression. The length of `[CONFIG_NAME]` must be less than 64 characters. You pick the RuntimeConfig resource name, but the server will validate that the name adheres to this format. After you create the resource, you cannot change the resource's name. */ name?: string | null; } @@ -295,7 +295,7 @@ export namespace runtimeconfig_v1beta1 { policy?: Schema$Policy; } /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -303,7 +303,7 @@ export namespace runtimeconfig_v1beta1 { */ code?: number | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}> | null; /** @@ -334,7 +334,7 @@ export namespace runtimeconfig_v1beta1 { */ export interface Schema$Variable { /** - * The name of the variable resource, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME] The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system file path naming. The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and dashes. Slashes are used as path element separators and are not part of the `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one non-slash character. Multiple slashes are coalesced into single slash character. Each path segment should match [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression. The length of a `[VARIABLE_NAME]` must be less than 256 characters. Once you create a variable, you cannot change the variable name. + * The name of the variable resource, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME] The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system file path naming. The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and dashes. Slashes are used as path element separators and are not part of the `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one non-slash character. Multiple slashes are coalesced into single slash character. Each path segment should match [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression. The length of a `[VARIABLE_NAME]` must be less than 256 characters. Once you create a variable, you cannot change the variable name. */ name?: string | null; /** @@ -355,7 +355,7 @@ export namespace runtimeconfig_v1beta1 { value?: string | null; } /** - * A Waiter resource waits for some end condition within a RuntimeConfig resource to be met before it returns. For example, assume you have a distributed system where each node writes to a Variable resource indicating the node's readiness as part of the startup process. You then configure a Waiter resource with the success condition set to wait until some number of nodes have checked in. Afterwards, your application runs some arbitrary code after the condition has been met and the waiter returns successfully. Once created, a Waiter resource is immutable. To learn more about using waiters, read the [Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter) documentation. + * A Waiter resource waits for some end condition within a RuntimeConfig resource to be met before it returns. For example, assume you have a distributed system where each node writes to a Variable resource indicating the node's readiness as part of the startup process. You then configure a Waiter resource with the success condition set to wait until some number of nodes have checked in. Afterwards, your application runs some arbitrary code after the condition has been met and the waiter returns successfully. Once created, a Waiter resource is immutable. To learn more about using waiters, read the [Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter) documentation. */ export interface Schema$Waiter { /** @@ -363,7 +363,7 @@ export namespace runtimeconfig_v1beta1 { */ createTime?: string | null; /** - * Output only. If the value is `false`, it means the waiter is still waiting for one of its conditions to be met. If true, the waiter has finished. If the waiter finished due to a timeout or failure, `error` will be set. + * Output only. If the value is `false`, it means the waiter is still waiting for one of its conditions to be met. If true, the waiter has finished. If the waiter finished due to a timeout or failure, `error` will be set. */ done?: boolean | null; /** @@ -375,7 +375,7 @@ export namespace runtimeconfig_v1beta1 { */ failure?: Schema$EndCondition; /** - * The name of the Waiter resource, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME] The `[PROJECT_ID]` must be a valid Google Cloud project ID, the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the `[WAITER_NAME]` must match RFC 1035 segment specification, and the length of `[WAITER_NAME]` must be less than 64 bytes. After you create a Waiter resource, you cannot change the resource name. + * The name of the Waiter resource, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME] The `[PROJECT_ID]` must be a valid Google Cloud project ID, the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the `[WAITER_NAME]` must match RFC 1035 segment specification, and the length of `[WAITER_NAME]` must be less than 64 bytes. After you create a Waiter resource, you cannot change the resource name. */ name?: string | null; /** @@ -392,7 +392,7 @@ export namespace runtimeconfig_v1beta1 { */ export interface Schema$WatchVariableRequest { /** - * If specified, checks the current timestamp of the variable and if the current timestamp is newer than `newerThan` timestamp, the method returns immediately. If not specified or the variable has an older timestamp, the watcher waits for a the value to change before returning. + * If specified, checks the current timestamp of the variable and if the current timestamp is newer than `newerThan` timestamp, the method returns immediately. If not specified or the variable has an older timestamp, the watcher waits for a the value to change before returning. */ newerThan?: string | null; } @@ -448,20 +448,9 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.create({ - * // The [project - * // ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) - * // for this request, in the format `projects/[PROJECT_ID]`. + * // The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) for this request, in the format `projects/[PROJECT_ID]`. * parent: 'projects/my-project', - * // An optional but recommended unique `request_id`. If the server - * // receives two `create()` requests with the same - * // `request_id`, then the second request will be ignored and the - * // first resource created and stored in the backend is returned. - * // Empty `request_id` fields are ignored. - * // - * // It is responsibility of the client to ensure uniqueness of the - * // `request_id` strings. - * // - * // `request_id` strings are limited to 64 characters. + * // An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. * requestId: 'placeholder-value', * * // Request body metadata @@ -492,7 +481,7 @@ export namespace runtimeconfig_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.parent The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) for this request, in the format `projects/[PROJECT_ID]`. - * @param {string=} params.requestId An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. + * @param {string=} params.requestId An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. * @param {().RuntimeConfig} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -608,9 +597,7 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.delete({ - * // The RuntimeConfig resource to delete, in the format: - * // - * // `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * // The RuntimeConfig resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` * name: 'projects/my-project/configs/my-config', * }); * console.log(res.data); @@ -628,7 +615,7 @@ export namespace runtimeconfig_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The RuntimeConfig resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * @param {string} params.name The RuntimeConfig resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -740,9 +727,7 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.get({ - * // The name of the RuntimeConfig resource to retrieve, in the format: - * // - * // `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * // The name of the RuntimeConfig resource to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` * name: 'projects/my-project/configs/my-config', * }); * console.log(res.data); @@ -763,7 +748,7 @@ export namespace runtimeconfig_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the RuntimeConfig resource to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * @param {string} params.name The name of the RuntimeConfig resource to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -875,21 +860,9 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.getIamPolicy({ - * // Optional. The policy format version to be returned. - * // - * // Valid values are 0, 1, and 3. Requests specifying an invalid value will be - * // rejected. - * // - * // Requests for policies with any conditional bindings must specify version 3. - * // Policies without any conditional bindings may specify any valid value or - * // leave the field unset. - * // - * // To learn which resources support conditions in their IAM policies, see the - * // [IAM - * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * // Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. - * // See the operation documentation for the appropriate value for this field. + * // REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * resource: 'projects/my-project/configs/my-config', * }); * console.log(res.data); @@ -911,7 +884,7 @@ export namespace runtimeconfig_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1027,15 +1000,11 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.list({ - * // Specifies the number of results to return per page. If there are fewer - * // elements than the specified number, returns all elements. + * // Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. * pageSize: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to a `nextPageToken` - * // returned by a previous list request to get the next page of results. + * // Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. * pageToken: 'placeholder-value', - * // The [project - * // ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) - * // for this request, in the format `projects/[PROJECT_ID]`. + * // The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) for this request, in the format `projects/[PROJECT_ID]`. * parent: 'projects/my-project', * }); * console.log(res.data); @@ -1148,7 +1117,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * // Before running the sample: * // - Enable the API at: @@ -1176,8 +1145,7 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. - * // See the operation documentation for the appropriate value for this field. + * // REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. * resource: 'projects/my-project/configs/my-config', * * // Request body metadata @@ -1295,7 +1263,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.testIamPermissions - * @desc 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. + * @desc 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. * @example * // Before running the sample: * // - Enable the API at: @@ -1323,8 +1291,7 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.testIamPermissions({ - * // REQUIRED: The resource for which the policy detail is being requested. - * // See the operation documentation for the appropriate value for this field. + * // REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. * resource: 'projects/my-project/configs/my-config', * * // Request body metadata @@ -1475,9 +1442,7 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.update({ - * // The name of the RuntimeConfig resource to update, in the format: - * // - * // `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * // The name of the RuntimeConfig resource to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` * name: 'projects/my-project/configs/my-config', * * // Request body metadata @@ -1507,7 +1472,7 @@ export namespace runtimeconfig_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the RuntimeConfig resource to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * @param {string} params.name The name of the RuntimeConfig resource to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` * @param {().RuntimeConfig} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1598,7 +1563,7 @@ export namespace runtimeconfig_v1beta1 { */ parent?: string; /** - * An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. + * An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. */ requestId?: string; @@ -1610,21 +1575,21 @@ export namespace runtimeconfig_v1beta1 { export interface Params$Resource$Projects$Configs$Delete extends StandardParameters { /** - * The RuntimeConfig resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * The RuntimeConfig resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` */ name?: string; } export interface Params$Resource$Projects$Configs$Get extends StandardParameters { /** - * The name of the RuntimeConfig resource to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * The name of the RuntimeConfig resource to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` */ name?: string; } export interface Params$Resource$Projects$Configs$Getiampolicy extends StandardParameters { /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** @@ -1674,7 +1639,7 @@ export namespace runtimeconfig_v1beta1 { export interface Params$Resource$Projects$Configs$Update extends StandardParameters { /** - * The name of the RuntimeConfig resource to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * The name of the RuntimeConfig resource to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` */ name?: string; @@ -1692,7 +1657,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * // Before running the sample: * // - Enable the API at: @@ -1828,7 +1793,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.operations.testIamPermissions - * @desc 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. + * @desc 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. * @example * // Before running the sample: * // - Enable the API at: @@ -1857,8 +1822,7 @@ export namespace runtimeconfig_v1beta1 { * // Do the magic * const res = await runtimeconfig.projects.configs.operations.testIamPermissions( * { - * // REQUIRED: The resource for which the policy detail is being requested. - * // See the operation documentation for the appropriate value for this field. + * // REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. * resource: 'projects/my-project/configs/my-config/operations/.*', * * // Request body metadata @@ -2009,7 +1973,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.variables.create - * @desc Creates a variable within the given configuration. You cannot create a variable with a name that is a prefix of an existing variable name, or a name that has an existing variable name as a prefix. To learn more about creating a variable, read the [Setting and Getting Data](/deployment-manager/runtime-configurator/set-and-get-variables) documentation. + * @desc Creates a variable within the given configuration. You cannot create a variable with a name that is a prefix of an existing variable name, or a name that has an existing variable name as a prefix. To learn more about creating a variable, read the [Setting and Getting Data](/deployment-manager/runtime-configurator/set-and-get-variables) documentation. * @example * // Before running the sample: * // - Enable the API at: @@ -2037,21 +2001,9 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.variables.create({ - * // The path to the RutimeConfig resource that this variable should belong to. - * // The configuration must exist beforehand; the path must be in the format: - * // - * // `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * // The path to the RutimeConfig resource that this variable should belong to. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` * parent: 'projects/my-project/configs/my-config', - * // An optional but recommended unique `request_id`. If the server - * // receives two `create()` requests with the same - * // `request_id`, then the second request will be ignored and the - * // first resource created and stored in the backend is returned. - * // Empty `request_id` fields are ignored. - * // - * // It is responsibility of the client to ensure uniqueness of the - * // `request_id` strings. - * // - * // `request_id` strings are limited to 64 characters. + * // An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. * requestId: 'placeholder-value', * * // Request body metadata @@ -2087,8 +2039,8 @@ export namespace runtimeconfig_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The path to the RutimeConfig resource that this variable should belong to. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` - * @param {string=} params.requestId An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. + * @param {string} params.parent The path to the RutimeConfig resource that this variable should belong to. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * @param {string=} params.requestId An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. * @param {().Variable} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2176,7 +2128,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.variables.delete - * @desc Deletes a variable or multiple variables. If you specify a variable name, then that variable is deleted. If you specify a prefix and `recursive` is true, then all variables with that prefix are deleted. You must set a `recursive` to true if you delete variables by prefix. + * @desc Deletes a variable or multiple variables. If you specify a variable name, then that variable is deleted. If you specify a prefix and `recursive` is true, then all variables with that prefix are deleted. You must set a `recursive` to true if you delete variables by prefix. * @example * // Before running the sample: * // - Enable the API at: @@ -2204,12 +2156,9 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.variables.delete({ - * // The name of the variable to delete, in the format: - * // - * // `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` + * // The name of the variable to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` * name: 'projects/my-project/configs/my-config/variables/.*', - * // Set to `true` to recursively delete multiple variables with the same - * // prefix. + * // Set to `true` to recursively delete multiple variables with the same prefix. * recursive: 'placeholder-value', * }); * console.log(res.data); @@ -2227,7 +2176,7 @@ export namespace runtimeconfig_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the variable to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` + * @param {string} params.name The name of the variable to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` * @param {boolean=} params.recursive Set to `true` to recursively delete multiple variables with the same prefix. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2340,9 +2289,7 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.variables.get({ - * // The name of the variable to return, in the format: - * // - * // `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]` + * // The name of the variable to return, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]` * name: 'projects/my-project/configs/my-config/variables/.*', * }); * console.log(res.data); @@ -2366,7 +2313,7 @@ export namespace runtimeconfig_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the variable to return, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]` + * @param {string} params.name The name of the variable to return, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2478,25 +2425,15 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.variables.list({ - * // Filters variables by matching the specified filter. For example: - * // - * // `projects/example-project/config/[CONFIG_NAME]/variables/example-variable`. + * // Filters variables by matching the specified filter. For example: `projects/example-project/config/[CONFIG_NAME]/variables/example-variable`. * filter: 'placeholder-value', - * // Specifies the number of results to return per page. If there are fewer - * // elements than the specified number, returns all elements. + * // Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. * pageSize: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to a `nextPageToken` - * // returned by a previous list request to get the next page of results. + * // Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. * pageToken: 'placeholder-value', - * // The path to the RuntimeConfig resource for which you want to list - * // variables. The configuration must exist beforehand; the path must be in the - * // format: - * // - * // `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * // The path to the RuntimeConfig resource for which you want to list variables. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` * parent: 'projects/my-project/configs/my-config', - * // The flag indicates whether the user wants to return values of variables. - * // If true, then only those variables that user has IAM GetVariable permission - * // will be returned along with their values. + * // The flag indicates whether the user wants to return values of variables. If true, then only those variables that user has IAM GetVariable permission will be returned along with their values. * returnValues: 'placeholder-value', * }); * console.log(res.data); @@ -2517,10 +2454,10 @@ export namespace runtimeconfig_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Filters variables by matching the specified filter. For example: `projects/example-project/config/[CONFIG_NAME]/variables/example-variable`. + * @param {string=} params.filter Filters variables by matching the specified filter. For example: `projects/example-project/config/[CONFIG_NAME]/variables/example-variable`. * @param {integer=} params.pageSize Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. * @param {string=} params.pageToken Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. - * @param {string} params.parent The path to the RuntimeConfig resource for which you want to list variables. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * @param {string} params.parent The path to the RuntimeConfig resource for which you want to list variables. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` * @param {boolean=} params.returnValues The flag indicates whether the user wants to return values of variables. If true, then only those variables that user has IAM GetVariable permission will be returned along with their values. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2613,7 +2550,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.variables.testIamPermissions - * @desc 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. + * @desc 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. * @example * // Before running the sample: * // - Enable the API at: @@ -2642,8 +2579,7 @@ export namespace runtimeconfig_v1beta1 { * // Do the magic * const res = await runtimeconfig.projects.configs.variables.testIamPermissions( * { - * // REQUIRED: The resource for which the policy detail is being requested. - * // See the operation documentation for the appropriate value for this field. + * // REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. * resource: 'projects/my-project/configs/my-config/variables/.*', * * // Request body metadata @@ -2795,9 +2731,7 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.variables.update({ - * // The name of the variable to update, in the format: - * // - * // `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` + * // The name of the variable to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` * name: 'projects/my-project/configs/my-config/variables/.*', * * // Request body metadata @@ -2833,7 +2767,7 @@ export namespace runtimeconfig_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the variable to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` + * @param {string} params.name The name of the variable to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` * @param {().Variable} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2918,7 +2852,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.variables.watch - * @desc Watches a specific variable and waits for a change in the variable's value. When there is a change, this method returns the new value or times out. If a variable is deleted while being watched, the `variableState` state is set to `DELETED` and the method returns the last known variable `value`. If you set the deadline for watching to a larger value than internal timeout (60 seconds), the current variable value is returned and the `variableState` will be `VARIABLE_STATE_UNSPECIFIED`. To learn more about creating a watcher, read the [Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable) documentation. + * @desc Watches a specific variable and waits for a change in the variable's value. When there is a change, this method returns the new value or times out. If a variable is deleted while being watched, the `variableState` state is set to `DELETED` and the method returns the last known variable `value`. If you set the deadline for watching to a larger value than internal timeout (60 seconds), the current variable value is returned and the `variableState` will be `VARIABLE_STATE_UNSPECIFIED`. To learn more about creating a watcher, read the [Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable) documentation. * @example * // Before running the sample: * // - Enable the API at: @@ -2946,9 +2880,7 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.variables.watch({ - * // The name of the variable to watch, in the format: - * // - * // `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * // The name of the variable to watch, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` * name: 'projects/my-project/configs/my-config/variables/.*', * * // Request body metadata @@ -2980,7 +2912,7 @@ export namespace runtimeconfig_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the variable to watch, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * @param {string} params.name The name of the variable to watch, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` * @param {().WatchVariableRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3070,11 +3002,11 @@ export namespace runtimeconfig_v1beta1 { export interface Params$Resource$Projects$Configs$Variables$Create extends StandardParameters { /** - * The path to the RutimeConfig resource that this variable should belong to. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * The path to the RutimeConfig resource that this variable should belong to. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` */ parent?: string; /** - * An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. + * An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. */ requestId?: string; @@ -3086,7 +3018,7 @@ export namespace runtimeconfig_v1beta1 { export interface Params$Resource$Projects$Configs$Variables$Delete extends StandardParameters { /** - * The name of the variable to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` + * The name of the variable to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` */ name?: string; /** @@ -3097,14 +3029,14 @@ export namespace runtimeconfig_v1beta1 { export interface Params$Resource$Projects$Configs$Variables$Get extends StandardParameters { /** - * The name of the variable to return, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]` + * The name of the variable to return, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]` */ name?: string; } export interface Params$Resource$Projects$Configs$Variables$List extends StandardParameters { /** - * Filters variables by matching the specified filter. For example: `projects/example-project/config/[CONFIG_NAME]/variables/example-variable`. + * Filters variables by matching the specified filter. For example: `projects/example-project/config/[CONFIG_NAME]/variables/example-variable`. */ filter?: string; /** @@ -3116,7 +3048,7 @@ export namespace runtimeconfig_v1beta1 { */ pageToken?: string; /** - * The path to the RuntimeConfig resource for which you want to list variables. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * The path to the RuntimeConfig resource for which you want to list variables. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` */ parent?: string; /** @@ -3139,7 +3071,7 @@ export namespace runtimeconfig_v1beta1 { export interface Params$Resource$Projects$Configs$Variables$Update extends StandardParameters { /** - * The name of the variable to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` + * The name of the variable to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` */ name?: string; @@ -3151,7 +3083,7 @@ export namespace runtimeconfig_v1beta1 { export interface Params$Resource$Projects$Configs$Variables$Watch extends StandardParameters { /** - * The name of the variable to watch, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * The name of the variable to watch, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` */ name?: string; @@ -3197,21 +3129,9 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.waiters.create({ - * // The path to the configuration that will own the waiter. - * // The configuration must exist beforehand; the path must be in the format: - * // - * // `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`. + * // The path to the configuration that will own the waiter. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`. * parent: 'projects/my-project/configs/my-config', - * // An optional but recommended unique `request_id`. If the server - * // receives two `create()` requests with the same - * // `request_id`, then the second request will be ignored and the - * // first resource created and stored in the backend is returned. - * // Empty `request_id` fields are ignored. - * // - * // It is responsibility of the client to ensure uniqueness of the - * // `request_id` strings. - * // - * // `request_id` strings are limited to 64 characters. + * // An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. * requestId: 'placeholder-value', * * // Request body metadata @@ -3249,8 +3169,8 @@ export namespace runtimeconfig_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The path to the configuration that will own the waiter. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`. - * @param {string=} params.requestId An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. + * @param {string} params.parent The path to the configuration that will own the waiter. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`. + * @param {string=} params.requestId An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. * @param {().Waiter} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3366,9 +3286,7 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.waiters.delete({ - * // The Waiter resource to delete, in the format: - * // - * // `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` + * // The Waiter resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` * name: 'projects/my-project/configs/my-config/waiters/my-waiter', * }); * console.log(res.data); @@ -3386,7 +3304,7 @@ export namespace runtimeconfig_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The Waiter resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` + * @param {string} params.name The Waiter resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3498,10 +3416,7 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.waiters.get({ - * // The fully-qualified name of the Waiter resource object to retrieve, in the - * // format: - * // - * // `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` + * // The fully-qualified name of the Waiter resource object to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` * name: 'projects/my-project/configs/my-config/waiters/my-waiter', * }); * console.log(res.data); @@ -3527,7 +3442,7 @@ export namespace runtimeconfig_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The fully-qualified name of the Waiter resource object to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` + * @param {string} params.name The fully-qualified name of the Waiter resource object to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3639,16 +3554,11 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.waiters.list({ - * // Specifies the number of results to return per page. If there are fewer - * // elements than the specified number, returns all elements. + * // Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. * pageSize: 'placeholder-value', - * // Specifies a page token to use. Set `pageToken` to a `nextPageToken` - * // returned by a previous list request to get the next page of results. + * // Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. * pageToken: 'placeholder-value', - * // The path to the configuration for which you want to get a list of waiters. - * // The configuration must exist beforehand; the path must be in the format: - * // - * // `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * // The path to the configuration for which you want to get a list of waiters. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` * parent: 'projects/my-project/configs/my-config', * }); * console.log(res.data); @@ -3671,7 +3581,7 @@ export namespace runtimeconfig_v1beta1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. * @param {string=} params.pageToken Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. - * @param {string} params.parent The path to the configuration for which you want to get a list of waiters. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * @param {string} params.parent The path to the configuration for which you want to get a list of waiters. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3761,7 +3671,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.waiters.testIamPermissions - * @desc 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. + * @desc 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. * @example * // Before running the sample: * // - Enable the API at: @@ -3789,8 +3699,7 @@ export namespace runtimeconfig_v1beta1 { * * // Do the magic * const res = await runtimeconfig.projects.configs.waiters.testIamPermissions({ - * // REQUIRED: The resource for which the policy detail is being requested. - * // See the operation documentation for the appropriate value for this field. + * // REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. * resource: 'projects/my-project/configs/my-config/waiters/my-waiter', * * // Request body metadata @@ -3915,11 +3824,11 @@ export namespace runtimeconfig_v1beta1 { export interface Params$Resource$Projects$Configs$Waiters$Create extends StandardParameters { /** - * The path to the configuration that will own the waiter. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`. + * The path to the configuration that will own the waiter. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`. */ parent?: string; /** - * An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. + * An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. */ requestId?: string; @@ -3931,14 +3840,14 @@ export namespace runtimeconfig_v1beta1 { export interface Params$Resource$Projects$Configs$Waiters$Delete extends StandardParameters { /** - * The Waiter resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` + * The Waiter resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` */ name?: string; } export interface Params$Resource$Projects$Configs$Waiters$Get extends StandardParameters { /** - * The fully-qualified name of the Waiter resource object to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` + * The fully-qualified name of the Waiter resource object to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` */ name?: string; } @@ -3953,7 +3862,7 @@ export namespace runtimeconfig_v1beta1 { */ pageToken?: string; /** - * The path to the configuration for which you want to get a list of waiters. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * The path to the configuration for which you want to get a list of waiters. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` */ parent?: string; } diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index 425e22e90d..ba17cf2f70 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -824,7 +824,7 @@ export namespace serviceconsumermanagement_v1 { syntax?: string | null; } /** - * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. The following are specific rules for service defined Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `description` fields are all required. The `unit` field must be specified if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default 500 metric descriptors per service is allowed. * Maximum of default 10 labels per metric descriptor is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas + * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. */ export interface Schema$MetricDescriptor { /** @@ -836,7 +836,7 @@ export namespace serviceconsumermanagement_v1 { */ displayName?: string | null; /** - * The set of labels that can be used to describe a specific instance of this metric type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. + * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; /** @@ -860,7 +860,7 @@ export namespace serviceconsumermanagement_v1 { */ name?: string | null; /** - * The metric type, including its DNS name prefix. The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of `{service name}/{relative metric name}`, such as `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric name must follow: * Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. * The maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name `custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/user/`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" + * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ type?: string | null; /** @@ -916,7 +916,7 @@ export namespace serviceconsumermanagement_v1 { root?: string | null; } /** - * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different services can support different monitored resource types. The following are specific rules to service defined monitored resources for Monitoring and Logging: * The `type`, `display_name`, `description`, `labels` and `launch_stage` fields are all required. * The first label of the monitored resource descriptor must be `resource_container`. There are legacy monitored resource descritptors start with `project_id`. * It must include a `location` label. * Maximum of default 5 service defined monitored resource descriptors is allowed per service. * Maximum of default 10 labels per monitored resource is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas + * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. */ export interface Schema$MonitoredResourceDescriptor { /** @@ -928,7 +928,7 @@ export namespace serviceconsumermanagement_v1 { */ displayName?: string | null; /** - * Required. A set of labels used to describe instances of this monitored resource type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, an individual Google Cloud SQL database is identified by values for the labels `database_id` and `location`. + * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ labels?: Schema$LabelDescriptor[]; /** @@ -940,7 +940,7 @@ export namespace serviceconsumermanagement_v1 { */ name?: string | null; /** - * Required. The monitored resource type. For example, the type `cloudsql_database` represents databases in Google Cloud SQL. All service defined monitored resource types must be prefixed with the service name, in the format of `{service name}/{relative resource name}`. The relative resource name must follow: * Only upper and lower-case letters and digits are allowed. * It must start with upper case character and is recommended to use Upper Camel Case style. * The maximum number of characters allowed for the relative_resource_name is 100. Note there are legacy service monitored resources not following this rule. + * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. */ type?: string | null; } diff --git a/src/apis/serviceconsumermanagement/v1beta1.ts b/src/apis/serviceconsumermanagement/v1beta1.ts index 97a5ec0ff6..8a04449616 100644 --- a/src/apis/serviceconsumermanagement/v1beta1.ts +++ b/src/apis/serviceconsumermanagement/v1beta1.ts @@ -724,7 +724,7 @@ export namespace serviceconsumermanagement_v1beta1 { syntax?: string | null; } /** - * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. The following are specific rules for service defined Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `description` fields are all required. The `unit` field must be specified if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default 500 metric descriptors per service is allowed. * Maximum of default 10 labels per metric descriptor is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas + * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. */ export interface Schema$MetricDescriptor { /** @@ -736,7 +736,7 @@ export namespace serviceconsumermanagement_v1beta1 { */ displayName?: string | null; /** - * The set of labels that can be used to describe a specific instance of this metric type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. + * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; /** @@ -760,7 +760,7 @@ export namespace serviceconsumermanagement_v1beta1 { */ name?: string | null; /** - * The metric type, including its DNS name prefix. The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of `{service name}/{relative metric name}`, such as `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric name must follow: * Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. * The maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name `custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/user/`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" + * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ type?: string | null; /** @@ -816,7 +816,7 @@ export namespace serviceconsumermanagement_v1beta1 { root?: string | null; } /** - * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different services can support different monitored resource types. The following are specific rules to service defined monitored resources for Monitoring and Logging: * The `type`, `display_name`, `description`, `labels` and `launch_stage` fields are all required. * The first label of the monitored resource descriptor must be `resource_container`. There are legacy monitored resource descritptors start with `project_id`. * It must include a `location` label. * Maximum of default 5 service defined monitored resource descriptors is allowed per service. * Maximum of default 10 labels per monitored resource is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas + * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. */ export interface Schema$MonitoredResourceDescriptor { /** @@ -828,7 +828,7 @@ export namespace serviceconsumermanagement_v1beta1 { */ displayName?: string | null; /** - * Required. A set of labels used to describe instances of this monitored resource type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, an individual Google Cloud SQL database is identified by values for the labels `database_id` and `location`. + * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ labels?: Schema$LabelDescriptor[]; /** @@ -840,7 +840,7 @@ export namespace serviceconsumermanagement_v1beta1 { */ name?: string | null; /** - * Required. The monitored resource type. For example, the type `cloudsql_database` represents databases in Google Cloud SQL. All service defined monitored resource types must be prefixed with the service name, in the format of `{service name}/{relative resource name}`. The relative resource name must follow: * Only upper and lower-case letters and digits are allowed. * It must start with upper case character and is recommended to use Upper Camel Case style. * The maximum number of characters allowed for the relative_resource_name is 100. Note there are legacy service monitored resources not following this rule. + * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. */ type?: string | null; } diff --git a/src/apis/servicenetworking/v1.ts b/src/apis/servicenetworking/v1.ts index cc3ab54199..71d01d9bff 100644 --- a/src/apis/servicenetworking/v1.ts +++ b/src/apis/servicenetworking/v1.ts @@ -975,7 +975,7 @@ export namespace servicenetworking_v1 { syntax?: string | null; } /** - * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. The following are specific rules for service defined Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `description` fields are all required. The `unit` field must be specified if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default 500 metric descriptors per service is allowed. * Maximum of default 10 labels per metric descriptor is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas + * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. */ export interface Schema$MetricDescriptor { /** @@ -987,7 +987,7 @@ export namespace servicenetworking_v1 { */ displayName?: string | null; /** - * The set of labels that can be used to describe a specific instance of this metric type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. + * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; /** @@ -1011,7 +1011,7 @@ export namespace servicenetworking_v1 { */ name?: string | null; /** - * The metric type, including its DNS name prefix. The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of `{service name}/{relative metric name}`, such as `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric name must follow: * Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. * The maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name `custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/user/`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" + * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ type?: string | null; /** @@ -1067,7 +1067,7 @@ export namespace servicenetworking_v1 { root?: string | null; } /** - * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different services can support different monitored resource types. The following are specific rules to service defined monitored resources for Monitoring and Logging: * The `type`, `display_name`, `description`, `labels` and `launch_stage` fields are all required. * The first label of the monitored resource descriptor must be `resource_container`. There are legacy monitored resource descritptors start with `project_id`. * It must include a `location` label. * Maximum of default 5 service defined monitored resource descriptors is allowed per service. * Maximum of default 10 labels per monitored resource is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas + * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. */ export interface Schema$MonitoredResourceDescriptor { /** @@ -1079,7 +1079,7 @@ export namespace servicenetworking_v1 { */ displayName?: string | null; /** - * Required. A set of labels used to describe instances of this monitored resource type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, an individual Google Cloud SQL database is identified by values for the labels `database_id` and `location`. + * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ labels?: Schema$LabelDescriptor[]; /** @@ -1091,7 +1091,7 @@ export namespace servicenetworking_v1 { */ name?: string | null; /** - * Required. The monitored resource type. For example, the type `cloudsql_database` represents databases in Google Cloud SQL. All service defined monitored resource types must be prefixed with the service name, in the format of `{service name}/{relative resource name}`. The relative resource name must follow: * Only upper and lower-case letters and digits are allowed. * It must start with upper case character and is recommended to use Upper Camel Case style. * The maximum number of characters allowed for the relative_resource_name is 100. Note there are legacy service monitored resources not following this rule. + * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. */ type?: string | null; } diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index 1674175a48..b64874e2df 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -876,7 +876,7 @@ export namespace servicenetworking_v1beta { syntax?: string | null; } /** - * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. The following are specific rules for service defined Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `description` fields are all required. The `unit` field must be specified if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default 500 metric descriptors per service is allowed. * Maximum of default 10 labels per metric descriptor is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas + * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. */ export interface Schema$MetricDescriptor { /** @@ -888,7 +888,7 @@ export namespace servicenetworking_v1beta { */ displayName?: string | null; /** - * The set of labels that can be used to describe a specific instance of this metric type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. + * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; /** @@ -912,7 +912,7 @@ export namespace servicenetworking_v1beta { */ name?: string | null; /** - * The metric type, including its DNS name prefix. The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of `{service name}/{relative metric name}`, such as `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric name must follow: * Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. * The maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name `custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/user/`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" + * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ type?: string | null; /** @@ -968,7 +968,7 @@ export namespace servicenetworking_v1beta { root?: string | null; } /** - * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different services can support different monitored resource types. The following are specific rules to service defined monitored resources for Monitoring and Logging: * The `type`, `display_name`, `description`, `labels` and `launch_stage` fields are all required. * The first label of the monitored resource descriptor must be `resource_container`. There are legacy monitored resource descritptors start with `project_id`. * It must include a `location` label. * Maximum of default 5 service defined monitored resource descriptors is allowed per service. * Maximum of default 10 labels per monitored resource is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas + * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. */ export interface Schema$MonitoredResourceDescriptor { /** @@ -980,7 +980,7 @@ export namespace servicenetworking_v1beta { */ displayName?: string | null; /** - * Required. A set of labels used to describe instances of this monitored resource type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, an individual Google Cloud SQL database is identified by values for the labels `database_id` and `location`. + * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ labels?: Schema$LabelDescriptor[]; /** @@ -992,7 +992,7 @@ export namespace servicenetworking_v1beta { */ name?: string | null; /** - * Required. The monitored resource type. For example, the type `cloudsql_database` represents databases in Google Cloud SQL. All service defined monitored resource types must be prefixed with the service name, in the format of `{service name}/{relative resource name}`. The relative resource name must follow: * Only upper and lower-case letters and digits are allowed. * It must start with upper case character and is recommended to use Upper Camel Case style. * The maximum number of characters allowed for the relative_resource_name is 100. Note there are legacy service monitored resources not following this rule. + * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. */ type?: string | null; } diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index 484deea65e..bb363b24a4 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -1143,7 +1143,7 @@ export namespace serviceusage_v1 { syntax?: string | null; } /** - * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. The following are specific rules for service defined Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `description` fields are all required. The `unit` field must be specified if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default 500 metric descriptors per service is allowed. * Maximum of default 10 labels per metric descriptor is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas + * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. */ export interface Schema$MetricDescriptor { /** @@ -1155,7 +1155,7 @@ export namespace serviceusage_v1 { */ displayName?: string | null; /** - * The set of labels that can be used to describe a specific instance of this metric type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. + * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; /** @@ -1179,7 +1179,7 @@ export namespace serviceusage_v1 { */ name?: string | null; /** - * The metric type, including its DNS name prefix. The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of `{service name}/{relative metric name}`, such as `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric name must follow: * Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. * The maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name `custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/user/`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" + * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ type?: string | null; /** @@ -1235,7 +1235,7 @@ export namespace serviceusage_v1 { root?: string | null; } /** - * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different services can support different monitored resource types. The following are specific rules to service defined monitored resources for Monitoring and Logging: * The `type`, `display_name`, `description`, `labels` and `launch_stage` fields are all required. * The first label of the monitored resource descriptor must be `resource_container`. There are legacy monitored resource descritptors start with `project_id`. * It must include a `location` label. * Maximum of default 5 service defined monitored resource descriptors is allowed per service. * Maximum of default 10 labels per monitored resource is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas + * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. */ export interface Schema$MonitoredResourceDescriptor { /** @@ -1247,7 +1247,7 @@ export namespace serviceusage_v1 { */ displayName?: string | null; /** - * Required. A set of labels used to describe instances of this monitored resource type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, an individual Google Cloud SQL database is identified by values for the labels `database_id` and `location`. + * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ labels?: Schema$LabelDescriptor[]; /** @@ -1259,7 +1259,7 @@ export namespace serviceusage_v1 { */ name?: string | null; /** - * Required. The monitored resource type. For example, the type `cloudsql_database` represents databases in Google Cloud SQL. All service defined monitored resource types must be prefixed with the service name, in the format of `{service name}/{relative resource name}`. The relative resource name must follow: * Only upper and lower-case letters and digits are allowed. * It must start with upper case character and is recommended to use Upper Camel Case style. * The maximum number of characters allowed for the relative_resource_name is 100. Note there are legacy service monitored resources not following this rule. + * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. */ type?: string | null; } diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index a75eb3402c..f6d077d04f 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -1227,7 +1227,7 @@ export namespace serviceusage_v1beta1 { syntax?: string | null; } /** - * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. The following are specific rules for service defined Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `description` fields are all required. The `unit` field must be specified if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default 500 metric descriptors per service is allowed. * Maximum of default 10 labels per metric descriptor is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas + * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. */ export interface Schema$MetricDescriptor { /** @@ -1239,7 +1239,7 @@ export namespace serviceusage_v1beta1 { */ displayName?: string | null; /** - * The set of labels that can be used to describe a specific instance of this metric type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. + * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; /** @@ -1263,7 +1263,7 @@ export namespace serviceusage_v1beta1 { */ name?: string | null; /** - * The metric type, including its DNS name prefix. The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of `{service name}/{relative metric name}`, such as `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric name must follow: * Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. * The maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name `custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/user/`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" + * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ type?: string | null; /** @@ -1319,7 +1319,7 @@ export namespace serviceusage_v1beta1 { root?: string | null; } /** - * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different services can support different monitored resource types. The following are specific rules to service defined monitored resources for Monitoring and Logging: * The `type`, `display_name`, `description`, `labels` and `launch_stage` fields are all required. * The first label of the monitored resource descriptor must be `resource_container`. There are legacy monitored resource descritptors start with `project_id`. * It must include a `location` label. * Maximum of default 5 service defined monitored resource descriptors is allowed per service. * Maximum of default 10 labels per monitored resource is allowed. The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas + * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. */ export interface Schema$MonitoredResourceDescriptor { /** @@ -1331,7 +1331,7 @@ export namespace serviceusage_v1beta1 { */ displayName?: string | null; /** - * Required. A set of labels used to describe instances of this monitored resource type. The label key name must follow: * Only upper and lower-case letters, digits and underscores (_) are allowed. * Label name must start with a letter or digit. * The maximum length of a label name is 100 characters. For example, an individual Google Cloud SQL database is identified by values for the labels `database_id` and `location`. + * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ labels?: Schema$LabelDescriptor[]; /** @@ -1343,7 +1343,7 @@ export namespace serviceusage_v1beta1 { */ name?: string | null; /** - * Required. The monitored resource type. For example, the type `cloudsql_database` represents databases in Google Cloud SQL. All service defined monitored resource types must be prefixed with the service name, in the format of `{service name}/{relative resource name}`. The relative resource name must follow: * Only upper and lower-case letters and digits are allowed. * It must start with upper case character and is recommended to use Upper Camel Case style. * The maximum number of characters allowed for the relative_resource_name is 100. Note there are legacy service monitored resources not following this rule. + * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. */ type?: string | null; } diff --git a/src/apis/sourcerepo/v1.ts b/src/apis/sourcerepo/v1.ts index 587c68f977..5b58972758 100644 --- a/src/apis/sourcerepo/v1.ts +++ b/src/apis/sourcerepo/v1.ts @@ -128,7 +128,7 @@ export namespace sourcerepo_v1 { } /** - * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -141,7 +141,7 @@ export namespace sourcerepo_v1 { service?: string | null; } /** - * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** diff --git a/src/apis/storagetransfer/v1.ts b/src/apis/storagetransfer/v1.ts index ee183eccd7..af1702ea44 100644 --- a/src/apis/storagetransfer/v1.ts +++ b/src/apis/storagetransfer/v1.ts @@ -307,7 +307,7 @@ export namespace storagetransfer_v1 { pubsubTopic?: string | null; } /** - * Conditions that determine which objects will be transferred. Applies only to S3 and Cloud Storage objects. The "last modification time" refers to the time of the last change to the object's content or metadata — specifically, this is the `updated` property of Cloud Storage objects and the `LastModified` field of S3 objects. + * Conditions that determine which objects will be transferred. Applies only to Cloud Data Sources such as S3, Azure, and Cloud Storage. The "last modification time" refers to the time of the last change to the object's content or metadata — specifically, this is the `updated` property of Cloud Storage objects, the `LastModified` field of S3 objects, and the `Last-Modified` header of Azure blobs. */ export interface Schema$ObjectConditions { /** @@ -583,7 +583,7 @@ export namespace storagetransfer_v1 { transferSpec?: Schema$TransferSpec; } /** - * TransferOptions uses three boolean parameters to define the actions to be performed on objects in a transfer. + * TransferOptions define the actions to be performed on objects in a transfer. */ export interface Schema$TransferOptions { /** diff --git a/src/apis/testing/v1.ts b/src/apis/testing/v1.ts index d14f325de0..8f3e723028 100644 --- a/src/apis/testing/v1.ts +++ b/src/apis/testing/v1.ts @@ -192,7 +192,7 @@ export namespace testing_v1 { androidDevices?: Schema$AndroidDevice[]; } /** - * A test of an Android application that can control an Android component independently of its normal lifecycle. Android instrumentation tests run an application APK and test APK inside the same process on a virtual or physical AndroidDevice. They also specify a test runner class, such as com.google.GoogleTestRunner, which can vary on the specific instrumentation framework chosen. See <http://developer.android.com/tools/testing/testing_android.html> for more information on types of Android tests. + * A test of an Android application that can control an Android component independently of its normal lifecycle. Android instrumentation tests run an application APK and test APK inside the same process on a virtual or physical AndroidDevice. They also specify a test runner class, such as com.google.GoogleTestRunner, which can vary on the specific instrumentation framework chosen. See for more information on types of Android tests. */ export interface Schema$AndroidInstrumentationTest { /** @@ -208,7 +208,7 @@ export namespace testing_v1 { */ appPackageId?: string | null; /** - * The option of whether running each test within its own invocation of instrumentation with Android Test Orchestrator or not. ** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or higher! ** Orchestrator offers the following benefits: - No shared state - Crashes are isolated - Logs are scoped per test See <https://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator> for more information about Android Test Orchestrator. If not set, the test will be run without the orchestrator. + * The option of whether running each test within its own invocation of instrumentation with Android Test Orchestrator or not. ** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or higher! ** Orchestrator offers the following benefits: - No shared state - Crashes are isolated - Logs are scoped per test See for more information about Android Test Orchestrator. If not set, the test will be run without the orchestrator. */ orchestratorOption?: string | null; /** @@ -228,12 +228,12 @@ export namespace testing_v1 { */ testRunnerClass?: string | null; /** - * Each target must be fully qualified with the package name or class name, in one of these formats: - "package package_name" - "class package_name.class_name" - "class package_name.class_name#method_name" If empty, all targets in the module will be run. + * Each target must be fully qualified with the package name or class name, in one of these formats: - "package package_name" - "class package_name.class_name" - "class package_name.class_name#method_name" If empty, all targets in the module will be run. */ testTargets?: string[] | null; } /** - * A set of Android device configuration permutations is defined by the the cross-product of the given axes. Internally, the given AndroidMatrix will be expanded into a set of AndroidDevices. Only supported permutations will be instantiated. Invalid permutations (e.g., incompatible models/versions) are ignored. + * A set of Android device configuration permutations is defined by the the cross-product of the given axes. Internally, the given AndroidMatrix will be expanded into a set of AndroidDevices. Only supported permutations will be instantiated. Invalid permutations (e.g., incompatible models/versions) are ignored. */ export interface Schema$AndroidMatrix { /** @@ -302,7 +302,7 @@ export namespace testing_v1 { */ screenY?: number | null; /** - * The list of supported ABIs for this device. This corresponds to either android.os.Build.SUPPORTED_ABIS (for API level 21 and above) or android.os.Build.CPU_ABI/CPU_ABI2. The most preferred ABI is the first element in the list. Elements are optionally prefixed by "version_id:" (where version_id is the id of an AndroidVersion), denoting an ABI that is supported only on a particular version. + * The list of supported ABIs for this device. This corresponds to either android.os.Build.SUPPORTED_ABIS (for API level 21 and above) or android.os.Build.CPU_ABI/CPU_ABI2. The most preferred ABI is the first element in the list. Elements are optionally prefixed by "version_id:" (where version_id is the id of an AndroidVersion), denoting an ABI that is supported only on a particular version. */ supportedAbis?: string[] | null; /** @@ -373,7 +373,7 @@ export namespace testing_v1 { orientations?: Schema$Orientation[]; } /** - * A test of an Android Application with a Test Loop. The intent \<intent-name\> will be implicitly added, since Games is the only user of this api, for the time being. + * A test of an Android Application with a Test Loop. The intent \ will be implicitly added, since Games is the only user of this api, for the time being. */ export interface Schema$AndroidTestLoop { /** @@ -476,7 +476,7 @@ export namespace testing_v1 { targetSdkVersion?: number | null; } /** - * An Android App Bundle file format, containing a BundleConfig.pb file, a base module directory, zero or more dynamic feature module directories. <p>See https://developer.android.com/guide/app-bundle/build for guidance on building App Bundles. + * An Android App Bundle file format, containing a BundleConfig.pb file, a base module directory, zero or more dynamic feature module directories. See https://developer.android.com/guide/app-bundle/build for guidance on building App Bundles. */ export interface Schema$AppBundle { /** @@ -520,7 +520,7 @@ export namespace testing_v1 { value?: string | null; } /** - * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. */ export interface Schema$Date { /** @@ -663,19 +663,19 @@ export namespace testing_v1 { gcsPath?: string | null; } /** - * The <intent-filter> section of an <activity> tag. https://developer.android.com/guide/topics/manifest/intent-filter-element.html + * The section of an tag. https://developer.android.com/guide/topics/manifest/intent-filter-element.html */ export interface Schema$IntentFilter { /** - * The android:name value of the <action> tag. + * The android:name value of the tag. */ actionNames?: string[] | null; /** - * The android:name value of the <category> tag. + * The android:name value of the tag. */ categoryNames?: string[] | null; /** - * The android:mimeType value of the <data> tag. + * The android:mimeType value of the tag. */ mimeType?: string | null; } @@ -886,11 +886,11 @@ export namespace testing_v1 { tags?: string[] | null; } /** - * Shards test cases into the specified groups of packages, classes, and/or methods. With manual sharding enabled, specifying test targets via environment_variables or in InstrumentationTest is invalid. + * Shards test cases into the specified groups of packages, classes, and/or methods. With manual sharding enabled, specifying test targets via environment_variables or in InstrumentationTest is invalid. */ export interface Schema$ManualSharding { /** - * Required. Group of packages, classes, and/or test methods to be run for each shard. When any physical devices are selected, the number of test_targets_for_shard must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 250. + * Required. Group of packages, classes, and/or test methods to be run for each shard. When any physical devices are selected, the number of test_targets_for_shard must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 250. */ testTargetsForShard?: Schema$TestTargetsForShard[]; } @@ -920,7 +920,7 @@ export namespace testing_v1 { */ obb?: Schema$FileReference; /** - * Required. OBB file name which must conform to the format as specified by Android e.g. [main|patch].0300110.com.example.android.obb which will be installed into \<shared-storage\>/Android/obb/\<package-name\>/ on the device. + * Required. OBB file name which must conform to the format as specified by Android e.g. [main|patch].0300110.com.example.android.obb which will be installed into \/Android/obb/\/ on the device. */ obbFileName?: string | null; } @@ -959,7 +959,7 @@ export namespace testing_v1 { */ content?: Schema$FileReference; /** - * Required. Where to put the content on the device. Must be an absolute, allowlisted path. If the file exists, it will be replaced. The following device-side directories and any of their subdirectories are allowlisted: <p>${EXTERNAL_STORAGE}, /sdcard, or /storage</p> <p>${ANDROID_DATA}/local/tmp, or /data/local/tmp</p> <p>Specifying a path outside of these directory trees is invalid. <p> The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device and copy the file there. <p> It is strongly advised to use the <a href= "http://developer.android.com/reference/android/os/Environment.html"> Environment API</a> in app and test code to access files on the device in a portable way. + * Required. Where to put the content on the device. Must be an absolute, allowlisted path. If the file exists, it will be replaced. The following device-side directories and any of their subdirectories are allowlisted: ${EXTERNAL_STORAGE}, /sdcard, or /storage ${ANDROID_DATA}/local/tmp, or /data/local/tmp Specifying a path outside of these directory trees is invalid. The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device and copy the file there. It is strongly advised to use the Environment API in app and test code to access files on the device in a portable way. */ devicePath?: string | null; } @@ -980,7 +980,7 @@ export namespace testing_v1 { */ toolResultsExecution?: Schema$ToolResultsExecution; /** - * The tool results history that contains the tool results execution that results are written to. If not provided, the service will choose an appropriate value. + * The tool results history that contains the tool results execution that results are written to. If not provided, the service will choose an appropriate value. */ toolResultsHistory?: Schema$ToolResultsHistory; } @@ -997,7 +997,7 @@ export namespace testing_v1 { */ inputText?: string | null; /** - * Required. The android resource name of the target UI element. For example, in Java: R.string.foo in xml: @string/foo Only the "foo" part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html + * Required. The android resource name of the target UI element. For example, in Java: R.string.foo in xml: @string/foo Only the "foo" part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html */ resourceName?: string | null; } @@ -1080,7 +1080,7 @@ export namespace testing_v1 { */ errorMessage?: string | null; /** - * Output only. Human-readable, detailed descriptions of the test's progress. For example: "Provisioning a device", "Starting Test". During the course of execution new data may be appended to the end of progress_messages. + * Output only. Human-readable, detailed descriptions of the test's progress. For example: "Provisioning a device", "Starting Test". During the course of execution new data may be appended to the end of progress_messages. */ progressMessages?: string[] | null; } @@ -1167,7 +1167,7 @@ export namespace testing_v1 { */ environmentMatrix?: Schema$EnvironmentMatrix; /** - * The number of times a TestExecution should be re-attempted if one or more of its test cases fail for any reason. The maximum number of reruns allowed is 10. Default is 0, which implies no reruns. + * The number of times a TestExecution should be re-attempted if one or more of its test cases fail for any reason. The maximum number of reruns allowed is 10. Default is 0, which implies no reruns. */ flakyTestAttempts?: number | null; /** @@ -1220,7 +1220,7 @@ export namespace testing_v1 { */ additionalApks?: Schema$Apk[]; /** - * List of directories on the device to upload to GCS at the end of the test; they must be absolute paths under /sdcard, /storage or /data/local/tmp. Path names are restricted to characters a-z A-Z 0-9 _ - . + and / Note: The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device. + * List of directories on the device to upload to GCS at the end of the test; they must be absolute paths under /sdcard, /storage or /data/local/tmp. Path names are restricted to characters a-z A-Z 0-9 _ - . + and / Note: The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device. */ directoriesToPull?: string[] | null; /** @@ -1294,12 +1294,12 @@ export namespace testing_v1 { */ export interface Schema$TestTargetsForShard { /** - * Group of packages, classes, and/or test methods to be run for each shard. The targets need to be specified in AndroidJUnitRunner argument format. For example, “package com.my.packages” “class com.my.package.MyClass”. The number of shard_test_targets must be greater than 0. + * Group of packages, classes, and/or test methods to be run for each shard. The targets need to be specified in AndroidJUnitRunner argument format. For example, "package com.my.packages" "class com.my.package.MyClass". The number of shard_test_targets must be greater than 0. */ testTargets?: string[] | null; } /** - * Represents a tool results execution resource. This has the results of a TestMatrix. + * Represents a tool results execution resource. This has the results of a TestMatrix. */ export interface Schema$ToolResultsExecution { /** @@ -1329,7 +1329,7 @@ export namespace testing_v1 { projectId?: string | null; } /** - * Represents a tool results step resource. This has the results of a TestExecution. + * Represents a tool results step resource. This has the results of a TestExecution. */ export interface Schema$ToolResultsStep { /** @@ -1375,7 +1375,7 @@ export namespace testing_v1 { packetLossRatio?: number | null; } /** - * Uniformly shards test cases given a total number of shards. For Instrumentation test, it will be translated to “-e numShard” “-e shardIndex” AndroidJUnitRunner arguments. With uniform sharding enabled, specifying these sharding arguments via environment_variables is invalid. + * Uniformly shards test cases given a total number of shards. For Instrumentation test, it will be translated to "-e numShard" "-e shardIndex" AndroidJUnitRunner arguments. With uniform sharding enabled, specifying these sharding arguments via environment_variables is invalid. */ export interface Schema$UniformSharding { /** @@ -1571,7 +1571,7 @@ export namespace testing_v1 { /** * testing.projects.testMatrices.cancel - * @desc Cancels unfinished test executions in a test matrix. This call returns immediately and cancellation proceeds asychronously. If the matrix is already final, this operation will have no effect. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist + * @desc Cancels unfinished test executions in a test matrix. This call returns immediately and cancellation proceeds asynchronously. If the matrix is already final, this operation will have no effect. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist * @example * // Before running the sample: * // - Enable the API at: @@ -1712,7 +1712,7 @@ export namespace testing_v1 { /** * testing.projects.testMatrices.create - * @desc Creates and runs a matrix of tests according to the given specifications. Unsupported environments will be returned in the state UNSUPPORTED. Matrices are limited to at most 200 supported executions. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed or if the matrix expands to more than 200 supported executions + * @desc Creates and runs a matrix of tests according to the given specifications. Unsupported environments will be returned in the state UNSUPPORTED. Matrices are limited to at most 200 supported executions. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed or if the matrix expands to more than 200 supported executions * @example * // Before running the sample: * // - Enable the API at: @@ -1739,12 +1739,7 @@ export namespace testing_v1 { * const res = await testing.projects.testMatrices.create({ * // The GCE project under which this job will run. * projectId: 'placeholder-value', - * // A string id used to detect duplicated requests. - * // Ids are automatically scoped to a project, so - * // users should ensure the ID is unique per-project. - * // A UUID is recommended. - * // - * // Optional, but strongly recommended. + * // A string id used to detect duplicated requests. Ids are automatically scoped to a project, so users should ensure the ID is unique per-project. A UUID is recommended. Optional, but strongly recommended. * requestId: 'placeholder-value', * * // Request body metadata @@ -1795,7 +1790,7 @@ export namespace testing_v1 { * * @param {object} params Parameters for request * @param {string} params.projectId The GCE project under which this job will run. - * @param {string=} params.requestId A string id used to detect duplicated requests. Ids are automatically scoped to a project, so users should ensure the ID is unique per-project. A UUID is recommended. Optional, but strongly recommended. + * @param {string=} params.requestId A string id used to detect duplicated requests. Ids are automatically scoped to a project, so users should ensure the ID is unique per-project. A UUID is recommended. Optional, but strongly recommended. * @param {().TestMatrix} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1882,7 +1877,7 @@ export namespace testing_v1 { /** * testing.projects.testMatrices.get - * @desc Checks the status of a test matrix. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist + * @desc Checks the status of a test matrix. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist * @example * // Before running the sample: * // - Enable the API at: @@ -2046,7 +2041,7 @@ export namespace testing_v1 { */ projectId?: string; /** - * A string id used to detect duplicated requests. Ids are automatically scoped to a project, so users should ensure the ID is unique per-project. A UUID is recommended. Optional, but strongly recommended. + * A string id used to detect duplicated requests. Ids are automatically scoped to a project, so users should ensure the ID is unique per-project. A UUID is recommended. Optional, but strongly recommended. */ requestId?: string; @@ -2075,7 +2070,7 @@ export namespace testing_v1 { /** * testing.testEnvironmentCatalog.get - * @desc Gets the catalog of supported test environments. May return any of the following canonical error codes: - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the environment type does not exist - INTERNAL - if an internal error occurred + * @desc Gets the catalog of supported test environments. May return any of the following canonical error codes: - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the environment type does not exist - INTERNAL - if an internal error occurred * @example * // Before running the sample: * // - Enable the API at: diff --git a/src/apis/texttospeech/v1beta1.ts b/src/apis/texttospeech/v1beta1.ts index 75a3c5e690..95eb9b3d5f 100644 --- a/src/apis/texttospeech/v1beta1.ts +++ b/src/apis/texttospeech/v1beta1.ts @@ -188,6 +188,10 @@ export namespace texttospeech_v1beta1 { * Required. The configuration of the synthesized audio. */ audioConfig?: Schema$AudioConfig; + /** + * Whether and what timepoints are returned in the response. + */ + enableTimePointing?: string[] | null; /** * Required. The Synthesizer requires either plain text or SSML as input. */ @@ -201,10 +205,31 @@ export namespace texttospeech_v1beta1 { * The message returned to the client by the `SynthesizeSpeech` method. */ export interface Schema$SynthesizeSpeechResponse { + /** + * The audio metadata of `audio_content`. + */ + audioConfig?: Schema$AudioConfig; /** * The audio data bytes encoded as specified in the request, including the header for encodings that are wrapped in containers (e.g. MP3, OGG_OPUS). For LINEAR16 audio, we include the WAV header. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ audioContent?: string | null; + /** + * A link between a position in the original request input and a corresponding time in the output audio. It's only supported via <mark> of SSML input. + */ + timepoints?: Schema$Timepoint[]; + } + /** + * This contains a mapping between a certain point in the input text and a corresponding time in the output audio. + */ + export interface Schema$Timepoint { + /** + * Timepoint name as received from the client within <mark> tag. + */ + markName?: string | null; + /** + * Time offset in seconds from the start of the synthesized audio. + */ + timeSeconds?: number | null; } /** * Description of a voice supported by the TTS service. @@ -283,6 +308,7 @@ export namespace texttospeech_v1beta1 { * // request body parameters * // { * // "audioConfig": {}, + * // "enableTimePointing": [], * // "input": {}, * // "voice": {} * // } @@ -292,7 +318,9 @@ export namespace texttospeech_v1beta1 { * * // Example response * // { - * // "audioContent": "my_audioContent" + * // "audioConfig": {}, + * // "audioContent": "my_audioContent", + * // "timepoints": [] * // } * } * diff --git a/src/apis/translate/v3.ts b/src/apis/translate/v3.ts index 5091912c6e..eb3d8078af 100644 --- a/src/apis/translate/v3.ts +++ b/src/apis/translate/v3.ts @@ -2591,7 +2591,20 @@ export namespace translate_v3 { * // Do the magic * const res = await translate.projects.locations.glossaries.list({ * // Optional. Filter specifying constraints of a list operation. - * // Filtering is not supported yet, and the parameter currently has no effect. + * // Specify the constraint by the format of "key=value", where key must be + * // "src" or "tgt", and the value must be a valid language code. + * // For multiple restrictions, concatenate them by "AND" (uppercase only), + * // such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used + * // here, which means using 'en-US' and 'en' can lead to different results, + * // which depends on the language code you used when you create the glossary. + * // For the unidirectional glossaries, the "src" and "tgt" add restrictions + * // on the source and target language code separately. + * // For the equivalent term set glossaries, the "src" and/or "tgt" add + * // restrictions on the term set. + * // For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional + * // glossaries which exactly match the source language code as "en-US" and the + * // target language code "zh-CN", but all equivalent term set glossaries which + * // contain "en-US" and "zh-CN" in their language set will be picked. * // If missing, no filtering is performed. * filter: 'placeholder-value', * // Optional. Requested page size. The server may return fewer glossaries than @@ -2623,7 +2636,7 @@ export namespace translate_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Optional. Filter specifying constraints of a list operation. Filtering is not supported yet, and the parameter currently has no effect. If missing, no filtering is performed. + * @param {string=} params.filter Optional. Filter specifying constraints of a list operation. Specify the constraint by the format of "key=value", where key must be "src" or "tgt", and the value must be a valid language code. For multiple restrictions, concatenate them by "AND" (uppercase only), such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used here, which means using 'en-US' and 'en' can lead to different results, which depends on the language code you used when you create the glossary. For the unidirectional glossaries, the "src" and "tgt" add restrictions on the source and target language code separately. For the equivalent term set glossaries, the "src" and/or "tgt" add restrictions on the term set. For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional glossaries which exactly match the source language code as "en-US" and the target language code "zh-CN", but all equivalent term set glossaries which contain "en-US" and "zh-CN" in their language set will be picked. If missing, no filtering is performed. * @param {integer=} params.pageSize Optional. Requested page size. The server may return fewer glossaries than requested. If unspecified, the server picks an appropriate default. * @param {string=} params.pageToken Optional. A token identifying a page of results the server should return. Typically, this is the value of [ListGlossariesResponse.next_page_token] returned from the previous call to `ListGlossaries` method. The first page is returned if `page_token`is empty or missing. * @param {string} params.parent Required. The name of the project from which to list all of the glossaries. @@ -2745,7 +2758,7 @@ export namespace translate_v3 { export interface Params$Resource$Projects$Locations$Glossaries$List extends StandardParameters { /** - * Optional. Filter specifying constraints of a list operation. Filtering is not supported yet, and the parameter currently has no effect. If missing, no filtering is performed. + * Optional. Filter specifying constraints of a list operation. Specify the constraint by the format of "key=value", where key must be "src" or "tgt", and the value must be a valid language code. For multiple restrictions, concatenate them by "AND" (uppercase only), such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used here, which means using 'en-US' and 'en' can lead to different results, which depends on the language code you used when you create the glossary. For the unidirectional glossaries, the "src" and "tgt" add restrictions on the source and target language code separately. For the equivalent term set glossaries, the "src" and/or "tgt" add restrictions on the term set. For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional glossaries which exactly match the source language code as "en-US" and the target language code "zh-CN", but all equivalent term set glossaries which contain "en-US" and "zh-CN" in their language set will be picked. If missing, no filtering is performed. */ filter?: string; /** diff --git a/src/apis/translate/v3beta1.ts b/src/apis/translate/v3beta1.ts index 8fc2dee2a3..7b6279a770 100644 --- a/src/apis/translate/v3beta1.ts +++ b/src/apis/translate/v3beta1.ts @@ -2591,7 +2591,20 @@ export namespace translate_v3beta1 { * // Do the magic * const res = await translate.projects.locations.glossaries.list({ * // Optional. Filter specifying constraints of a list operation. - * // Filtering is not supported yet, and the parameter currently has no effect. + * // Specify the constraint by the format of "key=value", where key must be + * // "src" or "tgt", and the value must be a valid language code. + * // For multiple restrictions, concatenate them by "AND" (uppercase only), + * // such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used + * // here, which means using 'en-US' and 'en' can lead to different results, + * // which depends on the language code you used when you create the glossary. + * // For the unidirectional glossaries, the "src" and "tgt" add restrictions + * // on the source and target language code separately. + * // For the equivalent term set glossaries, the "src" and/or "tgt" add + * // restrictions on the term set. + * // For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional + * // glossaries which exactly match the source language code as "en-US" and the + * // target language code "zh-CN", but all equivalent term set glossaries which + * // contain "en-US" and "zh-CN" in their language set will be picked. * // If missing, no filtering is performed. * filter: 'placeholder-value', * // Optional. Requested page size. The server may return fewer glossaries than @@ -2623,7 +2636,7 @@ export namespace translate_v3beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Optional. Filter specifying constraints of a list operation. Filtering is not supported yet, and the parameter currently has no effect. If missing, no filtering is performed. + * @param {string=} params.filter Optional. Filter specifying constraints of a list operation. Specify the constraint by the format of "key=value", where key must be "src" or "tgt", and the value must be a valid language code. For multiple restrictions, concatenate them by "AND" (uppercase only), such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used here, which means using 'en-US' and 'en' can lead to different results, which depends on the language code you used when you create the glossary. For the unidirectional glossaries, the "src" and "tgt" add restrictions on the source and target language code separately. For the equivalent term set glossaries, the "src" and/or "tgt" add restrictions on the term set. For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional glossaries which exactly match the source language code as "en-US" and the target language code "zh-CN", but all equivalent term set glossaries which contain "en-US" and "zh-CN" in their language set will be picked. If missing, no filtering is performed. * @param {integer=} params.pageSize Optional. Requested page size. The server may return fewer glossaries than requested. If unspecified, the server picks an appropriate default. * @param {string=} params.pageToken Optional. A token identifying a page of results the server should return. Typically, this is the value of [ListGlossariesResponse.next_page_token] returned from the previous call to `ListGlossaries` method. The first page is returned if `page_token`is empty or missing. * @param {string} params.parent Required. The name of the project from which to list all of the glossaries. @@ -2745,7 +2758,7 @@ export namespace translate_v3beta1 { export interface Params$Resource$Projects$Locations$Glossaries$List extends StandardParameters { /** - * Optional. Filter specifying constraints of a list operation. Filtering is not supported yet, and the parameter currently has no effect. If missing, no filtering is performed. + * Optional. Filter specifying constraints of a list operation. Specify the constraint by the format of "key=value", where key must be "src" or "tgt", and the value must be a valid language code. For multiple restrictions, concatenate them by "AND" (uppercase only), such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used here, which means using 'en-US' and 'en' can lead to different results, which depends on the language code you used when you create the glossary. For the unidirectional glossaries, the "src" and "tgt" add restrictions on the source and target language code separately. For the equivalent term set glossaries, the "src" and/or "tgt" add restrictions on the term set. For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional glossaries which exactly match the source language code as "en-US" and the target language code "zh-CN", but all equivalent term set glossaries which contain "en-US" and "zh-CN" in their language set will be picked. If missing, no filtering is performed. */ filter?: string; /**