From 701edf301c4fd910f335774cc6f4d4f1d62c5436 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Mon, 10 Aug 2020 19:24:14 -0700 Subject: [PATCH] feat: run the generator (#2321) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat(cloudprofiler): update the API #### cloudprofiler:v2 The following keys were added: - schemas.CreateProfileRequest.properties.profileType.items.enumDescriptions The following keys were changed: - resources.projects.resources.profiles.methods.create.description - resources.projects.resources.profiles.methods.createOffline.description - resources.projects.resources.profiles.methods.patch.description - resources.projects.resources.profiles.methods.patch.parameters.updateMask.description - schemas.CreateProfileRequest.description - schemas.CreateProfileRequest.properties.profileType.enumDescriptions - schemas.Deployment.properties.labels.description - schemas.Deployment.properties.projectId.description - schemas.Deployment.properties.target.description - schemas.Profile.properties.duration.description - schemas.Profile.properties.labels.description - schemas.Profile.properties.profileBytes.description - schemas.Profile.properties.profileType.description - schemas.Profile.properties.profileType.enumDescriptions * fix(container): update the API #### container:v1beta1 The following keys were changed: - schemas.AutoprovisioningNodePoolDefaults.properties.minCpuPlatform.description - schemas.MaintenancePolicy.properties.resourceVersion.description - schemas.NodeConfig.properties.metadata.description - schemas.NodeConfig.properties.minCpuPlatform.description - schemas.RecurringTimeWindow.properties.recurrence.description - schemas.SetLabelsRequest.properties.labelFingerprint.description * feat(displayvideo)!: update the API BREAKING CHANGE: This release has breaking changes. #### displayvideo:v1 The following keys were deleted: - schemas.BulkEditAssignedUserRolesResponse.description - schemas.ListCustomBiddingAlgorithmsResponse.description - schemas.ListPartnerAssignedTargetingOptionsResponse.description - schemas.ListPartnersResponse.description - schemas.ListUsersResponse.description The following keys were changed: - resources.advertisers.methods.audit.description - resources.customBiddingAlgorithms.methods.get.parameters.advertiserId.description - resources.customBiddingAlgorithms.methods.get.parameters.partnerId.description - resources.customBiddingAlgorithms.methods.list.parameters.advertiserId.description - resources.customBiddingAlgorithms.methods.list.parameters.partnerId.description - resources.partners.methods.bulkEditPartnerAssignedTargetingOptions.description - resources.users.methods.bulkEditAssignedUserRoles.description - schemas.AuditAdvertiserResponse.properties.usedCampaignsCount.description - schemas.AuditAdvertiserResponse.properties.usedInsertionOrdersCount.description - schemas.AuditAdvertiserResponse.properties.usedLineItemsCount.description * feat(dlp): update the API #### dlp:v2 The following keys were added: - resources.projects.resources.dlpJobs.methods.list.parameters.type.enumDescriptions - resources.projects.resources.locations.resources.dlpJobs.methods.list.parameters.type.enumDescriptions - schemas.GooglePrivacyDlpV2CloudStorageOptions.properties.fileTypes.items.enumDescriptions - schemas.GooglePrivacyDlpV2DeidentifyTemplate.properties.createTime.readOnly - schemas.GooglePrivacyDlpV2DeidentifyTemplate.properties.name.readOnly - schemas.GooglePrivacyDlpV2DeidentifyTemplate.properties.updateTime.readOnly - schemas.GooglePrivacyDlpV2InfoTypeDescription.properties.supportedBy.items.enumDescriptions - schemas.GooglePrivacyDlpV2InspectConfig.properties.contentOptions.items.enumDescriptions - schemas.GooglePrivacyDlpV2InspectTemplate.properties.createTime.readOnly - schemas.GooglePrivacyDlpV2InspectTemplate.properties.name.readOnly - schemas.GooglePrivacyDlpV2InspectTemplate.properties.updateTime.readOnly - schemas.GooglePrivacyDlpV2JobTrigger.properties.createTime.readOnly - schemas.GooglePrivacyDlpV2JobTrigger.properties.errors.readOnly - schemas.GooglePrivacyDlpV2JobTrigger.properties.lastRunTime.readOnly - schemas.GooglePrivacyDlpV2JobTrigger.properties.updateTime.readOnly The following keys were changed: - resources.infoTypes.methods.list.description - resources.infoTypes.methods.list.parameters.filter.description - resources.infoTypes.methods.list.parameters.languageCode.description - resources.infoTypes.methods.list.parameters.parent.description - resources.locations.resources.infoTypes.methods.list.description - resources.locations.resources.infoTypes.methods.list.parameters.filter.description - resources.locations.resources.infoTypes.methods.list.parameters.languageCode.description - resources.locations.resources.infoTypes.methods.list.parameters.parent.description - resources.organizations.resources.deidentifyTemplates.methods.create.description - resources.organizations.resources.deidentifyTemplates.methods.create.parameters.parent.description - resources.organizations.resources.deidentifyTemplates.methods.delete.description - resources.organizations.resources.deidentifyTemplates.methods.delete.parameters.name.description - resources.organizations.resources.deidentifyTemplates.methods.get.description - resources.organizations.resources.deidentifyTemplates.methods.get.parameters.name.description - resources.organizations.resources.deidentifyTemplates.methods.list.description - resources.organizations.resources.deidentifyTemplates.methods.list.parameters.orderBy.description - resources.organizations.resources.deidentifyTemplates.methods.list.parameters.pageSize.description - resources.organizations.resources.deidentifyTemplates.methods.list.parameters.pageToken.description - resources.organizations.resources.deidentifyTemplates.methods.list.parameters.parent.description - resources.organizations.resources.deidentifyTemplates.methods.patch.description - resources.organizations.resources.deidentifyTemplates.methods.patch.parameters.name.description - resources.organizations.resources.inspectTemplates.methods.create.description - resources.organizations.resources.inspectTemplates.methods.create.parameters.parent.description - resources.organizations.resources.inspectTemplates.methods.delete.description - resources.organizations.resources.inspectTemplates.methods.delete.parameters.name.description - resources.organizations.resources.inspectTemplates.methods.get.description - resources.organizations.resources.inspectTemplates.methods.get.parameters.name.description - resources.organizations.resources.inspectTemplates.methods.list.description - resources.organizations.resources.inspectTemplates.methods.list.parameters.orderBy.description - resources.organizations.resources.inspectTemplates.methods.list.parameters.pageSize.description - resources.organizations.resources.inspectTemplates.methods.list.parameters.pageToken.description - resources.organizations.resources.inspectTemplates.methods.list.parameters.parent.description - resources.organizations.resources.inspectTemplates.methods.patch.description - resources.organizations.resources.inspectTemplates.methods.patch.parameters.name.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.create.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.create.parameters.parent.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.delete.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.delete.parameters.name.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.get.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.get.parameters.name.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.list.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.list.parameters.orderBy.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.list.parameters.pageSize.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.list.parameters.pageToken.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.list.parameters.parent.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.patch.description - resources.organizations.resources.locations.resources.deidentifyTemplates.methods.patch.parameters.name.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.create.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.create.parameters.parent.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.delete.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.delete.parameters.name.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.get.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.get.parameters.name.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.list.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.list.parameters.orderBy.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.list.parameters.pageSize.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.list.parameters.pageToken.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.list.parameters.parent.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.patch.description - resources.organizations.resources.locations.resources.inspectTemplates.methods.patch.parameters.name.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.create.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.create.parameters.parent.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.delete.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.delete.parameters.name.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.get.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.get.parameters.name.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.list.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.list.parameters.orderBy.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.list.parameters.pageSize.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.list.parameters.pageToken.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.list.parameters.parent.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.patch.description - resources.organizations.resources.locations.resources.storedInfoTypes.methods.patch.parameters.name.description - resources.organizations.resources.storedInfoTypes.methods.create.description - resources.organizations.resources.storedInfoTypes.methods.create.parameters.parent.description - resources.organizations.resources.storedInfoTypes.methods.delete.description - resources.organizations.resources.storedInfoTypes.methods.delete.parameters.name.description - resources.organizations.resources.storedInfoTypes.methods.get.description - resources.organizations.resources.storedInfoTypes.methods.get.parameters.name.description - resources.organizations.resources.storedInfoTypes.methods.list.description - resources.organizations.resources.storedInfoTypes.methods.list.parameters.orderBy.description - resources.organizations.resources.storedInfoTypes.methods.list.parameters.pageSize.description - resources.organizations.resources.storedInfoTypes.methods.list.parameters.pageToken.description - resources.organizations.resources.storedInfoTypes.methods.list.parameters.parent.description - resources.organizations.resources.storedInfoTypes.methods.patch.description - resources.organizations.resources.storedInfoTypes.methods.patch.parameters.name.description - resources.projects.resources.content.methods.deidentify.description - resources.projects.resources.content.methods.deidentify.parameters.parent.description - resources.projects.resources.content.methods.inspect.description - resources.projects.resources.content.methods.inspect.parameters.parent.description - resources.projects.resources.content.methods.reidentify.description - resources.projects.resources.content.methods.reidentify.parameters.parent.description - resources.projects.resources.deidentifyTemplates.methods.create.description - resources.projects.resources.deidentifyTemplates.methods.create.parameters.parent.description - resources.projects.resources.deidentifyTemplates.methods.delete.description - resources.projects.resources.deidentifyTemplates.methods.delete.parameters.name.description - resources.projects.resources.deidentifyTemplates.methods.get.description - resources.projects.resources.deidentifyTemplates.methods.get.parameters.name.description - resources.projects.resources.deidentifyTemplates.methods.list.description - resources.projects.resources.deidentifyTemplates.methods.list.parameters.orderBy.description - resources.projects.resources.deidentifyTemplates.methods.list.parameters.pageSize.description - resources.projects.resources.deidentifyTemplates.methods.list.parameters.pageToken.description - resources.projects.resources.deidentifyTemplates.methods.list.parameters.parent.description - resources.projects.resources.deidentifyTemplates.methods.patch.description - resources.projects.resources.deidentifyTemplates.methods.patch.parameters.name.description - resources.projects.resources.dlpJobs.methods.cancel.description - resources.projects.resources.dlpJobs.methods.create.description - resources.projects.resources.dlpJobs.methods.create.parameters.parent.description - resources.projects.resources.dlpJobs.methods.delete.description - resources.projects.resources.dlpJobs.methods.get.description - resources.projects.resources.dlpJobs.methods.list.description - resources.projects.resources.dlpJobs.methods.list.parameters.filter.description - resources.projects.resources.dlpJobs.methods.list.parameters.orderBy.description - resources.projects.resources.dlpJobs.methods.list.parameters.parent.description - resources.projects.resources.image.methods.redact.description - resources.projects.resources.image.methods.redact.parameters.parent.description - resources.projects.resources.inspectTemplates.methods.create.description - resources.projects.resources.inspectTemplates.methods.create.parameters.parent.description - resources.projects.resources.inspectTemplates.methods.delete.description - resources.projects.resources.inspectTemplates.methods.delete.parameters.name.description - resources.projects.resources.inspectTemplates.methods.get.description - resources.projects.resources.inspectTemplates.methods.get.parameters.name.description - resources.projects.resources.inspectTemplates.methods.list.description - resources.projects.resources.inspectTemplates.methods.list.parameters.orderBy.description - resources.projects.resources.inspectTemplates.methods.list.parameters.pageSize.description - resources.projects.resources.inspectTemplates.methods.list.parameters.pageToken.description - resources.projects.resources.inspectTemplates.methods.list.parameters.parent.description - resources.projects.resources.inspectTemplates.methods.patch.description - resources.projects.resources.inspectTemplates.methods.patch.parameters.name.description - resources.projects.resources.jobTriggers.methods.activate.description - resources.projects.resources.jobTriggers.methods.activate.parameters.name.description - resources.projects.resources.jobTriggers.methods.create.description - resources.projects.resources.jobTriggers.methods.create.parameters.parent.description - resources.projects.resources.jobTriggers.methods.delete.description - resources.projects.resources.jobTriggers.methods.delete.parameters.name.description - resources.projects.resources.jobTriggers.methods.get.description - resources.projects.resources.jobTriggers.methods.get.parameters.name.description - resources.projects.resources.jobTriggers.methods.list.description - resources.projects.resources.jobTriggers.methods.list.parameters.filter.description - resources.projects.resources.jobTriggers.methods.list.parameters.orderBy.description - resources.projects.resources.jobTriggers.methods.list.parameters.pageToken.description - resources.projects.resources.jobTriggers.methods.list.parameters.parent.description - resources.projects.resources.jobTriggers.methods.patch.description - resources.projects.resources.jobTriggers.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.content.methods.deidentify.description - resources.projects.resources.locations.resources.content.methods.deidentify.parameters.parent.description - resources.projects.resources.locations.resources.content.methods.inspect.description - resources.projects.resources.locations.resources.content.methods.inspect.parameters.parent.description - resources.projects.resources.locations.resources.content.methods.reidentify.description - resources.projects.resources.locations.resources.content.methods.reidentify.parameters.parent.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.create.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.delete.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.get.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.get.parameters.name.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.list.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.patch.description - resources.projects.resources.locations.resources.deidentifyTemplates.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.dlpJobs.methods.cancel.description - resources.projects.resources.locations.resources.dlpJobs.methods.create.description - resources.projects.resources.locations.resources.dlpJobs.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.dlpJobs.methods.delete.description - resources.projects.resources.locations.resources.dlpJobs.methods.finish.description - resources.projects.resources.locations.resources.dlpJobs.methods.get.description - resources.projects.resources.locations.resources.dlpJobs.methods.hybridInspect.description - resources.projects.resources.locations.resources.dlpJobs.methods.hybridInspect.parameters.name.description - resources.projects.resources.locations.resources.dlpJobs.methods.list.description - resources.projects.resources.locations.resources.dlpJobs.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.dlpJobs.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.dlpJobs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.image.methods.redact.description - resources.projects.resources.locations.resources.image.methods.redact.parameters.parent.description - resources.projects.resources.locations.resources.inspectTemplates.methods.create.description - resources.projects.resources.locations.resources.inspectTemplates.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.inspectTemplates.methods.delete.description - resources.projects.resources.locations.resources.inspectTemplates.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.inspectTemplates.methods.get.description - resources.projects.resources.locations.resources.inspectTemplates.methods.get.parameters.name.description - resources.projects.resources.locations.resources.inspectTemplates.methods.list.description - resources.projects.resources.locations.resources.inspectTemplates.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.inspectTemplates.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.inspectTemplates.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.inspectTemplates.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.inspectTemplates.methods.patch.description - resources.projects.resources.locations.resources.inspectTemplates.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.jobTriggers.methods.activate.description - resources.projects.resources.locations.resources.jobTriggers.methods.activate.parameters.name.description - resources.projects.resources.locations.resources.jobTriggers.methods.create.description - resources.projects.resources.locations.resources.jobTriggers.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.jobTriggers.methods.delete.description - resources.projects.resources.locations.resources.jobTriggers.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.jobTriggers.methods.get.description - resources.projects.resources.locations.resources.jobTriggers.methods.get.parameters.name.description - resources.projects.resources.locations.resources.jobTriggers.methods.hybridInspect.description - resources.projects.resources.locations.resources.jobTriggers.methods.hybridInspect.parameters.name.description - resources.projects.resources.locations.resources.jobTriggers.methods.list.description - resources.projects.resources.locations.resources.jobTriggers.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.jobTriggers.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.jobTriggers.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.jobTriggers.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.jobTriggers.methods.patch.description - resources.projects.resources.locations.resources.jobTriggers.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.create.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.delete.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.get.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.get.parameters.name.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.list.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.patch.description - resources.projects.resources.locations.resources.storedInfoTypes.methods.patch.parameters.name.description - resources.projects.resources.storedInfoTypes.methods.create.description - resources.projects.resources.storedInfoTypes.methods.create.parameters.parent.description - resources.projects.resources.storedInfoTypes.methods.delete.description - resources.projects.resources.storedInfoTypes.methods.delete.parameters.name.description - resources.projects.resources.storedInfoTypes.methods.get.description - resources.projects.resources.storedInfoTypes.methods.get.parameters.name.description - resources.projects.resources.storedInfoTypes.methods.list.description - resources.projects.resources.storedInfoTypes.methods.list.parameters.orderBy.description - resources.projects.resources.storedInfoTypes.methods.list.parameters.pageSize.description - resources.projects.resources.storedInfoTypes.methods.list.parameters.pageToken.description - resources.projects.resources.storedInfoTypes.methods.list.parameters.parent.description - resources.projects.resources.storedInfoTypes.methods.patch.description - resources.projects.resources.storedInfoTypes.methods.patch.parameters.name.description - schemas.GooglePrivacyDlpV2Action.description - schemas.GooglePrivacyDlpV2Action.properties.jobNotificationEmails.description - schemas.GooglePrivacyDlpV2AuxiliaryTable.description - schemas.GooglePrivacyDlpV2AuxiliaryTable.properties.relativeFrequency.description - schemas.GooglePrivacyDlpV2BigQueryKey.properties.rowNumber.description - schemas.GooglePrivacyDlpV2BigQueryOptions.properties.excludedFields.description - schemas.GooglePrivacyDlpV2BigQueryOptions.properties.identifyingFields.description - schemas.GooglePrivacyDlpV2BigQueryOptions.properties.rowsLimit.description - schemas.GooglePrivacyDlpV2BigQueryOptions.properties.rowsLimitPercent.description - schemas.GooglePrivacyDlpV2BigQueryTable.description - schemas.GooglePrivacyDlpV2BigQueryTable.properties.projectId.description - schemas.GooglePrivacyDlpV2Bucket.properties.min.description - schemas.GooglePrivacyDlpV2BucketingConfig.description - schemas.GooglePrivacyDlpV2CategoricalStatsConfig.description - schemas.GooglePrivacyDlpV2CategoricalStatsConfig.properties.field.description - schemas.GooglePrivacyDlpV2CategoricalStatsHistogramBucket.properties.bucketValues.description - schemas.GooglePrivacyDlpV2CharacterMaskConfig.description - schemas.GooglePrivacyDlpV2CharacterMaskConfig.properties.charactersToIgnore.description - schemas.GooglePrivacyDlpV2CharacterMaskConfig.properties.maskingCharacter.description - schemas.GooglePrivacyDlpV2CharacterMaskConfig.properties.numberToMask.description - schemas.GooglePrivacyDlpV2CharacterMaskConfig.properties.reverseOrder.description - schemas.GooglePrivacyDlpV2CharsToIgnore.description - schemas.GooglePrivacyDlpV2CharsToIgnore.properties.commonCharactersToIgnore.description - schemas.GooglePrivacyDlpV2CloudStorageFileSet.properties.url.description - schemas.GooglePrivacyDlpV2CloudStorageOptions.description - schemas.GooglePrivacyDlpV2CloudStorageOptions.properties.bytesLimitPerFile.description - schemas.GooglePrivacyDlpV2CloudStorageOptions.properties.bytesLimitPerFilePercent.description - schemas.GooglePrivacyDlpV2CloudStorageOptions.properties.fileTypes.description - schemas.GooglePrivacyDlpV2CloudStorageOptions.properties.fileTypes.enumDescriptions - schemas.GooglePrivacyDlpV2CloudStorageOptions.properties.filesLimitPercent.description - schemas.GooglePrivacyDlpV2CloudStorageOptions.properties.sampleMethod.enumDescriptions - schemas.GooglePrivacyDlpV2CloudStoragePath.properties.path.description - schemas.GooglePrivacyDlpV2CloudStorageRegexFileSet.description - schemas.GooglePrivacyDlpV2CloudStorageRegexFileSet.properties.excludeRegex.description - schemas.GooglePrivacyDlpV2CloudStorageRegexFileSet.properties.includeRegex.description - schemas.GooglePrivacyDlpV2Condition.description - schemas.GooglePrivacyDlpV2Container.description - schemas.GooglePrivacyDlpV2Container.properties.fullPath.description - schemas.GooglePrivacyDlpV2Container.properties.projectId.description - schemas.GooglePrivacyDlpV2Container.properties.relativePath.description - schemas.GooglePrivacyDlpV2Container.properties.rootPath.description - schemas.GooglePrivacyDlpV2Container.properties.updateTime.description - schemas.GooglePrivacyDlpV2Container.properties.version.description - schemas.GooglePrivacyDlpV2ContentItem.properties.table.description - schemas.GooglePrivacyDlpV2ContentLocation.description - schemas.GooglePrivacyDlpV2ContentLocation.properties.containerName.description - schemas.GooglePrivacyDlpV2ContentLocation.properties.containerTimestamp.description - schemas.GooglePrivacyDlpV2ContentLocation.properties.containerVersion.description - schemas.GooglePrivacyDlpV2CreateDeidentifyTemplateRequest.properties.templateId.description - schemas.GooglePrivacyDlpV2CreateDlpJobRequest.description - schemas.GooglePrivacyDlpV2CreateDlpJobRequest.properties.jobId.description - schemas.GooglePrivacyDlpV2CreateInspectTemplateRequest.properties.templateId.description - schemas.GooglePrivacyDlpV2CreateJobTriggerRequest.properties.triggerId.description - schemas.GooglePrivacyDlpV2CreateStoredInfoTypeRequest.properties.storedInfoTypeId.description - schemas.GooglePrivacyDlpV2CryptoDeterministicConfig.description - schemas.GooglePrivacyDlpV2CryptoDeterministicConfig.properties.context.description - schemas.GooglePrivacyDlpV2CryptoDeterministicConfig.properties.surrogateInfoType.description - schemas.GooglePrivacyDlpV2CryptoHashConfig.description - schemas.GooglePrivacyDlpV2CryptoKey.description - schemas.GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig.description - schemas.GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig.properties.context.description - schemas.GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig.properties.customAlphabet.description - schemas.GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig.properties.surrogateInfoType.description - schemas.GooglePrivacyDlpV2CustomInfoType.description - schemas.GooglePrivacyDlpV2CustomInfoType.properties.detectionRules.description - schemas.GooglePrivacyDlpV2CustomInfoType.properties.exclusionType.description - schemas.GooglePrivacyDlpV2CustomInfoType.properties.exclusionType.enumDescriptions - schemas.GooglePrivacyDlpV2CustomInfoType.properties.infoType.description - schemas.GooglePrivacyDlpV2CustomInfoType.properties.likelihood.description - schemas.GooglePrivacyDlpV2CustomInfoType.properties.storedType.description - schemas.GooglePrivacyDlpV2CustomInfoType.properties.surrogateType.description - schemas.GooglePrivacyDlpV2DatastoreOptions.properties.partitionId.description - schemas.GooglePrivacyDlpV2DateShiftConfig.description - schemas.GooglePrivacyDlpV2DateShiftConfig.properties.context.description - schemas.GooglePrivacyDlpV2DateShiftConfig.properties.cryptoKey.description - schemas.GooglePrivacyDlpV2DateShiftConfig.properties.upperBoundDays.description - schemas.GooglePrivacyDlpV2DateTime.description - schemas.GooglePrivacyDlpV2DateTime.properties.date.description - schemas.GooglePrivacyDlpV2DeidentifyConfig.properties.infoTypeTransformations.description - schemas.GooglePrivacyDlpV2DeidentifyConfig.properties.recordTransformations.description - schemas.GooglePrivacyDlpV2DeidentifyConfig.properties.transformationErrorHandling.description - schemas.GooglePrivacyDlpV2DeidentifyContentRequest.properties.deidentifyConfig.description - schemas.GooglePrivacyDlpV2DeidentifyContentRequest.properties.deidentifyTemplateName.description - schemas.GooglePrivacyDlpV2DeidentifyContentRequest.properties.inspectConfig.description - schemas.GooglePrivacyDlpV2DeidentifyContentRequest.properties.inspectTemplateName.description - schemas.GooglePrivacyDlpV2DeidentifyTemplate.description - schemas.GooglePrivacyDlpV2DeidentifyTemplate.properties.deidentifyConfig.description - schemas.GooglePrivacyDlpV2DeidentifyTemplate.properties.name.description - schemas.GooglePrivacyDlpV2DeltaPresenceEstimationConfig.description - schemas.GooglePrivacyDlpV2DeltaPresenceEstimationConfig.properties.auxiliaryTables.description - schemas.GooglePrivacyDlpV2DeltaPresenceEstimationConfig.properties.quasiIds.description - schemas.GooglePrivacyDlpV2DeltaPresenceEstimationConfig.properties.regionCode.description - schemas.GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket.description - schemas.GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket.properties.bucketValues.description - schemas.GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues.properties.estimatedProbability.description - schemas.GooglePrivacyDlpV2DeltaPresenceEstimationResult.description - schemas.GooglePrivacyDlpV2DeltaPresenceEstimationResult.properties.deltaPresenceEstimationHistogram.description - schemas.GooglePrivacyDlpV2DetectionRule.description - schemas.GooglePrivacyDlpV2Dictionary.description - schemas.GooglePrivacyDlpV2Dictionary.properties.cloudStoragePath.description - schemas.GooglePrivacyDlpV2DlpJob.properties.jobTriggerName.description - schemas.GooglePrivacyDlpV2DlpJob.properties.state.enumDescriptions - schemas.GooglePrivacyDlpV2DocumentLocation.properties.fileOffset.description - schemas.GooglePrivacyDlpV2EntityId.description - schemas.GooglePrivacyDlpV2Error.description - schemas.GooglePrivacyDlpV2ExcludeInfoTypes.properties.infoTypes.description - schemas.GooglePrivacyDlpV2ExclusionRule.description - schemas.GooglePrivacyDlpV2ExclusionRule.properties.matchingType.enumDescriptions - schemas.GooglePrivacyDlpV2Expressions.properties.logicalOperator.description - schemas.GooglePrivacyDlpV2FieldTransformation.properties.condition.description - schemas.GooglePrivacyDlpV2FieldTransformation.properties.infoTypeTransformations.description - schemas.GooglePrivacyDlpV2FileSet.properties.regexFileSet.description - schemas.GooglePrivacyDlpV2FileSet.properties.url.description - schemas.GooglePrivacyDlpV2Finding.properties.infoType.description - schemas.GooglePrivacyDlpV2Finding.properties.labels.description - schemas.GooglePrivacyDlpV2Finding.properties.name.description - schemas.GooglePrivacyDlpV2Finding.properties.quote.description - schemas.GooglePrivacyDlpV2Finding.properties.quoteInfo.description - schemas.GooglePrivacyDlpV2FindingLimits.properties.maxFindingsPerItem.description - schemas.GooglePrivacyDlpV2FindingLimits.properties.maxFindingsPerRequest.description - schemas.GooglePrivacyDlpV2FixedSizeBucketingConfig.description - schemas.GooglePrivacyDlpV2FixedSizeBucketingConfig.properties.bucketSize.description - schemas.GooglePrivacyDlpV2FixedSizeBucketingConfig.properties.lowerBound.description - schemas.GooglePrivacyDlpV2FixedSizeBucketingConfig.properties.upperBound.description - schemas.GooglePrivacyDlpV2HotwordRule.description - schemas.GooglePrivacyDlpV2HotwordRule.properties.proximity.description - schemas.GooglePrivacyDlpV2HybridContentItem.description - schemas.GooglePrivacyDlpV2HybridFindingDetails.properties.fileOffset.description - schemas.GooglePrivacyDlpV2HybridFindingDetails.properties.labels.description - schemas.GooglePrivacyDlpV2HybridFindingDetails.properties.rowOffset.description - schemas.GooglePrivacyDlpV2HybridFindingDetails.properties.tableOptions.description - schemas.GooglePrivacyDlpV2HybridInspectStatistics.properties.abortedCount.description - schemas.GooglePrivacyDlpV2HybridInspectStatistics.properties.pendingCount.description - schemas.GooglePrivacyDlpV2HybridOptions.description - schemas.GooglePrivacyDlpV2HybridOptions.properties.description.description - schemas.GooglePrivacyDlpV2HybridOptions.properties.labels.description - schemas.GooglePrivacyDlpV2HybridOptions.properties.requiredFindingLabelKeys.description - schemas.GooglePrivacyDlpV2HybridOptions.properties.tableOptions.description - schemas.GooglePrivacyDlpV2ImageRedactionConfig.properties.infoType.description - schemas.GooglePrivacyDlpV2ImageRedactionConfig.properties.redactAllText.description - schemas.GooglePrivacyDlpV2ImageRedactionConfig.properties.redactionColor.description - schemas.GooglePrivacyDlpV2InfoType.properties.name.description - schemas.GooglePrivacyDlpV2InfoTypeDescription.properties.description.description - schemas.GooglePrivacyDlpV2InfoTypeLimit.description - schemas.GooglePrivacyDlpV2InfoTypeLimit.properties.infoType.description - schemas.GooglePrivacyDlpV2InfoTypeTransformation.description - schemas.GooglePrivacyDlpV2InfoTypeTransformation.properties.infoTypes.description - schemas.GooglePrivacyDlpV2InfoTypeTransformations.description - schemas.GooglePrivacyDlpV2InfoTypeTransformations.properties.transformations.description - schemas.GooglePrivacyDlpV2InspectConfig.description - schemas.GooglePrivacyDlpV2InspectConfig.properties.contentOptions.description - schemas.GooglePrivacyDlpV2InspectConfig.properties.customInfoTypes.description - schemas.GooglePrivacyDlpV2InspectConfig.properties.includeQuote.description - schemas.GooglePrivacyDlpV2InspectConfig.properties.infoTypes.description - schemas.GooglePrivacyDlpV2InspectConfig.properties.minLikelihood.description - schemas.GooglePrivacyDlpV2InspectConfig.properties.ruleSet.description - schemas.GooglePrivacyDlpV2InspectContentRequest.properties.inspectConfig.description - schemas.GooglePrivacyDlpV2InspectContentRequest.properties.inspectTemplateName.description - schemas.GooglePrivacyDlpV2InspectJobConfig.properties.inspectTemplateName.description - schemas.GooglePrivacyDlpV2InspectResult.properties.findingsTruncated.description - schemas.GooglePrivacyDlpV2InspectTemplate.description - schemas.GooglePrivacyDlpV2InspectTemplate.properties.name.description - schemas.GooglePrivacyDlpV2InspectionRule.description - schemas.GooglePrivacyDlpV2InspectionRuleSet.description - schemas.GooglePrivacyDlpV2JobNotificationEmails.description - schemas.GooglePrivacyDlpV2JobTrigger.description - schemas.GooglePrivacyDlpV2JobTrigger.properties.errors.description - schemas.GooglePrivacyDlpV2JobTrigger.properties.name.description - schemas.GooglePrivacyDlpV2JobTrigger.properties.triggers.description - schemas.GooglePrivacyDlpV2KAnonymityConfig.properties.entityId.description - schemas.GooglePrivacyDlpV2KAnonymityConfig.properties.quasiIds.description - schemas.GooglePrivacyDlpV2KAnonymityEquivalenceClass.properties.equivalenceClassSize.description - schemas.GooglePrivacyDlpV2KAnonymityEquivalenceClass.properties.quasiIdsValues.description - schemas.GooglePrivacyDlpV2KAnonymityHistogramBucket.properties.bucketValues.description - schemas.GooglePrivacyDlpV2KMapEstimationConfig.description - schemas.GooglePrivacyDlpV2KMapEstimationConfig.properties.auxiliaryTables.description - schemas.GooglePrivacyDlpV2KMapEstimationConfig.properties.quasiIds.description - schemas.GooglePrivacyDlpV2KMapEstimationConfig.properties.regionCode.description - schemas.GooglePrivacyDlpV2KMapEstimationHistogramBucket.description - schemas.GooglePrivacyDlpV2KMapEstimationHistogramBucket.properties.bucketValues.description - schemas.GooglePrivacyDlpV2KMapEstimationResult.description - schemas.GooglePrivacyDlpV2KMapEstimationResult.properties.kMapEstimationHistogram.description - schemas.GooglePrivacyDlpV2Key.description - schemas.GooglePrivacyDlpV2Key.properties.partitionId.description - schemas.GooglePrivacyDlpV2Key.properties.path.description - schemas.GooglePrivacyDlpV2KmsWrappedCryptoKey.description - schemas.GooglePrivacyDlpV2LDiversityConfig.properties.quasiIds.description - schemas.GooglePrivacyDlpV2LDiversityEquivalenceClass.properties.quasiIdsValues.description - schemas.GooglePrivacyDlpV2LDiversityHistogramBucket.properties.bucketValues.description - schemas.GooglePrivacyDlpV2LDiversityHistogramBucket.properties.sensitiveValueFrequencyLowerBound.description - schemas.GooglePrivacyDlpV2LDiversityHistogramBucket.properties.sensitiveValueFrequencyUpperBound.description - schemas.GooglePrivacyDlpV2LargeCustomDictionaryConfig.description - schemas.GooglePrivacyDlpV2LargeCustomDictionaryConfig.properties.outputPath.description - schemas.GooglePrivacyDlpV2LeaveUntransformed.description - schemas.GooglePrivacyDlpV2LikelihoodAdjustment.description - schemas.GooglePrivacyDlpV2LikelihoodAdjustment.properties.relativeLikelihood.description - schemas.GooglePrivacyDlpV2ListDeidentifyTemplatesResponse.properties.deidentifyTemplates.description - schemas.GooglePrivacyDlpV2ListDeidentifyTemplatesResponse.properties.nextPageToken.description - schemas.GooglePrivacyDlpV2ListInspectTemplatesResponse.properties.nextPageToken.description - schemas.GooglePrivacyDlpV2ListJobTriggersResponse.properties.nextPageToken.description - schemas.GooglePrivacyDlpV2ListStoredInfoTypesResponse.properties.nextPageToken.description - schemas.GooglePrivacyDlpV2Location.properties.byteRange.description - schemas.GooglePrivacyDlpV2Location.properties.codepointRange.description - schemas.GooglePrivacyDlpV2Location.properties.contentLocations.description - schemas.GooglePrivacyDlpV2Manual.description - schemas.GooglePrivacyDlpV2NumericalStatsConfig.description - schemas.GooglePrivacyDlpV2NumericalStatsConfig.properties.field.description - schemas.GooglePrivacyDlpV2NumericalStatsResult.properties.quantileValues.description - schemas.GooglePrivacyDlpV2OutputStorageConfig.properties.outputSchema.description - schemas.GooglePrivacyDlpV2OutputStorageConfig.properties.outputSchema.enumDescriptions - schemas.GooglePrivacyDlpV2OutputStorageConfig.properties.table.description - schemas.GooglePrivacyDlpV2PartitionId.description - schemas.GooglePrivacyDlpV2PathElement.description - schemas.GooglePrivacyDlpV2PathElement.properties.id.description - schemas.GooglePrivacyDlpV2PathElement.properties.kind.description - schemas.GooglePrivacyDlpV2PathElement.properties.name.description - schemas.GooglePrivacyDlpV2Proximity.description - schemas.GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog.description - schemas.GooglePrivacyDlpV2PublishSummaryToCscc.description - schemas.GooglePrivacyDlpV2PublishToPubSub.description - schemas.GooglePrivacyDlpV2PublishToPubSub.properties.topic.description - schemas.GooglePrivacyDlpV2PublishToStackdriver.description - schemas.GooglePrivacyDlpV2QuasiId.properties.customTag.description - schemas.GooglePrivacyDlpV2QuasiId.properties.inferred.description - schemas.GooglePrivacyDlpV2QuasiId.properties.infoType.description - schemas.GooglePrivacyDlpV2QuasiIdField.description - schemas.GooglePrivacyDlpV2QuasiIdentifierField.description - schemas.GooglePrivacyDlpV2QuasiIdentifierField.properties.customTag.description - schemas.GooglePrivacyDlpV2RecordCondition.description - schemas.GooglePrivacyDlpV2RecordKey.properties.idValues.description - schemas.GooglePrivacyDlpV2RecordSuppression.description - schemas.GooglePrivacyDlpV2RecordSuppression.properties.condition.description - schemas.GooglePrivacyDlpV2RecordTransformations.description - schemas.GooglePrivacyDlpV2RecordTransformations.properties.recordSuppressions.description - schemas.GooglePrivacyDlpV2RedactConfig.description - schemas.GooglePrivacyDlpV2RedactImageRequest.description - schemas.GooglePrivacyDlpV2RedactImageRequest.properties.includeFindings.description - schemas.GooglePrivacyDlpV2RedactImageResponse.properties.extractedText.description - schemas.GooglePrivacyDlpV2Regex.properties.groupIndexes.description - schemas.GooglePrivacyDlpV2Regex.properties.pattern.description - schemas.GooglePrivacyDlpV2ReidentifyContentRequest.properties.inspectTemplateName.description - schemas.GooglePrivacyDlpV2ReidentifyContentRequest.properties.reidentifyConfig.description - schemas.GooglePrivacyDlpV2ReidentifyContentRequest.properties.reidentifyTemplateName.description - schemas.GooglePrivacyDlpV2RequestedOptions.properties.snapshotInspectTemplate.description - schemas.GooglePrivacyDlpV2Result.properties.hybridStats.description - schemas.GooglePrivacyDlpV2Result.properties.infoTypeStats.description - schemas.GooglePrivacyDlpV2RiskAnalysisJobConfig.description - schemas.GooglePrivacyDlpV2RiskAnalysisJobConfig.properties.actions.description - schemas.GooglePrivacyDlpV2SaveFindings.description - schemas.GooglePrivacyDlpV2Schedule.properties.recurrencePeriodDuration.description - schemas.GooglePrivacyDlpV2StatisticalTable.description - schemas.GooglePrivacyDlpV2StatisticalTable.properties.relativeFrequency.description - schemas.GooglePrivacyDlpV2StorageConfig.properties.hybridOptions.description - schemas.GooglePrivacyDlpV2StoredInfoType.description - schemas.GooglePrivacyDlpV2StoredInfoType.properties.pendingVersions.description - schemas.GooglePrivacyDlpV2StoredInfoTypeConfig.description - schemas.GooglePrivacyDlpV2StoredInfoTypeVersion.description - schemas.GooglePrivacyDlpV2StoredInfoTypeVersion.properties.createTime.description - schemas.GooglePrivacyDlpV2StoredInfoTypeVersion.properties.errors.description - schemas.GooglePrivacyDlpV2StoredInfoTypeVersion.properties.state.description - schemas.GooglePrivacyDlpV2StoredInfoTypeVersion.properties.state.enumDescriptions - schemas.GooglePrivacyDlpV2StoredType.properties.createTime.description - schemas.GooglePrivacyDlpV2StoredType.properties.name.description - schemas.GooglePrivacyDlpV2SummaryResult.description - schemas.GooglePrivacyDlpV2SummaryResult.properties.details.description - schemas.GooglePrivacyDlpV2SurrogateType.description - schemas.GooglePrivacyDlpV2Table.description - schemas.GooglePrivacyDlpV2TableLocation.properties.rowIndex.description - schemas.GooglePrivacyDlpV2TableOptions.properties.identifyingFields.description - schemas.GooglePrivacyDlpV2TaggedField.properties.customTag.description - schemas.GooglePrivacyDlpV2TaggedField.properties.inferred.description - schemas.GooglePrivacyDlpV2TaggedField.properties.infoType.description - schemas.GooglePrivacyDlpV2TimePartConfig.description - schemas.GooglePrivacyDlpV2TimeZone.properties.offsetMinutes.description - schemas.GooglePrivacyDlpV2TimespanConfig.description - schemas.GooglePrivacyDlpV2TimespanConfig.properties.enableAutoPopulationOfTimespanConfig.description - schemas.GooglePrivacyDlpV2TimespanConfig.properties.endTime.description - schemas.GooglePrivacyDlpV2TimespanConfig.properties.timestampField.description - schemas.GooglePrivacyDlpV2TransformationErrorHandling.description - schemas.GooglePrivacyDlpV2TransformationSummary.description - schemas.GooglePrivacyDlpV2TransformationSummary.properties.fieldTransformations.description - schemas.GooglePrivacyDlpV2TransientCryptoKey.description - schemas.GooglePrivacyDlpV2TransientCryptoKey.properties.name.description - schemas.GooglePrivacyDlpV2Trigger.properties.manual.description - schemas.GooglePrivacyDlpV2UnwrappedCryptoKey.description - schemas.GooglePrivacyDlpV2UpdateStoredInfoTypeRequest.properties.config.description - schemas.GooglePrivacyDlpV2Value.description - schemas.GooglePrivacyDlpV2WordList.properties.words.description - schemas.GoogleProtobufEmpty.description - schemas.GoogleRpcStatus.description - schemas.GoogleRpcStatus.properties.details.description - schemas.GoogleRpcStatus.properties.message.description - schemas.GoogleTypeDate.description - schemas.GoogleTypeDate.properties.day.description - schemas.GoogleTypeDate.properties.month.description - schemas.GoogleTypeDate.properties.year.description - schemas.GoogleTypeTimeOfDay.description - schemas.GoogleTypeTimeOfDay.properties.hours.description - schemas.GoogleTypeTimeOfDay.properties.seconds.description * feat(gmail)!: update the API BREAKING CHANGE: This release has breaking changes. #### gmail:v1 The following keys were deleted: - 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(manufacturers): update the API #### manufacturers:v1 The following keys were added: - resources.accounts.resources.products.methods.get.parameters.include.enumDescriptions - resources.accounts.resources.products.methods.list.parameters.include.enumDescriptions The following keys were changed: - resources.accounts.resources.products.methods.delete.parameters.name.description - resources.accounts.resources.products.methods.delete.parameters.parent.description - resources.accounts.resources.products.methods.get.description - resources.accounts.resources.products.methods.get.parameters.include.description - resources.accounts.resources.products.methods.get.parameters.name.description - resources.accounts.resources.products.methods.get.parameters.parent.description - resources.accounts.resources.products.methods.list.parameters.include.description - resources.accounts.resources.products.methods.list.parameters.pageSize.description - resources.accounts.resources.products.methods.list.parameters.parent.description - resources.accounts.resources.products.methods.update.description - resources.accounts.resources.products.methods.update.parameters.name.description - resources.accounts.resources.products.methods.update.parameters.parent.description - schemas.Attributes.description - schemas.Attributes.properties.additionalImageLink.description - schemas.Attributes.properties.ageGroup.description - schemas.Attributes.properties.brand.description - schemas.Attributes.properties.capacity.description - schemas.Attributes.properties.color.description - schemas.Attributes.properties.count.description - schemas.Attributes.properties.description.description - schemas.Attributes.properties.disclosureDate.description - schemas.Attributes.properties.featureDescription.description - schemas.Attributes.properties.flavor.description - schemas.Attributes.properties.format.description - schemas.Attributes.properties.gender.description - schemas.Attributes.properties.gtin.description - schemas.Attributes.properties.imageLink.description - schemas.Attributes.properties.itemGroupId.description - schemas.Attributes.properties.material.description - schemas.Attributes.properties.mpn.description - schemas.Attributes.properties.pattern.description - schemas.Attributes.properties.productDetail.description - schemas.Attributes.properties.productLine.description - schemas.Attributes.properties.productName.description - schemas.Attributes.properties.productPageUrl.description - schemas.Attributes.properties.productType.description - schemas.Attributes.properties.releaseDate.description - schemas.Attributes.properties.richProductContent.description - schemas.Attributes.properties.scent.description - schemas.Attributes.properties.size.description - schemas.Attributes.properties.sizeSystem.description - schemas.Attributes.properties.sizeType.description - schemas.Attributes.properties.suggestedRetailPrice.description - schemas.Attributes.properties.targetClientId.description - schemas.Attributes.properties.theme.description - schemas.Attributes.properties.title.description - schemas.Attributes.properties.videoLink.description - schemas.Capacity.description - schemas.Count.description - schemas.Empty.description - schemas.FeatureDescription.description - schemas.Image.properties.imageUrl.description - schemas.Image.properties.status.description - schemas.Image.properties.type.description - schemas.Issue.properties.attribute.description - schemas.Issue.properties.resolution.enumDescriptions - schemas.Issue.properties.severity.enumDescriptions - schemas.Issue.properties.type.description - schemas.Product.properties.attributes.description - schemas.Product.properties.contentLanguage.description - schemas.Product.properties.name.description - schemas.Product.properties.parent.description - schemas.Product.properties.productId.description - schemas.Product.properties.targetCountry.description - schemas.ProductDetail.description * feat(oslogin): update the API #### oslogin:v1alpha The following keys were added: - resources.users.methods.getLoginProfile.parameters.operatingSystemType.enumDescriptions - resources.users.resources.projects.methods.delete.parameters.operatingSystemType.enumDescriptions - schemas.PosixAccount.properties.accountId.readOnly - schemas.PosixAccount.properties.name.readOnly - schemas.SshPublicKey.properties.fingerprint.readOnly - schemas.SshPublicKey.properties.name.readOnly The following keys were changed: - resources.users.methods.getLoginProfile.description - resources.users.methods.importSshPublicKey.description - resources.users.resources.projects.methods.delete.parameters.name.description - resources.users.resources.sshPublicKeys.methods.delete.parameters.name.description - resources.users.resources.sshPublicKeys.methods.get.parameters.name.description - resources.users.resources.sshPublicKeys.methods.patch.description - resources.users.resources.sshPublicKeys.methods.patch.parameters.name.description - schemas.Empty.description - schemas.LoginProfile.description - schemas.PosixAccount.properties.operatingSystemType.enumDescriptions - schemas.PosixAccount.properties.systemId.description - schemas.SshPublicKey.properties.key.description * feat(people): update the API #### people:v1 The following keys were added: - schemas.ClientData.description - schemas.ClientData.id - schemas.ClientData.properties.key.description - schemas.ClientData.properties.key.type - schemas.ClientData.properties.metadata.$ref - schemas.ClientData.properties.metadata.description - schemas.ClientData.properties.value.description - schemas.ClientData.properties.value.type - schemas.ClientData.type - schemas.Person.properties.clientData.description - schemas.Person.properties.clientData.items.$ref - schemas.Person.properties.clientData.type The following keys were changed: - resources.people.methods.createContact.parameters.personFields.description - resources.people.methods.deleteContactPhoto.parameters.personFields.description - resources.people.methods.get.parameters.personFields.description - resources.people.methods.getBatchGet.parameters.personFields.description - resources.people.methods.listDirectoryPeople.parameters.readMask.description - resources.people.methods.searchDirectoryPeople.parameters.readMask.description - resources.people.methods.updateContact.parameters.personFields.description - resources.people.methods.updateContact.parameters.updatePersonFields.description - resources.people.resources.connections.methods.list.parameters.personFields.description - schemas.CopyOtherContactToMyContactsGroupRequest.properties.readMask.description - schemas.UpdateContactPhotoRequest.properties.personFields.description * feat(playablelocations): update the API #### playablelocations:v3 The following keys were added: - schemas.GoogleMapsPlayablelocationsV3PlayerReport.properties.reasons.items.enumDescriptions The following keys were changed: - resources.v3.methods.logImpressions.description - resources.v3.methods.logPlayerReports.description - resources.v3.methods.samplePlayableLocations.description - schemas.GoogleMapsPlayablelocationsV3Impression.properties.gameObjectType.description - schemas.GoogleMapsPlayablelocationsV3LogImpressionsRequest.properties.clientInfo.description - schemas.GoogleMapsPlayablelocationsV3LogImpressionsRequest.properties.impressions.description - schemas.GoogleMapsPlayablelocationsV3LogImpressionsRequest.properties.requestId.description - schemas.GoogleMapsPlayablelocationsV3LogImpressionsResponse.description - schemas.GoogleMapsPlayablelocationsV3LogPlayerReportsRequest.properties.clientInfo.description - schemas.GoogleMapsPlayablelocationsV3LogPlayerReportsRequest.properties.playerReports.description - schemas.GoogleMapsPlayablelocationsV3LogPlayerReportsRequest.properties.requestId.description - schemas.GoogleMapsPlayablelocationsV3LogPlayerReportsResponse.description - schemas.GoogleMapsPlayablelocationsV3PlayerReport.description - schemas.GoogleMapsPlayablelocationsV3PlayerReport.properties.languageCode.description - schemas.GoogleMapsPlayablelocationsV3PlayerReport.properties.reasonDetails.description - schemas.GoogleMapsPlayablelocationsV3PlayerReport.properties.reasons.enumDescriptions - schemas.GoogleMapsPlayablelocationsV3SampleAreaFilter.properties.s2CellId.description - schemas.GoogleMapsPlayablelocationsV3SampleCriterion.description - schemas.GoogleMapsPlayablelocationsV3SampleCriterion.properties.fieldsToReturn.description - schemas.GoogleMapsPlayablelocationsV3SampleCriterion.properties.filter.description - schemas.GoogleMapsPlayablelocationsV3SampleCriterion.properties.gameObjectType.description - schemas.GoogleMapsPlayablelocationsV3SampleFilter.properties.includedTypes.description - schemas.GoogleMapsPlayablelocationsV3SampleFilter.properties.maxLocationCount.description - schemas.GoogleMapsPlayablelocationsV3SampleFilter.properties.spacing.description - schemas.GoogleMapsPlayablelocationsV3SamplePlayableLocation.description - schemas.GoogleMapsPlayablelocationsV3SamplePlayableLocation.properties.centerPoint.description - schemas.GoogleMapsPlayablelocationsV3SamplePlayableLocation.properties.snappedPoint.description - schemas.GoogleMapsPlayablelocationsV3SamplePlayableLocation.properties.types.description - schemas.GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest.description - schemas.GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest.properties.criteria.description - schemas.GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse.description - schemas.GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse.properties.locationsPerGameObjectType.description - schemas.GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse.properties.ttl.description - schemas.GoogleMapsPlayablelocationsV3SampleSpacingOptions.properties.minSpacingMeters.description - schemas.GoogleMapsPlayablelocationsV3SampleSpacingOptions.properties.pointType.description - schemas.GoogleMapsPlayablelocationsV3SampleSpacingOptions.properties.pointType.enumDescriptions - schemas.GoogleMapsUnityClientInfo.properties.apiClient.description - schemas.GoogleMapsUnityClientInfo.properties.applicationId.description - schemas.GoogleMapsUnityClientInfo.properties.applicationVersion.description - schemas.GoogleMapsUnityClientInfo.properties.deviceModel.description - schemas.GoogleMapsUnityClientInfo.properties.languageCode.description - schemas.GoogleMapsUnityClientInfo.properties.operatingSystem.description - schemas.GoogleMapsUnityClientInfo.properties.operatingSystemBuild.description - schemas.GoogleTypeLatLng.description * feat(vectortile): update the API #### vectortile:v1 The following keys were added: - resources.featuretiles.methods.get.parameters.clientInfo.platform.enumDescriptions - resources.terraintiles.methods.get.parameters.clientInfo.platform.enumDescriptions - resources.terraintiles.methods.get.parameters.terrainFormats.enumDescriptions The following keys were changed: - description - resources.featuretiles.methods.get.parameters.clientInfo.apiClient.description - resources.featuretiles.methods.get.parameters.clientInfo.applicationId.description - resources.featuretiles.methods.get.parameters.clientInfo.applicationVersion.description - resources.featuretiles.methods.get.parameters.clientInfo.deviceModel.description - resources.featuretiles.methods.get.parameters.clientInfo.operatingSystem.description - resources.featuretiles.methods.get.parameters.clientInfo.userId.description - resources.featuretiles.methods.get.parameters.clientTileVersionId.description - resources.featuretiles.methods.get.parameters.enableDetailedHighwayTypes.description - resources.featuretiles.methods.get.parameters.enableFeatureNames.description - resources.featuretiles.methods.get.parameters.enableModeledVolumes.description - resources.featuretiles.methods.get.parameters.enablePrivateRoads.description - resources.featuretiles.methods.get.parameters.enableUnclippedBuildings.description - resources.featuretiles.methods.get.parameters.languageCode.description - resources.featuretiles.methods.get.parameters.name.description - resources.featuretiles.methods.get.parameters.regionCode.description - resources.terraintiles.methods.get.parameters.altitudePrecisionCentimeters.description - resources.terraintiles.methods.get.parameters.clientInfo.apiClient.description - resources.terraintiles.methods.get.parameters.clientInfo.applicationId.description - resources.terraintiles.methods.get.parameters.clientInfo.applicationVersion.description - resources.terraintiles.methods.get.parameters.clientInfo.deviceModel.description - resources.terraintiles.methods.get.parameters.clientInfo.operatingSystem.description - resources.terraintiles.methods.get.parameters.clientInfo.userId.description - resources.terraintiles.methods.get.parameters.maxElevationResolutionCells.description - resources.terraintiles.methods.get.parameters.minElevationResolutionCells.description - resources.terraintiles.methods.get.parameters.name.description - schemas.Area.properties.hasExternalEdges.description - schemas.Area.properties.internalEdges.description - schemas.Area.properties.loopBreaks.description - schemas.Area.properties.triangleIndices.description - schemas.Area.properties.type.enumDescriptions - schemas.Area.properties.zOrder.description - schemas.ExtrudedArea.description - schemas.ExtrudedArea.properties.minZ.description - schemas.Feature.properties.geometry.description - schemas.Feature.properties.placeId.description - schemas.Feature.properties.type.enumDescriptions - schemas.FeatureTile.description - schemas.FeatureTile.properties.name.description - schemas.FeatureTile.properties.status.enumDescriptions - schemas.FeatureTile.properties.versionId.description - schemas.FirstDerivativeElevationGrid.description - schemas.FirstDerivativeElevationGrid.properties.altitudeMultiplier.description - schemas.FirstDerivativeElevationGrid.properties.rows.description - schemas.Geometry.description - schemas.Line.description - schemas.Line.properties.zOrder.description - schemas.ProviderInfo.description - schemas.Relation.description - schemas.Relation.properties.relatedFeatureIndex.description - schemas.RoadInfo.properties.isPrivate.description - schemas.Row.description - schemas.Row.properties.altitudeDiffs.description - schemas.SecondDerivativeElevationGrid.description - schemas.SecondDerivativeElevationGrid.properties.altitudeMultiplier.description - schemas.SecondDerivativeElevationGrid.properties.columnCount.description - schemas.SecondDerivativeElevationGrid.properties.encodedData.description - schemas.SecondDerivativeElevationGrid.properties.rowCount.description - schemas.TerrainTile.description - schemas.TerrainTile.properties.name.description - schemas.TerrainTile.properties.secondDerivative.description - schemas.TileCoordinates.description - schemas.TriangleStrip.description - schemas.TriangleStrip.properties.vertexIndices.description - schemas.Vertex2DList.description - schemas.Vertex3DList.description * feat(vision): update the API #### vision:v1p1beta1 The following keys were changed: - resources.files.methods.annotate.description - resources.files.methods.asyncBatchAnnotate.description - resources.images.methods.asyncBatchAnnotate.description - resources.projects.resources.files.methods.annotate.description - resources.projects.resources.files.methods.annotate.parameters.parent.description - resources.projects.resources.files.methods.asyncBatchAnnotate.description - resources.projects.resources.files.methods.asyncBatchAnnotate.parameters.parent.description - resources.projects.resources.images.methods.annotate.parameters.parent.description - resources.projects.resources.images.methods.asyncBatchAnnotate.description - resources.projects.resources.images.methods.asyncBatchAnnotate.parameters.parent.description - resources.projects.resources.locations.resources.files.methods.annotate.description - resources.projects.resources.locations.resources.files.methods.annotate.parameters.parent.description - resources.projects.resources.locations.resources.files.methods.asyncBatchAnnotate.description - resources.projects.resources.locations.resources.files.methods.asyncBatchAnnotate.parameters.parent.description - resources.projects.resources.locations.resources.images.methods.annotate.parameters.parent.description - resources.projects.resources.locations.resources.images.methods.asyncBatchAnnotate.description - resources.projects.resources.locations.resources.images.methods.asyncBatchAnnotate.parameters.parent.description - schemas.AnnotateFileResponse.description - schemas.AnnotateFileResponse.properties.error.description - schemas.AnnotateFileResponse.properties.responses.description - schemas.AnnotateImageResponse.properties.context.description - schemas.AnnotateImageResponse.properties.error.description - schemas.AnnotateImageResponse.properties.fullTextAnnotation.description - schemas.AnnotateImageResponse.properties.localizedObjectAnnotations.description - schemas.AsyncBatchAnnotateFilesResponse.properties.responses.description - schemas.BatchAnnotateFilesResponse.properties.responses.description - schemas.BatchOperationMetadata.description - schemas.BatchOperationMetadata.properties.endTime.description - schemas.BatchOperationMetadata.properties.state.enumDescriptions - schemas.Block.properties.boundingBox.description - schemas.Color.description - schemas.Color.properties.alpha.description - schemas.ColorInfo.description - schemas.ColorInfo.properties.pixelFraction.description - schemas.CropHint.properties.boundingPoly.description - schemas.CropHint.properties.confidence.description - schemas.CropHint.properties.importanceFraction.description - schemas.DetectedBreak.properties.type.enumDescriptions - schemas.DetectedLanguage.properties.languageCode.description - schemas.EntityAnnotation.properties.boundingPoly.description - schemas.EntityAnnotation.properties.confidence.description - schemas.EntityAnnotation.properties.locale.description - schemas.EntityAnnotation.properties.locations.description - schemas.EntityAnnotation.properties.mid.description - schemas.EntityAnnotation.properties.properties.description - schemas.EntityAnnotation.properties.topicality.description - schemas.FaceAnnotation.properties.boundingPoly.description - schemas.FaceAnnotation.properties.fdBoundingPoly.description - schemas.FaceAnnotation.properties.panAngle.description - schemas.FaceAnnotation.properties.rollAngle.description - schemas.FaceAnnotation.properties.tiltAngle.description - schemas.GcsDestination.properties.uri.description - schemas.GcsSource.properties.uri.description - schemas.GoogleCloudVisionV1p1beta1AnnotateFileRequest.properties.pages.description - schemas.GoogleCloudVisionV1p1beta1AnnotateFileResponse.description - schemas.GoogleCloudVisionV1p1beta1AnnotateFileResponse.properties.error.description - schemas.GoogleCloudVisionV1p1beta1AnnotateFileResponse.properties.responses.description - schemas.GoogleCloudVisionV1p1beta1AnnotateImageRequest.description - schemas.GoogleCloudVisionV1p1beta1AnnotateImageResponse.properties.context.description - schemas.GoogleCloudVisionV1p1beta1AnnotateImageResponse.properties.error.description - schemas.GoogleCloudVisionV1p1beta1AnnotateImageResponse.properties.fullTextAnnotation.description - schemas.GoogleCloudVisionV1p1beta1AnnotateImageResponse.properties.localizedObjectAnnotations.description - schemas.GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest.description - schemas.GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest.properties.parent.description - schemas.GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse.properties.responses.description - schemas.GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest.properties.parent.description - schemas.GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest.properties.parent.description - schemas.GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest.properties.requests.description - schemas.GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse.properties.responses.description - schemas.GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest.properties.parent.description - schemas.GoogleCloudVisionV1p1beta1Block.properties.boundingBox.description - schemas.GoogleCloudVisionV1p1beta1ColorInfo.description - schemas.GoogleCloudVisionV1p1beta1ColorInfo.properties.pixelFraction.description - schemas.GoogleCloudVisionV1p1beta1CropHint.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p1beta1CropHint.properties.confidence.description - schemas.GoogleCloudVisionV1p1beta1CropHint.properties.importanceFraction.description - schemas.GoogleCloudVisionV1p1beta1CropHintsParams.properties.aspectRatios.description - schemas.GoogleCloudVisionV1p1beta1EntityAnnotation.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p1beta1EntityAnnotation.properties.confidence.description - schemas.GoogleCloudVisionV1p1beta1EntityAnnotation.properties.locale.description - schemas.GoogleCloudVisionV1p1beta1EntityAnnotation.properties.locations.description - schemas.GoogleCloudVisionV1p1beta1EntityAnnotation.properties.mid.description - schemas.GoogleCloudVisionV1p1beta1EntityAnnotation.properties.properties.description - schemas.GoogleCloudVisionV1p1beta1EntityAnnotation.properties.topicality.description - schemas.GoogleCloudVisionV1p1beta1FaceAnnotation.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p1beta1FaceAnnotation.properties.fdBoundingPoly.description - schemas.GoogleCloudVisionV1p1beta1FaceAnnotation.properties.panAngle.description - schemas.GoogleCloudVisionV1p1beta1FaceAnnotation.properties.rollAngle.description - schemas.GoogleCloudVisionV1p1beta1FaceAnnotation.properties.tiltAngle.description - schemas.GoogleCloudVisionV1p1beta1Feature.description - schemas.GoogleCloudVisionV1p1beta1Feature.properties.maxResults.description - schemas.GoogleCloudVisionV1p1beta1Feature.properties.model.description - schemas.GoogleCloudVisionV1p1beta1Feature.properties.type.enumDescriptions - schemas.GoogleCloudVisionV1p1beta1GcsDestination.properties.uri.description - schemas.GoogleCloudVisionV1p1beta1GcsSource.properties.uri.description - schemas.GoogleCloudVisionV1p1beta1Image.properties.content.description - schemas.GoogleCloudVisionV1p1beta1Image.properties.source.description - schemas.GoogleCloudVisionV1p1beta1ImageAnnotationContext.description - schemas.GoogleCloudVisionV1p1beta1ImageAnnotationContext.properties.pageNumber.description - schemas.GoogleCloudVisionV1p1beta1ImageContext.properties.languageHints.description - schemas.GoogleCloudVisionV1p1beta1ImageSource.properties.gcsImageUri.description - schemas.GoogleCloudVisionV1p1beta1ImageSource.properties.imageUri.description - schemas.GoogleCloudVisionV1p1beta1InputConfig.properties.content.description - schemas.GoogleCloudVisionV1p1beta1InputConfig.properties.mimeType.description - schemas.GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation.properties.languageCode.description - schemas.GoogleCloudVisionV1p1beta1NormalizedVertex.description - schemas.GoogleCloudVisionV1p1beta1OutputConfig.properties.batchSize.description - schemas.GoogleCloudVisionV1p1beta1Page.properties.height.description - schemas.GoogleCloudVisionV1p1beta1Page.properties.width.description - schemas.GoogleCloudVisionV1p1beta1Paragraph.properties.boundingBox.description - schemas.GoogleCloudVisionV1p1beta1Position.description - schemas.GoogleCloudVisionV1p1beta1Product.properties.description.description - schemas.GoogleCloudVisionV1p1beta1Product.properties.displayName.description - schemas.GoogleCloudVisionV1p1beta1Product.properties.name.description - schemas.GoogleCloudVisionV1p1beta1Product.properties.productCategory.description - schemas.GoogleCloudVisionV1p1beta1Product.properties.productLabels.description - schemas.GoogleCloudVisionV1p1beta1ProductKeyValue.properties.key.description - schemas.GoogleCloudVisionV1p1beta1ProductKeyValue.properties.value.description - schemas.GoogleCloudVisionV1p1beta1ProductSearchParams.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p1beta1ProductSearchParams.properties.filter.description - schemas.GoogleCloudVisionV1p1beta1ProductSearchParams.properties.productCategories.description - schemas.GoogleCloudVisionV1p1beta1ProductSearchParams.properties.productSet.description - schemas.GoogleCloudVisionV1p1beta1ProductSearchResults.properties.indexTime.description - schemas.GoogleCloudVisionV1p1beta1ProductSearchResults.properties.productGroupedResults.description - schemas.GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult.description - schemas.GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation.properties.languageCode.description - schemas.GoogleCloudVisionV1p1beta1ProductSearchResultsResult.properties.image.description - schemas.GoogleCloudVisionV1p1beta1ProductSearchResultsResult.properties.score.description - schemas.GoogleCloudVisionV1p1beta1SafeSearchAnnotation.description - schemas.GoogleCloudVisionV1p1beta1SafeSearchAnnotation.properties.adult.description - schemas.GoogleCloudVisionV1p1beta1SafeSearchAnnotation.properties.racy.description - schemas.GoogleCloudVisionV1p1beta1SafeSearchAnnotation.properties.spoof.description - schemas.GoogleCloudVisionV1p1beta1Symbol.properties.boundingBox.description - schemas.GoogleCloudVisionV1p1beta1TextAnnotation.description - schemas.GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak.properties.type.enumDescriptions - schemas.GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage.properties.languageCode.description - schemas.GoogleCloudVisionV1p1beta1Vertex.description - schemas.GoogleCloudVisionV1p1beta1WebDetection.properties.bestGuessLabels.description - schemas.GoogleCloudVisionV1p1beta1WebDetection.properties.fullMatchingImages.description - schemas.GoogleCloudVisionV1p1beta1WebDetection.properties.partialMatchingImages.description - schemas.GoogleCloudVisionV1p1beta1WebDetectionWebEntity.properties.score.description - schemas.GoogleCloudVisionV1p1beta1WebDetectionWebLabel.properties.languageCode.description - schemas.GoogleCloudVisionV1p1beta1WebDetectionWebPage.properties.fullMatchingImages.description - schemas.GoogleCloudVisionV1p1beta1WebDetectionWebPage.properties.partialMatchingImages.description - schemas.GoogleCloudVisionV1p1beta1Word.properties.boundingBox.description - schemas.GoogleCloudVisionV1p1beta1Word.properties.symbols.description - schemas.GoogleCloudVisionV1p2beta1AnnotateFileResponse.description - schemas.GoogleCloudVisionV1p2beta1AnnotateFileResponse.properties.error.description - schemas.GoogleCloudVisionV1p2beta1AnnotateFileResponse.properties.responses.description - schemas.GoogleCloudVisionV1p2beta1AnnotateImageResponse.properties.context.description - schemas.GoogleCloudVisionV1p2beta1AnnotateImageResponse.properties.error.description - schemas.GoogleCloudVisionV1p2beta1AnnotateImageResponse.properties.fullTextAnnotation.description - schemas.GoogleCloudVisionV1p2beta1AnnotateImageResponse.properties.localizedObjectAnnotations.description - schemas.GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse.properties.responses.description - schemas.GoogleCloudVisionV1p2beta1Block.properties.boundingBox.description - schemas.GoogleCloudVisionV1p2beta1ColorInfo.description - schemas.GoogleCloudVisionV1p2beta1ColorInfo.properties.pixelFraction.description - schemas.GoogleCloudVisionV1p2beta1CropHint.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p2beta1CropHint.properties.confidence.description - schemas.GoogleCloudVisionV1p2beta1CropHint.properties.importanceFraction.description - schemas.GoogleCloudVisionV1p2beta1EntityAnnotation.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p2beta1EntityAnnotation.properties.confidence.description - schemas.GoogleCloudVisionV1p2beta1EntityAnnotation.properties.locale.description - schemas.GoogleCloudVisionV1p2beta1EntityAnnotation.properties.locations.description - schemas.GoogleCloudVisionV1p2beta1EntityAnnotation.properties.mid.description - schemas.GoogleCloudVisionV1p2beta1EntityAnnotation.properties.properties.description - schemas.GoogleCloudVisionV1p2beta1EntityAnnotation.properties.topicality.description - schemas.GoogleCloudVisionV1p2beta1FaceAnnotation.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p2beta1FaceAnnotation.properties.fdBoundingPoly.description - schemas.GoogleCloudVisionV1p2beta1FaceAnnotation.properties.panAngle.description - schemas.GoogleCloudVisionV1p2beta1FaceAnnotation.properties.rollAngle.description - schemas.GoogleCloudVisionV1p2beta1FaceAnnotation.properties.tiltAngle.description - schemas.GoogleCloudVisionV1p2beta1GcsDestination.properties.uri.description - schemas.GoogleCloudVisionV1p2beta1GcsSource.properties.uri.description - schemas.GoogleCloudVisionV1p2beta1ImageAnnotationContext.description - schemas.GoogleCloudVisionV1p2beta1ImageAnnotationContext.properties.pageNumber.description - schemas.GoogleCloudVisionV1p2beta1InputConfig.properties.content.description - schemas.GoogleCloudVisionV1p2beta1InputConfig.properties.mimeType.description - schemas.GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation.properties.languageCode.description - schemas.GoogleCloudVisionV1p2beta1NormalizedVertex.description - schemas.GoogleCloudVisionV1p2beta1OutputConfig.properties.batchSize.description - schemas.GoogleCloudVisionV1p2beta1Page.properties.height.description - schemas.GoogleCloudVisionV1p2beta1Page.properties.width.description - schemas.GoogleCloudVisionV1p2beta1Paragraph.properties.boundingBox.description - schemas.GoogleCloudVisionV1p2beta1Position.description - schemas.GoogleCloudVisionV1p2beta1Product.properties.description.description - schemas.GoogleCloudVisionV1p2beta1Product.properties.displayName.description - schemas.GoogleCloudVisionV1p2beta1Product.properties.name.description - schemas.GoogleCloudVisionV1p2beta1Product.properties.productCategory.description - schemas.GoogleCloudVisionV1p2beta1Product.properties.productLabels.description - schemas.GoogleCloudVisionV1p2beta1ProductKeyValue.properties.key.description - schemas.GoogleCloudVisionV1p2beta1ProductKeyValue.properties.value.description - schemas.GoogleCloudVisionV1p2beta1ProductSearchResults.properties.indexTime.description - schemas.GoogleCloudVisionV1p2beta1ProductSearchResults.properties.productGroupedResults.description - schemas.GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult.description - schemas.GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation.properties.languageCode.description - schemas.GoogleCloudVisionV1p2beta1ProductSearchResultsResult.properties.image.description - schemas.GoogleCloudVisionV1p2beta1ProductSearchResultsResult.properties.score.description - schemas.GoogleCloudVisionV1p2beta1SafeSearchAnnotation.description - schemas.GoogleCloudVisionV1p2beta1SafeSearchAnnotation.properties.adult.description - schemas.GoogleCloudVisionV1p2beta1SafeSearchAnnotation.properties.racy.description - schemas.GoogleCloudVisionV1p2beta1SafeSearchAnnotation.properties.spoof.description - schemas.GoogleCloudVisionV1p2beta1Symbol.properties.boundingBox.description - schemas.GoogleCloudVisionV1p2beta1TextAnnotation.description - schemas.GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak.properties.type.enumDescriptions - schemas.GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage.properties.languageCode.description - schemas.GoogleCloudVisionV1p2beta1Vertex.description - schemas.GoogleCloudVisionV1p2beta1WebDetection.properties.bestGuessLabels.description - schemas.GoogleCloudVisionV1p2beta1WebDetection.properties.fullMatchingImages.description - schemas.GoogleCloudVisionV1p2beta1WebDetection.properties.partialMatchingImages.description - schemas.GoogleCloudVisionV1p2beta1WebDetectionWebEntity.properties.score.description - schemas.GoogleCloudVisionV1p2beta1WebDetectionWebLabel.properties.languageCode.description - schemas.GoogleCloudVisionV1p2beta1WebDetectionWebPage.properties.fullMatchingImages.description - schemas.GoogleCloudVisionV1p2beta1WebDetectionWebPage.properties.partialMatchingImages.description - schemas.GoogleCloudVisionV1p2beta1Word.properties.boundingBox.description - schemas.GoogleCloudVisionV1p2beta1Word.properties.symbols.description - schemas.GoogleCloudVisionV1p3beta1AnnotateFileResponse.description - schemas.GoogleCloudVisionV1p3beta1AnnotateFileResponse.properties.error.description - schemas.GoogleCloudVisionV1p3beta1AnnotateFileResponse.properties.responses.description - schemas.GoogleCloudVisionV1p3beta1AnnotateImageResponse.properties.context.description - schemas.GoogleCloudVisionV1p3beta1AnnotateImageResponse.properties.error.description - schemas.GoogleCloudVisionV1p3beta1AnnotateImageResponse.properties.fullTextAnnotation.description - schemas.GoogleCloudVisionV1p3beta1AnnotateImageResponse.properties.localizedObjectAnnotations.description - schemas.GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse.properties.responses.description - schemas.GoogleCloudVisionV1p3beta1BatchOperationMetadata.description - schemas.GoogleCloudVisionV1p3beta1BatchOperationMetadata.properties.endTime.description - schemas.GoogleCloudVisionV1p3beta1BatchOperationMetadata.properties.state.enumDescriptions - schemas.GoogleCloudVisionV1p3beta1Block.properties.boundingBox.description - schemas.GoogleCloudVisionV1p3beta1ColorInfo.description - schemas.GoogleCloudVisionV1p3beta1ColorInfo.properties.pixelFraction.description - schemas.GoogleCloudVisionV1p3beta1CropHint.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p3beta1CropHint.properties.confidence.description - schemas.GoogleCloudVisionV1p3beta1CropHint.properties.importanceFraction.description - schemas.GoogleCloudVisionV1p3beta1EntityAnnotation.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p3beta1EntityAnnotation.properties.confidence.description - schemas.GoogleCloudVisionV1p3beta1EntityAnnotation.properties.locale.description - schemas.GoogleCloudVisionV1p3beta1EntityAnnotation.properties.locations.description - schemas.GoogleCloudVisionV1p3beta1EntityAnnotation.properties.mid.description - schemas.GoogleCloudVisionV1p3beta1EntityAnnotation.properties.properties.description - schemas.GoogleCloudVisionV1p3beta1EntityAnnotation.properties.topicality.description - schemas.GoogleCloudVisionV1p3beta1FaceAnnotation.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p3beta1FaceAnnotation.properties.fdBoundingPoly.description - schemas.GoogleCloudVisionV1p3beta1FaceAnnotation.properties.panAngle.description - schemas.GoogleCloudVisionV1p3beta1FaceAnnotation.properties.rollAngle.description - schemas.GoogleCloudVisionV1p3beta1FaceAnnotation.properties.tiltAngle.description - schemas.GoogleCloudVisionV1p3beta1GcsDestination.properties.uri.description - schemas.GoogleCloudVisionV1p3beta1GcsSource.properties.uri.description - schemas.GoogleCloudVisionV1p3beta1ImageAnnotationContext.description - schemas.GoogleCloudVisionV1p3beta1ImageAnnotationContext.properties.pageNumber.description - schemas.GoogleCloudVisionV1p3beta1ImportProductSetsResponse.description - schemas.GoogleCloudVisionV1p3beta1ImportProductSetsResponse.properties.statuses.description - schemas.GoogleCloudVisionV1p3beta1InputConfig.properties.content.description - schemas.GoogleCloudVisionV1p3beta1InputConfig.properties.mimeType.description - schemas.GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation.properties.languageCode.description - schemas.GoogleCloudVisionV1p3beta1NormalizedVertex.description - schemas.GoogleCloudVisionV1p3beta1OutputConfig.properties.batchSize.description - schemas.GoogleCloudVisionV1p3beta1Page.properties.height.description - schemas.GoogleCloudVisionV1p3beta1Page.properties.width.description - schemas.GoogleCloudVisionV1p3beta1Paragraph.properties.boundingBox.description - schemas.GoogleCloudVisionV1p3beta1Position.description - schemas.GoogleCloudVisionV1p3beta1Product.properties.description.description - schemas.GoogleCloudVisionV1p3beta1Product.properties.displayName.description - schemas.GoogleCloudVisionV1p3beta1Product.properties.name.description - schemas.GoogleCloudVisionV1p3beta1Product.properties.productCategory.description - schemas.GoogleCloudVisionV1p3beta1Product.properties.productLabels.description - schemas.GoogleCloudVisionV1p3beta1ProductKeyValue.properties.key.description - schemas.GoogleCloudVisionV1p3beta1ProductKeyValue.properties.value.description - schemas.GoogleCloudVisionV1p3beta1ProductSearchResults.properties.indexTime.description - schemas.GoogleCloudVisionV1p3beta1ProductSearchResults.properties.productGroupedResults.description - schemas.GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult.description - schemas.GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation.properties.languageCode.description - schemas.GoogleCloudVisionV1p3beta1ProductSearchResultsResult.properties.image.description - schemas.GoogleCloudVisionV1p3beta1ProductSearchResultsResult.properties.score.description - schemas.GoogleCloudVisionV1p3beta1ReferenceImage.description - schemas.GoogleCloudVisionV1p3beta1ReferenceImage.properties.boundingPolys.description - schemas.GoogleCloudVisionV1p3beta1ReferenceImage.properties.name.description - schemas.GoogleCloudVisionV1p3beta1ReferenceImage.properties.uri.description - schemas.GoogleCloudVisionV1p3beta1SafeSearchAnnotation.description - schemas.GoogleCloudVisionV1p3beta1SafeSearchAnnotation.properties.adult.description - schemas.GoogleCloudVisionV1p3beta1SafeSearchAnnotation.properties.racy.description - schemas.GoogleCloudVisionV1p3beta1SafeSearchAnnotation.properties.spoof.description - schemas.GoogleCloudVisionV1p3beta1Symbol.properties.boundingBox.description - schemas.GoogleCloudVisionV1p3beta1TextAnnotation.description - schemas.GoogleCloudVisionV1p3beta1TextAnnotationDetectedBreak.properties.type.enumDescriptions - schemas.GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage.properties.languageCode.description - schemas.GoogleCloudVisionV1p3beta1Vertex.description - schemas.GoogleCloudVisionV1p3beta1WebDetection.properties.bestGuessLabels.description - schemas.GoogleCloudVisionV1p3beta1WebDetection.properties.fullMatchingImages.description - schemas.GoogleCloudVisionV1p3beta1WebDetection.properties.partialMatchingImages.description - schemas.GoogleCloudVisionV1p3beta1WebDetectionWebEntity.properties.score.description - schemas.GoogleCloudVisionV1p3beta1WebDetectionWebLabel.properties.languageCode.description - schemas.GoogleCloudVisionV1p3beta1WebDetectionWebPage.properties.fullMatchingImages.description - schemas.GoogleCloudVisionV1p3beta1WebDetectionWebPage.properties.partialMatchingImages.description - schemas.GoogleCloudVisionV1p3beta1Word.properties.boundingBox.description - schemas.GoogleCloudVisionV1p3beta1Word.properties.symbols.description - schemas.GoogleCloudVisionV1p4beta1AnnotateFileResponse.description - schemas.GoogleCloudVisionV1p4beta1AnnotateFileResponse.properties.error.description - schemas.GoogleCloudVisionV1p4beta1AnnotateFileResponse.properties.responses.description - schemas.GoogleCloudVisionV1p4beta1AnnotateImageResponse.properties.context.description - schemas.GoogleCloudVisionV1p4beta1AnnotateImageResponse.properties.error.description - schemas.GoogleCloudVisionV1p4beta1AnnotateImageResponse.properties.fullTextAnnotation.description - schemas.GoogleCloudVisionV1p4beta1AnnotateImageResponse.properties.localizedObjectAnnotations.description - schemas.GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse.properties.responses.description - schemas.GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse.properties.responses.description - schemas.GoogleCloudVisionV1p4beta1BatchOperationMetadata.description - schemas.GoogleCloudVisionV1p4beta1BatchOperationMetadata.properties.endTime.description - schemas.GoogleCloudVisionV1p4beta1BatchOperationMetadata.properties.state.enumDescriptions - schemas.GoogleCloudVisionV1p4beta1Block.properties.boundingBox.description - schemas.GoogleCloudVisionV1p4beta1Celebrity.properties.name.description - schemas.GoogleCloudVisionV1p4beta1ColorInfo.description - schemas.GoogleCloudVisionV1p4beta1ColorInfo.properties.pixelFraction.description - schemas.GoogleCloudVisionV1p4beta1CropHint.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p4beta1CropHint.properties.confidence.description - schemas.GoogleCloudVisionV1p4beta1CropHint.properties.importanceFraction.description - schemas.GoogleCloudVisionV1p4beta1EntityAnnotation.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p4beta1EntityAnnotation.properties.confidence.description - schemas.GoogleCloudVisionV1p4beta1EntityAnnotation.properties.locale.description - schemas.GoogleCloudVisionV1p4beta1EntityAnnotation.properties.locations.description - schemas.GoogleCloudVisionV1p4beta1EntityAnnotation.properties.mid.description - schemas.GoogleCloudVisionV1p4beta1EntityAnnotation.properties.properties.description - schemas.GoogleCloudVisionV1p4beta1EntityAnnotation.properties.topicality.description - schemas.GoogleCloudVisionV1p4beta1FaceAnnotation.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p4beta1FaceAnnotation.properties.fdBoundingPoly.description - schemas.GoogleCloudVisionV1p4beta1FaceAnnotation.properties.panAngle.description - schemas.GoogleCloudVisionV1p4beta1FaceAnnotation.properties.recognitionResult.description - schemas.GoogleCloudVisionV1p4beta1FaceAnnotation.properties.rollAngle.description - schemas.GoogleCloudVisionV1p4beta1FaceAnnotation.properties.tiltAngle.description - schemas.GoogleCloudVisionV1p4beta1GcsDestination.properties.uri.description - schemas.GoogleCloudVisionV1p4beta1GcsSource.properties.uri.description - schemas.GoogleCloudVisionV1p4beta1ImageAnnotationContext.description - schemas.GoogleCloudVisionV1p4beta1ImageAnnotationContext.properties.pageNumber.description - schemas.GoogleCloudVisionV1p4beta1ImportProductSetsResponse.description - schemas.GoogleCloudVisionV1p4beta1ImportProductSetsResponse.properties.statuses.description - schemas.GoogleCloudVisionV1p4beta1InputConfig.properties.content.description - schemas.GoogleCloudVisionV1p4beta1InputConfig.properties.mimeType.description - schemas.GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation.properties.languageCode.description - schemas.GoogleCloudVisionV1p4beta1NormalizedVertex.description - schemas.GoogleCloudVisionV1p4beta1OutputConfig.properties.batchSize.description - schemas.GoogleCloudVisionV1p4beta1Page.properties.height.description - schemas.GoogleCloudVisionV1p4beta1Page.properties.width.description - schemas.GoogleCloudVisionV1p4beta1Paragraph.properties.boundingBox.description - schemas.GoogleCloudVisionV1p4beta1Position.description - schemas.GoogleCloudVisionV1p4beta1Product.properties.description.description - schemas.GoogleCloudVisionV1p4beta1Product.properties.displayName.description - schemas.GoogleCloudVisionV1p4beta1Product.properties.name.description - schemas.GoogleCloudVisionV1p4beta1Product.properties.productCategory.description - schemas.GoogleCloudVisionV1p4beta1Product.properties.productLabels.description - schemas.GoogleCloudVisionV1p4beta1ProductKeyValue.properties.key.description - schemas.GoogleCloudVisionV1p4beta1ProductKeyValue.properties.value.description - schemas.GoogleCloudVisionV1p4beta1ProductSearchResults.properties.indexTime.description - schemas.GoogleCloudVisionV1p4beta1ProductSearchResults.properties.productGroupedResults.description - schemas.GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult.description - schemas.GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation.properties.languageCode.description - schemas.GoogleCloudVisionV1p4beta1ProductSearchResultsResult.properties.image.description - schemas.GoogleCloudVisionV1p4beta1ProductSearchResultsResult.properties.score.description - schemas.GoogleCloudVisionV1p4beta1ReferenceImage.description - schemas.GoogleCloudVisionV1p4beta1ReferenceImage.properties.boundingPolys.description - schemas.GoogleCloudVisionV1p4beta1ReferenceImage.properties.name.description - schemas.GoogleCloudVisionV1p4beta1ReferenceImage.properties.uri.description - schemas.GoogleCloudVisionV1p4beta1SafeSearchAnnotation.description - schemas.GoogleCloudVisionV1p4beta1SafeSearchAnnotation.properties.adult.description - schemas.GoogleCloudVisionV1p4beta1SafeSearchAnnotation.properties.racy.description - schemas.GoogleCloudVisionV1p4beta1SafeSearchAnnotation.properties.spoof.description - schemas.GoogleCloudVisionV1p4beta1Symbol.properties.boundingBox.description - schemas.GoogleCloudVisionV1p4beta1TextAnnotation.description - schemas.GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak.properties.type.enumDescriptions - schemas.GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage.properties.languageCode.description - schemas.GoogleCloudVisionV1p4beta1Vertex.description - schemas.GoogleCloudVisionV1p4beta1WebDetection.properties.bestGuessLabels.description - schemas.GoogleCloudVisionV1p4beta1WebDetection.properties.fullMatchingImages.description - schemas.GoogleCloudVisionV1p4beta1WebDetection.properties.partialMatchingImages.description - schemas.GoogleCloudVisionV1p4beta1WebDetectionWebEntity.properties.score.description - schemas.GoogleCloudVisionV1p4beta1WebDetectionWebLabel.properties.languageCode.description - schemas.GoogleCloudVisionV1p4beta1WebDetectionWebPage.properties.fullMatchingImages.description - schemas.GoogleCloudVisionV1p4beta1WebDetectionWebPage.properties.partialMatchingImages.description - schemas.GoogleCloudVisionV1p4beta1Word.properties.boundingBox.description - schemas.GoogleCloudVisionV1p4beta1Word.properties.symbols.description - schemas.GroupedResult.description - schemas.ImageAnnotationContext.description - schemas.ImageAnnotationContext.properties.pageNumber.description - schemas.ImportProductSetsResponse.description - schemas.ImportProductSetsResponse.properties.statuses.description - schemas.InputConfig.properties.content.description - schemas.InputConfig.properties.mimeType.description - schemas.KeyValue.properties.key.description - schemas.KeyValue.properties.value.description - schemas.LatLng.description - schemas.LocalizedObjectAnnotation.properties.languageCode.description - schemas.NormalizedVertex.description - schemas.ObjectAnnotation.properties.languageCode.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.OutputConfig.properties.batchSize.description - schemas.Page.properties.height.description - schemas.Page.properties.width.description - schemas.Paragraph.properties.boundingBox.description - schemas.Position.description - schemas.Product.properties.description.description - schemas.Product.properties.displayName.description - schemas.Product.properties.name.description - schemas.Product.properties.productCategory.description - schemas.Product.properties.productLabels.description - schemas.ProductSearchResults.properties.indexTime.description - schemas.ProductSearchResults.properties.productGroupedResults.description - schemas.ReferenceImage.description - schemas.ReferenceImage.properties.boundingPolys.description - schemas.ReferenceImage.properties.name.description - schemas.ReferenceImage.properties.uri.description - schemas.Result.properties.image.description - schemas.Result.properties.score.description - schemas.SafeSearchAnnotation.description - schemas.SafeSearchAnnotation.properties.adult.description - schemas.SafeSearchAnnotation.properties.racy.description - schemas.SafeSearchAnnotation.properties.spoof.description - schemas.Status.description - schemas.Status.properties.details.description - schemas.Status.properties.message.description - schemas.Symbol.properties.boundingBox.description - schemas.TextAnnotation.description - schemas.Vertex.description - schemas.WebDetection.properties.bestGuessLabels.description - schemas.WebDetection.properties.fullMatchingImages.description - schemas.WebDetection.properties.partialMatchingImages.description - schemas.WebEntity.properties.score.description - schemas.WebLabel.properties.languageCode.description - schemas.WebPage.properties.fullMatchingImages.description - schemas.WebPage.properties.partialMatchingImages.description - schemas.Word.properties.boundingBox.description - schemas.Word.properties.symbols.description #### vision:v1p2beta1 The following keys were changed: - resources.files.methods.annotate.description - resources.files.methods.asyncBatchAnnotate.description - resources.images.methods.asyncBatchAnnotate.description - resources.projects.resources.files.methods.annotate.description - resources.projects.resources.files.methods.annotate.parameters.parent.description - resources.projects.resources.files.methods.asyncBatchAnnotate.description - resources.projects.resources.files.methods.asyncBatchAnnotate.parameters.parent.description - resources.projects.resources.images.methods.annotate.parameters.parent.description - resources.projects.resources.images.methods.asyncBatchAnnotate.description - resources.projects.resources.images.methods.asyncBatchAnnotate.parameters.parent.description - resources.projects.resources.locations.resources.files.methods.annotate.description - resources.projects.resources.locations.resources.files.methods.annotate.parameters.parent.description - resources.projects.resources.locations.resources.files.methods.asyncBatchAnnotate.description - resources.projects.resources.locations.resources.files.methods.asyncBatchAnnotate.parameters.parent.description - resources.projects.resources.locations.resources.images.methods.annotate.parameters.parent.description - resources.projects.resources.locations.resources.images.methods.asyncBatchAnnotate.description - resources.projects.resources.locations.resources.images.methods.asyncBatchAnnotate.parameters.parent.description - schemas.AnnotateFileResponse.description - schemas.AnnotateFileResponse.properties.error.description - schemas.AnnotateFileResponse.properties.responses.description - schemas.AnnotateImageResponse.properties.context.description - schemas.AnnotateImageResponse.properties.error.description - schemas.AnnotateImageResponse.properties.fullTextAnnotation.description - schemas.AnnotateImageResponse.properties.localizedObjectAnnotations.description - schemas.AsyncBatchAnnotateFilesResponse.properties.responses.description - schemas.BatchAnnotateFilesResponse.properties.responses.description - schemas.BatchOperationMetadata.description - schemas.BatchOperationMetadata.properties.endTime.description - schemas.BatchOperationMetadata.properties.state.enumDescriptions - schemas.Block.properties.boundingBox.description - schemas.Color.description - schemas.Color.properties.alpha.description - schemas.ColorInfo.description - schemas.ColorInfo.properties.pixelFraction.description - schemas.CropHint.properties.boundingPoly.description - schemas.CropHint.properties.confidence.description - schemas.CropHint.properties.importanceFraction.description - schemas.DetectedBreak.properties.type.enumDescriptions - schemas.DetectedLanguage.properties.languageCode.description - schemas.EntityAnnotation.properties.boundingPoly.description - schemas.EntityAnnotation.properties.confidence.description - schemas.EntityAnnotation.properties.locale.description - schemas.EntityAnnotation.properties.locations.description - schemas.EntityAnnotation.properties.mid.description - schemas.EntityAnnotation.properties.properties.description - schemas.EntityAnnotation.properties.topicality.description - schemas.FaceAnnotation.properties.boundingPoly.description - schemas.FaceAnnotation.properties.fdBoundingPoly.description - schemas.FaceAnnotation.properties.panAngle.description - schemas.FaceAnnotation.properties.rollAngle.description - schemas.FaceAnnotation.properties.tiltAngle.description - schemas.GcsDestination.properties.uri.description - schemas.GcsSource.properties.uri.description - schemas.GoogleCloudVisionV1p1beta1AnnotateFileResponse.description - schemas.GoogleCloudVisionV1p1beta1AnnotateFileResponse.properties.error.description - schemas.GoogleCloudVisionV1p1beta1AnnotateFileResponse.properties.responses.description - schemas.GoogleCloudVisionV1p1beta1AnnotateImageResponse.properties.context.description - schemas.GoogleCloudVisionV1p1beta1AnnotateImageResponse.properties.error.description - schemas.GoogleCloudVisionV1p1beta1AnnotateImageResponse.properties.fullTextAnnotation.description - schemas.GoogleCloudVisionV1p1beta1AnnotateImageResponse.properties.localizedObjectAnnotations.description - schemas.GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse.properties.responses.description - schemas.GoogleCloudVisionV1p1beta1Block.properties.boundingBox.description - schemas.GoogleCloudVisionV1p1beta1ColorInfo.description - schemas.GoogleCloudVisionV1p1beta1ColorInfo.properties.pixelFraction.description - schemas.GoogleCloudVisionV1p1beta1CropHint.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p1beta1CropHint.properties.confidence.description - schemas.GoogleCloudVisionV1p1beta1CropHint.properties.importanceFraction.description - schemas.GoogleCloudVisionV1p1beta1EntityAnnotation.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p1beta1EntityAnnotation.properties.confidence.description - schemas.GoogleCloudVisionV1p1beta1EntityAnnotation.properties.locale.description - schemas.GoogleCloudVisionV1p1beta1EntityAnnotation.properties.locations.description - schemas.GoogleCloudVisionV1p1beta1EntityAnnotation.properties.mid.description - schemas.GoogleCloudVisionV1p1beta1EntityAnnotation.properties.properties.description - schemas.GoogleCloudVisionV1p1beta1EntityAnnotation.properties.topicality.description - schemas.GoogleCloudVisionV1p1beta1FaceAnnotation.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p1beta1FaceAnnotation.properties.fdBoundingPoly.description - schemas.GoogleCloudVisionV1p1beta1FaceAnnotation.properties.panAngle.description - schemas.GoogleCloudVisionV1p1beta1FaceAnnotation.properties.rollAngle.description - schemas.GoogleCloudVisionV1p1beta1FaceAnnotation.properties.tiltAngle.description - schemas.GoogleCloudVisionV1p1beta1GcsDestination.properties.uri.description - schemas.GoogleCloudVisionV1p1beta1GcsSource.properties.uri.description - schemas.GoogleCloudVisionV1p1beta1ImageAnnotationContext.description - schemas.GoogleCloudVisionV1p1beta1ImageAnnotationContext.properties.pageNumber.description - schemas.GoogleCloudVisionV1p1beta1InputConfig.properties.content.description - schemas.GoogleCloudVisionV1p1beta1InputConfig.properties.mimeType.description - schemas.GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation.properties.languageCode.description - schemas.GoogleCloudVisionV1p1beta1NormalizedVertex.description - schemas.GoogleCloudVisionV1p1beta1OutputConfig.properties.batchSize.description - schemas.GoogleCloudVisionV1p1beta1Page.properties.height.description - schemas.GoogleCloudVisionV1p1beta1Page.properties.width.description - schemas.GoogleCloudVisionV1p1beta1Paragraph.properties.boundingBox.description - schemas.GoogleCloudVisionV1p1beta1Position.description - schemas.GoogleCloudVisionV1p1beta1Product.properties.description.description - schemas.GoogleCloudVisionV1p1beta1Product.properties.displayName.description - schemas.GoogleCloudVisionV1p1beta1Product.properties.name.description - schemas.GoogleCloudVisionV1p1beta1Product.properties.productCategory.description - schemas.GoogleCloudVisionV1p1beta1Product.properties.productLabels.description - schemas.GoogleCloudVisionV1p1beta1ProductKeyValue.properties.key.description - schemas.GoogleCloudVisionV1p1beta1ProductKeyValue.properties.value.description - schemas.GoogleCloudVisionV1p1beta1ProductSearchResults.properties.indexTime.description - schemas.GoogleCloudVisionV1p1beta1ProductSearchResults.properties.productGroupedResults.description - schemas.GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult.description - schemas.GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation.properties.languageCode.description - schemas.GoogleCloudVisionV1p1beta1ProductSearchResultsResult.properties.image.description - schemas.GoogleCloudVisionV1p1beta1ProductSearchResultsResult.properties.score.description - schemas.GoogleCloudVisionV1p1beta1SafeSearchAnnotation.description - schemas.GoogleCloudVisionV1p1beta1SafeSearchAnnotation.properties.adult.description - schemas.GoogleCloudVisionV1p1beta1SafeSearchAnnotation.properties.racy.description - schemas.GoogleCloudVisionV1p1beta1SafeSearchAnnotation.properties.spoof.description - schemas.GoogleCloudVisionV1p1beta1Symbol.properties.boundingBox.description - schemas.GoogleCloudVisionV1p1beta1TextAnnotation.description - schemas.GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak.properties.type.enumDescriptions - schemas.GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage.properties.languageCode.description - schemas.GoogleCloudVisionV1p1beta1Vertex.description - schemas.GoogleCloudVisionV1p1beta1WebDetection.properties.bestGuessLabels.description - schemas.GoogleCloudVisionV1p1beta1WebDetection.properties.fullMatchingImages.description - schemas.GoogleCloudVisionV1p1beta1WebDetection.properties.partialMatchingImages.description - schemas.GoogleCloudVisionV1p1beta1WebDetectionWebEntity.properties.score.description - schemas.GoogleCloudVisionV1p1beta1WebDetectionWebLabel.properties.languageCode.description - schemas.GoogleCloudVisionV1p1beta1WebDetectionWebPage.properties.fullMatchingImages.description - schemas.GoogleCloudVisionV1p1beta1WebDetectionWebPage.properties.partialMatchingImages.description - schemas.GoogleCloudVisionV1p1beta1Word.properties.boundingBox.description - schemas.GoogleCloudVisionV1p1beta1Word.properties.symbols.description - schemas.GoogleCloudVisionV1p2beta1AnnotateFileRequest.properties.pages.description - schemas.GoogleCloudVisionV1p2beta1AnnotateFileResponse.description - schemas.GoogleCloudVisionV1p2beta1AnnotateFileResponse.properties.error.description - schemas.GoogleCloudVisionV1p2beta1AnnotateFileResponse.properties.responses.description - schemas.GoogleCloudVisionV1p2beta1AnnotateImageRequest.description - schemas.GoogleCloudVisionV1p2beta1AnnotateImageResponse.properties.context.description - schemas.GoogleCloudVisionV1p2beta1AnnotateImageResponse.properties.error.description - schemas.GoogleCloudVisionV1p2beta1AnnotateImageResponse.properties.fullTextAnnotation.description - schemas.GoogleCloudVisionV1p2beta1AnnotateImageResponse.properties.localizedObjectAnnotations.description - schemas.GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest.description - schemas.GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest.properties.parent.description - schemas.GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse.properties.responses.description - schemas.GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest.properties.parent.description - schemas.GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest.properties.parent.description - schemas.GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest.properties.requests.description - schemas.GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse.properties.responses.description - schemas.GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest.properties.parent.description - schemas.GoogleCloudVisionV1p2beta1Block.properties.boundingBox.description - schemas.GoogleCloudVisionV1p2beta1ColorInfo.description - schemas.GoogleCloudVisionV1p2beta1ColorInfo.properties.pixelFraction.description - schemas.GoogleCloudVisionV1p2beta1CropHint.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p2beta1CropHint.properties.confidence.description - schemas.GoogleCloudVisionV1p2beta1CropHint.properties.importanceFraction.description - schemas.GoogleCloudVisionV1p2beta1CropHintsParams.properties.aspectRatios.description - schemas.GoogleCloudVisionV1p2beta1EntityAnnotation.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p2beta1EntityAnnotation.properties.confidence.description - schemas.GoogleCloudVisionV1p2beta1EntityAnnotation.properties.locale.description - schemas.GoogleCloudVisionV1p2beta1EntityAnnotation.properties.locations.description - schemas.GoogleCloudVisionV1p2beta1EntityAnnotation.properties.mid.description - schemas.GoogleCloudVisionV1p2beta1EntityAnnotation.properties.properties.description - schemas.GoogleCloudVisionV1p2beta1EntityAnnotation.properties.topicality.description - schemas.GoogleCloudVisionV1p2beta1FaceAnnotation.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p2beta1FaceAnnotation.properties.fdBoundingPoly.description - schemas.GoogleCloudVisionV1p2beta1FaceAnnotation.properties.panAngle.description - schemas.GoogleCloudVisionV1p2beta1FaceAnnotation.properties.rollAngle.description - schemas.GoogleCloudVisionV1p2beta1FaceAnnotation.properties.tiltAngle.description - schemas.GoogleCloudVisionV1p2beta1Feature.description - schemas.GoogleCloudVisionV1p2beta1Feature.properties.maxResults.description - schemas.GoogleCloudVisionV1p2beta1Feature.properties.model.description - schemas.GoogleCloudVisionV1p2beta1Feature.properties.type.enumDescriptions - schemas.GoogleCloudVisionV1p2beta1GcsDestination.properties.uri.description - schemas.GoogleCloudVisionV1p2beta1GcsSource.properties.uri.description - schemas.GoogleCloudVisionV1p2beta1Image.properties.content.description - schemas.GoogleCloudVisionV1p2beta1Image.properties.source.description - schemas.GoogleCloudVisionV1p2beta1ImageAnnotationContext.description - schemas.GoogleCloudVisionV1p2beta1ImageAnnotationContext.properties.pageNumber.description - schemas.GoogleCloudVisionV1p2beta1ImageContext.properties.languageHints.description - schemas.GoogleCloudVisionV1p2beta1ImageSource.properties.gcsImageUri.description - schemas.GoogleCloudVisionV1p2beta1ImageSource.properties.imageUri.description - schemas.GoogleCloudVisionV1p2beta1InputConfig.properties.content.description - schemas.GoogleCloudVisionV1p2beta1InputConfig.properties.mimeType.description - schemas.GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation.properties.languageCode.description - schemas.GoogleCloudVisionV1p2beta1NormalizedVertex.description - schemas.GoogleCloudVisionV1p2beta1OutputConfig.properties.batchSize.description - schemas.GoogleCloudVisionV1p2beta1Page.properties.height.description - schemas.GoogleCloudVisionV1p2beta1Page.properties.width.description - schemas.GoogleCloudVisionV1p2beta1Paragraph.properties.boundingBox.description - schemas.GoogleCloudVisionV1p2beta1Position.description - schemas.GoogleCloudVisionV1p2beta1Product.properties.description.description - schemas.GoogleCloudVisionV1p2beta1Product.properties.displayName.description - schemas.GoogleCloudVisionV1p2beta1Product.properties.name.description - schemas.GoogleCloudVisionV1p2beta1Product.properties.productCategory.description - schemas.GoogleCloudVisionV1p2beta1Product.properties.productLabels.description - schemas.GoogleCloudVisionV1p2beta1ProductKeyValue.properties.key.description - schemas.GoogleCloudVisionV1p2beta1ProductKeyValue.properties.value.description - schemas.GoogleCloudVisionV1p2beta1ProductSearchParams.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p2beta1ProductSearchParams.properties.filter.description - schemas.GoogleCloudVisionV1p2beta1ProductSearchParams.properties.productCategories.description - schemas.GoogleCloudVisionV1p2beta1ProductSearchParams.properties.productSet.description - schemas.GoogleCloudVisionV1p2beta1ProductSearchResults.properties.indexTime.description - schemas.GoogleCloudVisionV1p2beta1ProductSearchResults.properties.productGroupedResults.description - schemas.GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult.description - schemas.GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation.properties.languageCode.description - schemas.GoogleCloudVisionV1p2beta1ProductSearchResultsResult.properties.image.description - schemas.GoogleCloudVisionV1p2beta1ProductSearchResultsResult.properties.score.description - schemas.GoogleCloudVisionV1p2beta1SafeSearchAnnotation.description - schemas.GoogleCloudVisionV1p2beta1SafeSearchAnnotation.properties.adult.description - schemas.GoogleCloudVisionV1p2beta1SafeSearchAnnotation.properties.racy.description - schemas.GoogleCloudVisionV1p2beta1SafeSearchAnnotation.properties.spoof.description - schemas.GoogleCloudVisionV1p2beta1Symbol.properties.boundingBox.description - schemas.GoogleCloudVisionV1p2beta1TextAnnotation.description - schemas.GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak.properties.type.enumDescriptions - schemas.GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage.properties.languageCode.description - schemas.GoogleCloudVisionV1p2beta1Vertex.description - schemas.GoogleCloudVisionV1p2beta1WebDetection.properties.bestGuessLabels.description - schemas.GoogleCloudVisionV1p2beta1WebDetection.properties.fullMatchingImages.description - schemas.GoogleCloudVisionV1p2beta1WebDetection.properties.partialMatchingImages.description - schemas.GoogleCloudVisionV1p2beta1WebDetectionWebEntity.properties.score.description - schemas.GoogleCloudVisionV1p2beta1WebDetectionWebLabel.properties.languageCode.description - schemas.GoogleCloudVisionV1p2beta1WebDetectionWebPage.properties.fullMatchingImages.description - schemas.GoogleCloudVisionV1p2beta1WebDetectionWebPage.properties.partialMatchingImages.description - schemas.GoogleCloudVisionV1p2beta1Word.properties.boundingBox.description - schemas.GoogleCloudVisionV1p2beta1Word.properties.symbols.description - schemas.GoogleCloudVisionV1p3beta1AnnotateFileResponse.description - schemas.GoogleCloudVisionV1p3beta1AnnotateFileResponse.properties.error.description - schemas.GoogleCloudVisionV1p3beta1AnnotateFileResponse.properties.responses.description - schemas.GoogleCloudVisionV1p3beta1AnnotateImageResponse.properties.context.description - schemas.GoogleCloudVisionV1p3beta1AnnotateImageResponse.properties.error.description - schemas.GoogleCloudVisionV1p3beta1AnnotateImageResponse.properties.fullTextAnnotation.description - schemas.GoogleCloudVisionV1p3beta1AnnotateImageResponse.properties.localizedObjectAnnotations.description - schemas.GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse.properties.responses.description - schemas.GoogleCloudVisionV1p3beta1BatchOperationMetadata.description - schemas.GoogleCloudVisionV1p3beta1BatchOperationMetadata.properties.endTime.description - schemas.GoogleCloudVisionV1p3beta1BatchOperationMetadata.properties.state.enumDescriptions - schemas.GoogleCloudVisionV1p3beta1Block.properties.boundingBox.description - schemas.GoogleCloudVisionV1p3beta1ColorInfo.description - schemas.GoogleCloudVisionV1p3beta1ColorInfo.properties.pixelFraction.description - schemas.GoogleCloudVisionV1p3beta1CropHint.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p3beta1CropHint.properties.confidence.description - schemas.GoogleCloudVisionV1p3beta1CropHint.properties.importanceFraction.description - schemas.GoogleCloudVisionV1p3beta1EntityAnnotation.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p3beta1EntityAnnotation.properties.confidence.description - schemas.GoogleCloudVisionV1p3beta1EntityAnnotation.properties.locale.description - schemas.GoogleCloudVisionV1p3beta1EntityAnnotation.properties.locations.description - schemas.GoogleCloudVisionV1p3beta1EntityAnnotation.properties.mid.description - schemas.GoogleCloudVisionV1p3beta1EntityAnnotation.properties.properties.description - schemas.GoogleCloudVisionV1p3beta1EntityAnnotation.properties.topicality.description - schemas.GoogleCloudVisionV1p3beta1FaceAnnotation.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p3beta1FaceAnnotation.properties.fdBoundingPoly.description - schemas.GoogleCloudVisionV1p3beta1FaceAnnotation.properties.panAngle.description - schemas.GoogleCloudVisionV1p3beta1FaceAnnotation.properties.rollAngle.description - schemas.GoogleCloudVisionV1p3beta1FaceAnnotation.properties.tiltAngle.description - schemas.GoogleCloudVisionV1p3beta1GcsDestination.properties.uri.description - schemas.GoogleCloudVisionV1p3beta1GcsSource.properties.uri.description - schemas.GoogleCloudVisionV1p3beta1ImageAnnotationContext.description - schemas.GoogleCloudVisionV1p3beta1ImageAnnotationContext.properties.pageNumber.description - schemas.GoogleCloudVisionV1p3beta1ImportProductSetsResponse.description - schemas.GoogleCloudVisionV1p3beta1ImportProductSetsResponse.properties.statuses.description - schemas.GoogleCloudVisionV1p3beta1InputConfig.properties.content.description - schemas.GoogleCloudVisionV1p3beta1InputConfig.properties.mimeType.description - schemas.GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation.properties.languageCode.description - schemas.GoogleCloudVisionV1p3beta1NormalizedVertex.description - schemas.GoogleCloudVisionV1p3beta1OutputConfig.properties.batchSize.description - schemas.GoogleCloudVisionV1p3beta1Page.properties.height.description - schemas.GoogleCloudVisionV1p3beta1Page.properties.width.description - schemas.GoogleCloudVisionV1p3beta1Paragraph.properties.boundingBox.description - schemas.GoogleCloudVisionV1p3beta1Position.description - schemas.GoogleCloudVisionV1p3beta1Product.properties.description.description - schemas.GoogleCloudVisionV1p3beta1Product.properties.displayName.description - schemas.GoogleCloudVisionV1p3beta1Product.properties.name.description - schemas.GoogleCloudVisionV1p3beta1Product.properties.productCategory.description - schemas.GoogleCloudVisionV1p3beta1Product.properties.productLabels.description - schemas.GoogleCloudVisionV1p3beta1ProductKeyValue.properties.key.description - schemas.GoogleCloudVisionV1p3beta1ProductKeyValue.properties.value.description - schemas.GoogleCloudVisionV1p3beta1ProductSearchResults.properties.indexTime.description - schemas.GoogleCloudVisionV1p3beta1ProductSearchResults.properties.productGroupedResults.description - schemas.GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult.description - schemas.GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation.properties.languageCode.description - schemas.GoogleCloudVisionV1p3beta1ProductSearchResultsResult.properties.image.description - schemas.GoogleCloudVisionV1p3beta1ProductSearchResultsResult.properties.score.description - schemas.GoogleCloudVisionV1p3beta1ReferenceImage.description - schemas.GoogleCloudVisionV1p3beta1ReferenceImage.properties.boundingPolys.description - schemas.GoogleCloudVisionV1p3beta1ReferenceImage.properties.name.description - schemas.GoogleCloudVisionV1p3beta1ReferenceImage.properties.uri.description - schemas.GoogleCloudVisionV1p3beta1SafeSearchAnnotation.description - schemas.GoogleCloudVisionV1p3beta1SafeSearchAnnotation.properties.adult.description - schemas.GoogleCloudVisionV1p3beta1SafeSearchAnnotation.properties.racy.description - schemas.GoogleCloudVisionV1p3beta1SafeSearchAnnotation.properties.spoof.description - schemas.GoogleCloudVisionV1p3beta1Symbol.properties.boundingBox.description - schemas.GoogleCloudVisionV1p3beta1TextAnnotation.description - schemas.GoogleCloudVisionV1p3beta1TextAnnotationDetectedBreak.properties.type.enumDescriptions - schemas.GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage.properties.languageCode.description - schemas.GoogleCloudVisionV1p3beta1Vertex.description - schemas.GoogleCloudVisionV1p3beta1WebDetection.properties.bestGuessLabels.description - schemas.GoogleCloudVisionV1p3beta1WebDetection.properties.fullMatchingImages.description - schemas.GoogleCloudVisionV1p3beta1WebDetection.properties.partialMatchingImages.description - schemas.GoogleCloudVisionV1p3beta1WebDetectionWebEntity.properties.score.description - schemas.GoogleCloudVisionV1p3beta1WebDetectionWebLabel.properties.languageCode.description - schemas.GoogleCloudVisionV1p3beta1WebDetectionWebPage.properties.fullMatchingImages.description - schemas.GoogleCloudVisionV1p3beta1WebDetectionWebPage.properties.partialMatchingImages.description - schemas.GoogleCloudVisionV1p3beta1Word.properties.boundingBox.description - schemas.GoogleCloudVisionV1p3beta1Word.properties.symbols.description - schemas.GoogleCloudVisionV1p4beta1AnnotateFileResponse.description - schemas.GoogleCloudVisionV1p4beta1AnnotateFileResponse.properties.error.description - schemas.GoogleCloudVisionV1p4beta1AnnotateFileResponse.properties.responses.description - schemas.GoogleCloudVisionV1p4beta1AnnotateImageResponse.properties.context.description - schemas.GoogleCloudVisionV1p4beta1AnnotateImageResponse.properties.error.description - schemas.GoogleCloudVisionV1p4beta1AnnotateImageResponse.properties.fullTextAnnotation.description - schemas.GoogleCloudVisionV1p4beta1AnnotateImageResponse.properties.localizedObjectAnnotations.description - schemas.GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse.properties.responses.description - schemas.GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse.properties.responses.description - schemas.GoogleCloudVisionV1p4beta1BatchOperationMetadata.description - schemas.GoogleCloudVisionV1p4beta1BatchOperationMetadata.properties.endTime.description - schemas.GoogleCloudVisionV1p4beta1BatchOperationMetadata.properties.state.enumDescriptions - schemas.GoogleCloudVisionV1p4beta1Block.properties.boundingBox.description - schemas.GoogleCloudVisionV1p4beta1Celebrity.properties.name.description - schemas.GoogleCloudVisionV1p4beta1ColorInfo.description - schemas.GoogleCloudVisionV1p4beta1ColorInfo.properties.pixelFraction.description - schemas.GoogleCloudVisionV1p4beta1CropHint.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p4beta1CropHint.properties.confidence.description - schemas.GoogleCloudVisionV1p4beta1CropHint.properties.importanceFraction.description - schemas.GoogleCloudVisionV1p4beta1EntityAnnotation.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p4beta1EntityAnnotation.properties.confidence.description - schemas.GoogleCloudVisionV1p4beta1EntityAnnotation.properties.locale.description - schemas.GoogleCloudVisionV1p4beta1EntityAnnotation.properties.locations.description - schemas.GoogleCloudVisionV1p4beta1EntityAnnotation.properties.mid.description - schemas.GoogleCloudVisionV1p4beta1EntityAnnotation.properties.properties.description - schemas.GoogleCloudVisionV1p4beta1EntityAnnotation.properties.topicality.description - schemas.GoogleCloudVisionV1p4beta1FaceAnnotation.properties.boundingPoly.description - schemas.GoogleCloudVisionV1p4beta1FaceAnnotation.properties.fdBoundingPoly.description - schemas.GoogleCloudVisionV1p4beta1FaceAnnotation.properties.panAngle.description - schemas.GoogleCloudVisionV1p4beta1FaceAnnotation.properties.recognitionResult.description - schemas.GoogleCloudVisionV1p4beta1FaceAnnotation.properties.rollAngle.description - schemas.GoogleCloudVisionV1p4beta1FaceAnnotation.properties.tiltAngle.description - schemas.GoogleCloudVisionV1p4beta1GcsDestination.properties.uri.description - schemas.GoogleCloudVisionV1p4beta1GcsSource.properties.uri.description - schemas.GoogleCloudVisionV1p4beta1ImageAnnotationContext.description - schemas.GoogleCloudVisionV1p4beta1ImageAnnotationContext.properties.pageNumber.description - schemas.GoogleCloudVisionV1p4beta1ImportProductSetsResponse.description - schemas.GoogleCloudVisionV1p4beta1ImportProductSetsResponse.properties.statuses.description - schemas.GoogleCloudVisionV1p4beta1InputConfig.properties.content.description - schemas.GoogleCloudVisionV1p4beta1InputConfig.properties.mimeType.description - schemas.GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation.properties.languageCode.description - schemas.GoogleCloudVisionV1p4beta1NormalizedVertex.description - schemas.GoogleCloudVisionV1p4beta1OutputConfig.properties.batchSize.description - schemas.GoogleCloudVisionV1p4beta1Page.properties.height.description - schemas.GoogleCloudVisionV1p4beta1Page.properties.width.description - schemas.GoogleCloudVisionV1p4beta1Paragraph.properties.boundingBox.description - schemas.GoogleCloudVisionV1p4beta1Position.description - schemas.GoogleCloudVisionV1p4beta1Product.properties.description.description - schemas.GoogleCloudVisionV1p4beta1Product.properties.displayName.description - schemas.GoogleCloudVisionV1p4beta1Product.properties.name.description - schemas.GoogleCloudVisionV1p4beta1Product.properties.productCategory.description - schemas.GoogleCloudVisionV1p4beta1Product.properties.productLabels.description - schemas.GoogleCloudVisionV1p4beta1ProductKeyValue.properties.key.description - schemas.GoogleCloudVisionV1p4beta1ProductKeyValue.properties.value.description - schemas.GoogleCloudVisionV1p4beta1ProductSearchResults.properties.indexTime.description - schemas.GoogleCloudVisionV1p4beta1ProductSearchResults.properties.productGroupedResults.description - schemas.GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult.description - schemas.GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation.properties.languageCode.description - schemas.GoogleCloudVisionV1p4beta1ProductSearchResultsResult.properties.image.description - schemas.GoogleCloudVisionV1p4beta1ProductSearchResultsResult.properties.score.description - schemas.GoogleCloudVisionV1p4beta1ReferenceImage.description - schemas.GoogleCloudVisionV1p4beta1ReferenceImage.properties.boundingPolys.description - schemas.GoogleCloudVisionV1p4beta1ReferenceImage.properties.name.description - schemas.GoogleCloudVisionV1p4beta1ReferenceImage.properties.uri.description - schemas.GoogleCloudVisionV1p4beta1SafeSearchAnnotation.description - schemas.GoogleCloudVisionV1p4beta1SafeSearchAnnotation.properties.adult.description - schemas.GoogleCloudVisionV1p4beta1SafeSearchAnnotation.properties.racy.description - schemas.GoogleCloudVisionV1p4beta1SafeSearchAnnotation.properties.spoof.description - schemas.GoogleCloudVisionV1p4beta1Symbol.properties.boundingBox.description - schemas.GoogleCloudVisionV1p4beta1TextAnnotation.description - schemas.GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak.properties.type.enumDescriptions - schemas.GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage.properties.languageCode.description - schemas.GoogleCloudVisionV1p4beta1Vertex.description - schemas.GoogleCloudVisionV1p4beta1WebDetection.properties.bestGuessLabels.description - schemas.GoogleCloudVisionV1p4beta1WebDetection.properties.fullMatchingImages.description - schemas.GoogleCloudVisionV1p4beta1WebDetection.properties.partialMatchingImages.description - schemas.GoogleCloudVisionV1p4beta1WebDetectionWebEntity.properties.score.description - schemas.GoogleCloudVisionV1p4beta1WebDetectionWebLabel.properties.languageCode.description - schemas.GoogleCloudVisionV1p4beta1WebDetectionWebPage.properties.fullMatchingImages.description - schemas.GoogleCloudVisionV1p4beta1WebDetectionWebPage.properties.partialMatchingImages.description - schemas.GoogleCloudVisionV1p4beta1Word.properties.boundingBox.description - schemas.GoogleCloudVisionV1p4beta1Word.properties.symbols.description - schemas.GroupedResult.description - schemas.ImageAnnotationContext.description - schemas.ImageAnnotationContext.properties.pageNumber.description - schemas.ImportProductSetsResponse.description - schemas.ImportProductSetsResponse.properties.statuses.description - schemas.InputConfig.properties.content.description - schemas.InputConfig.properties.mimeType.description - schemas.KeyValue.properties.key.description - schemas.KeyValue.properties.value.description - schemas.LatLng.description - schemas.LocalizedObjectAnnotation.properties.languageCode.description - schemas.NormalizedVertex.description - schemas.ObjectAnnotation.properties.languageCode.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.OutputConfig.properties.batchSize.description - schemas.Page.properties.height.description - schemas.Page.properties.width.description - schemas.Paragraph.properties.boundingBox.description - schemas.Position.description - schemas.Product.properties.description.description - schemas.Product.properties.displayName.description - schemas.Product.properties.name.description - schemas.P… * feat(websecurityscanner): update the API #### websecurityscanner:v1alpha The following keys were added: - schemas.ScanConfig.properties.targetPlatforms.items.enumDescriptions The following keys were changed: - resources.projects.resources.scanConfigs.methods.create.parameters.parent.description - resources.projects.resources.scanConfigs.methods.delete.parameters.name.description - resources.projects.resources.scanConfigs.methods.get.parameters.name.description - resources.projects.resources.scanConfigs.methods.list.parameters.pageSize.description - resources.projects.resources.scanConfigs.methods.list.parameters.pageToken.description - resources.projects.resources.scanConfigs.methods.list.parameters.parent.description - resources.projects.resources.scanConfigs.methods.patch.parameters.name.description - resources.projects.resources.scanConfigs.methods.patch.parameters.updateMask.description - resources.projects.resources.scanConfigs.methods.start.parameters.name.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.get.parameters.name.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.list.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.list.parameters.pageSize.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.list.parameters.pageToken.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.list.parameters.parent.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.stop.parameters.name.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.crawledUrls.methods.list.parameters.pageSize.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.crawledUrls.methods.list.parameters.pageToken.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.crawledUrls.methods.list.parameters.parent.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findingTypeStats.methods.list.parameters.parent.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findings.methods.get.parameters.name.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findings.methods.list.parameters.filter.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findings.methods.list.parameters.pageSize.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findings.methods.list.parameters.pageToken.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findings.methods.list.parameters.parent.description - schemas.CrawledUrl.description - schemas.CrawledUrl.properties.httpMethod.description - schemas.CustomAccount.properties.password.description - schemas.Empty.description - schemas.Finding.description - schemas.Finding.properties.findingType.enumDescriptions - schemas.Finding.properties.frameUrl.description - schemas.Finding.properties.fuzzedUrl.description - schemas.Finding.properties.httpMethod.description - schemas.Finding.properties.name.description - schemas.Finding.properties.reproductionUrl.description - schemas.Finding.properties.trackingId.description - schemas.Finding.properties.violatingResource.description - schemas.Finding.properties.vulnerableParameters.description - schemas.FindingTypeStats.description - schemas.FindingTypeStats.properties.findingType.enumDescriptions - schemas.GoogleAccount.properties.password.description - schemas.ListCrawledUrlsResponse.properties.nextPageToken.description - schemas.ListFindingsResponse.properties.nextPageToken.description - schemas.ListScanConfigsResponse.properties.nextPageToken.description - schemas.ListScanRunsResponse.properties.nextPageToken.description - schemas.ScanConfig.description - schemas.ScanConfig.properties.authentication.description - schemas.ScanConfig.properties.blacklistPatterns.description - schemas.ScanConfig.properties.maxQps.description - schemas.ScanConfig.properties.name.description - schemas.ScanConfig.properties.targetPlatforms.description - schemas.ScanConfig.properties.targetPlatforms.enumDescriptions - schemas.ScanRun.properties.endTime.description - schemas.ScanRun.properties.executionState.enumDescriptions - schemas.ScanRun.properties.name.description - schemas.ScanRun.properties.progressPercent.description - schemas.ScanRun.properties.resultState.description - schemas.ScanRun.properties.resultState.enumDescriptions - schemas.ScanRun.properties.urlsCrawledCount.description - schemas.ScanRun.properties.urlsTestedCount.description - schemas.Schedule.properties.scheduleTime.description - schemas.ViolatingResource.description #### websecurityscanner:v1beta The following keys were added: - schemas.ScanConfig.properties.targetPlatforms.items.enumDescriptions The following keys were changed: - resources.projects.resources.scanConfigs.methods.create.parameters.parent.description - resources.projects.resources.scanConfigs.methods.delete.parameters.name.description - resources.projects.resources.scanConfigs.methods.get.parameters.name.description - resources.projects.resources.scanConfigs.methods.list.parameters.pageSize.description - resources.projects.resources.scanConfigs.methods.list.parameters.pageToken.description - resources.projects.resources.scanConfigs.methods.list.parameters.parent.description - resources.projects.resources.scanConfigs.methods.patch.parameters.name.description - resources.projects.resources.scanConfigs.methods.patch.parameters.updateMask.description - resources.projects.resources.scanConfigs.methods.start.parameters.name.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.get.parameters.name.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.list.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.list.parameters.pageSize.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.list.parameters.pageToken.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.list.parameters.parent.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.stop.parameters.name.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.crawledUrls.methods.list.parameters.pageSize.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.crawledUrls.methods.list.parameters.pageToken.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.crawledUrls.methods.list.parameters.parent.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findingTypeStats.methods.list.parameters.parent.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findings.methods.get.parameters.name.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findings.methods.list.parameters.filter.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findings.methods.list.parameters.pageSize.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findings.methods.list.parameters.pageToken.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findings.methods.list.parameters.parent.description - schemas.CrawledUrl.description - schemas.CrawledUrl.properties.httpMethod.description - schemas.CustomAccount.properties.password.description - schemas.Empty.description - schemas.Finding.description - schemas.Finding.properties.findingType.description - schemas.Finding.properties.form.description - schemas.Finding.properties.frameUrl.description - schemas.Finding.properties.fuzzedUrl.description - schemas.Finding.properties.httpMethod.description - schemas.Finding.properties.name.description - schemas.Finding.properties.reproductionUrl.description - schemas.Finding.properties.trackingId.description - schemas.Finding.properties.violatingResource.description - schemas.Finding.properties.vulnerableParameters.description - schemas.FindingTypeStats.description - schemas.GoogleAccount.properties.password.description - schemas.IapCredential.properties.iapTestServiceAccountInfo.description - schemas.IapTestServiceAccountInfo.description - schemas.IapTestServiceAccountInfo.properties.targetAudienceClientId.description - schemas.ListCrawledUrlsResponse.properties.nextPageToken.description - schemas.ListFindingsResponse.properties.nextPageToken.description - schemas.ListScanConfigsResponse.properties.nextPageToken.description - schemas.ListScanRunsResponse.properties.nextPageToken.description - schemas.ScanConfig.properties.authentication.description - schemas.ScanConfig.properties.blacklistPatterns.description - schemas.ScanConfig.properties.exportToSecurityCommandCenter.description - schemas.ScanConfig.properties.managedScan.description - schemas.ScanConfig.properties.maxQps.description - schemas.ScanConfig.properties.name.description - schemas.ScanConfig.properties.staticIpScan.description - schemas.ScanConfig.properties.targetPlatforms.description - schemas.ScanConfig.properties.targetPlatforms.enumDescriptions - schemas.ScanConfigError.description - schemas.ScanConfigError.properties.code.enumDescriptions - schemas.ScanConfigError.properties.fieldName.description - schemas.ScanRun.description - schemas.ScanRun.properties.endTime.description - schemas.ScanRun.properties.errorTrace.description - schemas.ScanRun.properties.executionState.enumDescriptions - schemas.ScanRun.properties.name.description - schemas.ScanRun.properties.progressPercent.description - schemas.ScanRun.properties.resultState.description - schemas.ScanRun.properties.resultState.enumDescriptions - schemas.ScanRun.properties.urlsCrawledCount.description - schemas.ScanRun.properties.urlsTestedCount.description - schemas.ScanRunErrorTrace.description - schemas.ScanRunErrorTrace.properties.code.enumDescriptions - schemas.ScanRunErrorTrace.properties.mostCommonHttpErrorCode.description - schemas.ScanRunErrorTrace.properties.scanConfigError.description - schemas.ScanRunWarningTrace.description - schemas.ScanRunWarningTrace.properties.code.enumDescriptions - schemas.Schedule.properties.scheduleTime.description - schemas.ViolatingResource.description #### websecurityscanner:v1 The following keys were added: - schemas.Finding.properties.severity.readOnly The following keys were changed: - resources.projects.resources.scanConfigs.methods.create.parameters.parent.description - resources.projects.resources.scanConfigs.methods.delete.parameters.name.description - resources.projects.resources.scanConfigs.methods.get.parameters.name.description - resources.projects.resources.scanConfigs.methods.list.parameters.pageSize.description - resources.projects.resources.scanConfigs.methods.list.parameters.pageToken.description - resources.projects.resources.scanConfigs.methods.list.parameters.parent.description - resources.projects.resources.scanConfigs.methods.patch.parameters.name.description - resources.projects.resources.scanConfigs.methods.patch.parameters.updateMask.description - resources.projects.resources.scanConfigs.methods.start.parameters.name.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.get.parameters.name.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.list.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.list.parameters.pageSize.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.list.parameters.pageToken.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.list.parameters.parent.description - resources.projects.resources.scanConfigs.resources.scanRuns.methods.stop.parameters.name.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.crawledUrls.methods.list.parameters.pageSize.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.crawledUrls.methods.list.parameters.pageToken.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.crawledUrls.methods.list.parameters.parent.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findingTypeStats.methods.list.parameters.parent.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findings.methods.get.parameters.name.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findings.methods.list.parameters.filter.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findings.methods.list.parameters.pageSize.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findings.methods.list.parameters.pageToken.description - resources.projects.resources.scanConfigs.resources.scanRuns.resources.findings.methods.list.parameters.parent.description - schemas.CrawledUrl.description - schemas.CrawledUrl.properties.httpMethod.description - schemas.CustomAccount.properties.password.description - schemas.Empty.description - schemas.Finding.description - schemas.Finding.properties.findingType.description - schemas.Finding.properties.form.description - schemas.Finding.properties.frameUrl.description - schemas.Finding.properties.fuzzedUrl.description - schemas.Finding.properties.httpMethod.description - schemas.Finding.properties.name.description - schemas.Finding.properties.reproductionUrl.description - schemas.Finding.properties.trackingId.description - schemas.Finding.properties.violatingResource.description - schemas.Finding.properties.vulnerableParameters.description - schemas.FindingTypeStats.description - schemas.GoogleAccount.properties.password.description - schemas.IapCredential.properties.iapTestServiceAccountInfo.description - schemas.IapTestServiceAccountInfo.description - schemas.IapTestServiceAccountInfo.properties.targetAudienceClientId.description - schemas.ListCrawledUrlsResponse.properties.nextPageToken.description - schemas.ListFindingsResponse.properties.nextPageToken.description - schemas.ListScanConfigsResponse.properties.nextPageToken.description - schemas.ListScanRunsResponse.properties.nextPageToken.description - schemas.ScanConfig.properties.authentication.description - schemas.ScanConfig.properties.blacklistPatterns.description - schemas.ScanConfig.properties.exportToSecurityCommandCenter.description - schemas.ScanConfig.properties.managedScan.description - schemas.ScanConfig.properties.maxQps.description - schemas.ScanConfig.properties.name.description - schemas.ScanConfig.properties.staticIpScan.description - schemas.ScanConfigError.description - schemas.ScanConfigError.properties.code.enumDescriptions - schemas.ScanConfigError.properties.fieldName.description - schemas.ScanRun.description - schemas.ScanRun.properties.endTime.description - schemas.ScanRun.properties.errorTrace.description - schemas.ScanRun.properties.executionState.enumDescriptions - schemas.ScanRun.properties.name.description - schemas.ScanRun.properties.progressPercent.description - schemas.ScanRun.properties.resultState.description - schemas.ScanRun.properties.resultState.enumDescriptions - schemas.ScanRun.properties.urlsCrawledCount.description - schemas.ScanRun.properties.urlsTestedCount.description - schemas.ScanRunErrorTrace.description - schemas.ScanRunErrorTrace.properties.code.enumDescriptions - schemas.ScanRunErrorTrace.properties.mostCommonHttpErrorCode.description - schemas.ScanRunErrorTrace.properties.scanConfigError.description - schemas.ScanRunWarningTrace.description - schemas.ScanRunWarningTrace.properties.code.enumDescriptions - schemas.Schedule.properties.scheduleTime.description - schemas.ViolatingResource.description - schemas.Xss.properties.attackVector.enumDescriptions * feat: regenerate index files --- .kokoro/populate-secrets.sh | 1 - discovery/apigee-v1.json | 1281 +++++++++++---------- discovery/cloudprofiler-v2.json | 44 +- discovery/container-v1beta1.json | 14 +- discovery/displayvideo-v1.json | 27 +- discovery/dlp-v2.json | 1129 +++++++++--------- discovery/gmail-v1.json | 419 ++++--- discovery/manufacturers-v1.json | 148 +-- discovery/oslogin-v1alpha.json | 40 +- discovery/people-v1.json | 50 +- discovery/playablelocations-v3.json | 104 +- discovery/vectortile-v1.json | 167 +-- discovery/vision-v1.json | 1012 ++++++++-------- discovery/vision-v1p1beta1.json | 878 +++++++------- discovery/vision-v1p2beta1.json | 878 +++++++------- discovery/websecurityscanner-v1.json | 195 ++-- discovery/websecurityscanner-v1alpha.json | 159 +-- discovery/websecurityscanner-v1beta.json | 201 ++-- src/apis/cloudprofiler/v2.ts | 11 +- src/apis/container/v1beta1.ts | 12 +- src/apis/displayvideo/v1.ts | 51 +- src/apis/dlp/v2.ts | 1016 ++++------------ src/apis/gmail/v1.ts | 521 +++++---- src/apis/manufacturers/v1.ts | 98 +- src/apis/oslogin/v1alpha.ts | 20 +- src/apis/people/v1.ts | 85 +- src/apis/playablelocations/v3.ts | 34 +- src/apis/vectortile/v1.ts | 194 +--- src/apis/vision/v1.ts | 620 ++++------ src/apis/vision/v1p1beta1.ts | 350 +++--- src/apis/vision/v1p2beta1.ts | 350 +++--- src/apis/websecurityscanner/v1.ts | 93 +- src/apis/websecurityscanner/v1alpha.ts | 93 +- src/apis/websecurityscanner/v1beta.ts | 93 +- 34 files changed, 4767 insertions(+), 5621 deletions(-) diff --git a/.kokoro/populate-secrets.sh b/.kokoro/populate-secrets.sh index e6ce8200d7..6f9d228859 100755 --- a/.kokoro/populate-secrets.sh +++ b/.kokoro/populate-secrets.sh @@ -32,7 +32,6 @@ do --volume=${KOKORO_GFILE_DIR}:${KOKORO_GFILE_DIR} \ gcr.io/google.com/cloudsdktool/cloud-sdk \ secrets versions access latest \ - --credential-file-override=${KOKORO_GFILE_DIR}/kokoro-trampoline.service-account.json \ --project cloud-devrel-kokoro-resources \ --secret $key > \ "$SECRET_LOCATION/$key" diff --git a/discovery/apigee-v1.json b/discovery/apigee-v1.json index bf72d66984..0bd5fc7a72 100644 --- a/discovery/apigee-v1.json +++ b/discovery/apigee-v1.json @@ -12,7 +12,7 @@ "baseUrl": "https://apigee.googleapis.com/", "batchPath": "batch", "canonicalName": "Apigee", - "description": "The Apigee API lets you programmatically manage Apigee hybrid with a set of RESTful operations, including:

For information on using the APIs described in this section, see Get started using the APIs.

Note: This product is available as a free trial for a time period of 60 days.", + "description": "The Apigee API lets you programmatically manage Apigee hybrid with a set of RESTful operations, including: - Create, edit, and delete API proxies - Manage users - Deploy and undeploy proxy revisions - Configure environments For information on using the APIs described in this section, see Get started using the APIs. *Note:* This product is available as a free trial for a time period of 60 days.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/apigee-api-management/", "fullyEncodeReservedExpansion": true, @@ -110,7 +110,7 @@ "issuers": { "methods": { "list": { - "description": "Lists hybrid services and its trusted issuers service account ids.\nThis api is authenticated and unauthorized(allow all the users) and used by\nruntime authn-authz service to query control plane's issuer service account\nids.", + "description": "Lists hybrid services and its trusted issuers service account ids. This api is authenticated and unauthorized(allow all the users) and used by runtime authn-authz service to query control plane's issuer service account ids.", "flatPath": "v1/hybrid/issuers", "httpMethod": "GET", "id": "apigee.hybrid.issuers.list", @@ -141,14 +141,14 @@ "organizations": { "methods": { "create": { - "description": "Creates an Apigee organization. See\n[Create an\norganization](https://docs.apigee.com/hybrid/latest/precog-provision).", + "description": "Creates an Apigee organization. See [Create an organization](https://docs.apigee.com/hybrid/latest/precog-provision).", "flatPath": "v1/organizations", "httpMethod": "POST", "id": "apigee.organizations.create", "parameterOrder": [], "parameters": { "parent": { - "description": "Required. Name of the GCP project in which to associate the Apigee organization.\nPass the information as a query parameter using the following structure\nin your request:\n `projects/`", + "description": "Required. Name of the GCP project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request: `projects/`", "location": "query", "type": "string" } @@ -165,7 +165,7 @@ ] }, "get": { - "description": "Gets the profile for an Apigee organization.\nSee\n[Organizations](https://docs.apigee.com/hybrid/latest/terminology#organizations).", + "description": "Gets the profile for an Apigee organization. See [Organizations](https://docs.apigee.com/hybrid/latest/terminology#organizations).", "flatPath": "v1/organizations/{organizationsId}", "httpMethod": "GET", "id": "apigee.organizations.get", @@ -174,7 +174,7 @@ ], "parameters": { "name": { - "description": "Required. Apigee organization name in the following format:\n `organizations/{org}`", + "description": "Required. Apigee organization name in the following format: `organizations/{org}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -199,7 +199,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the deployed configuration for the organization in the following\nformat: 'organizations/{org}/deployedIngressConfig'.", + "description": "Required. Name of the deployed configuration for the organization in the following format: 'organizations/{org}/deployedIngressConfig'.", "location": "path", "pattern": "^organizations/[^/]+/deployedIngressConfig$", "required": true, @@ -215,7 +215,7 @@ ] }, "getSyncAuthorization": { - "description": "Lists the service accounts with the permissions required to allow\nthe Synchronizer to download environment data from the control plane.\n\nAn ETag is returned in the response to `getSyncAuthorization`.\nPass that ETag when calling [setSyncAuthorization](setSyncAuthorization)\nto ensure that you are updating the correct version. If you don't pass the\nETag in the call to `setSyncAuthorization`, then the existing authorization\nis overwritten indiscriminately.\n\nFor more information, see\n[Enable Synchronizer\naccess](https://docs.apigee.com/hybrid/latest/synchronizer-access#enable-synchronizer-access).\n\n**Note**: Available to Apigee hybrid only.", + "description": "Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in the response to `getSyncAuthorization`. Pass that ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. For more information, see [Enable Synchronizer access](https://docs.apigee.com/hybrid/latest/synchronizer-access#enable-synchronizer-access). **Note**: Available to Apigee hybrid only.", "flatPath": "v1/organizations/{organizationsId}:getSyncAuthorization", "httpMethod": "POST", "id": "apigee.organizations.getSyncAuthorization", @@ -224,7 +224,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the Apigee organization. Use the following structure in your\nrequest:\n `organizations/{org}`", + "description": "Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -243,7 +243,7 @@ ] }, "list": { - "description": "Lists the Apigee organizations and associated GCP projects that you have\npermission to access. See\n[Organizations](https://docs.apigee.com/hybrid/latest/terminology#organizations).", + "description": "Lists the Apigee organizations and associated GCP projects that you have permission to access. See [Organizations](https://docs.apigee.com/hybrid/latest/terminology#organizations).", "flatPath": "v1/organizations", "httpMethod": "GET", "id": "apigee.organizations.list", @@ -252,7 +252,7 @@ ], "parameters": { "parent": { - "description": "Required. Use the following structure in your request:\n `organizations`", + "description": "Required. Use the following structure in your request: `organizations`", "location": "path", "pattern": "^organizations$", "required": true, @@ -268,7 +268,7 @@ ] }, "setSyncAuthorization": { - "description": "Sets the permissions required to allow the Synchronizer to download\nenvironment data from the control plane. You must call this API to enable\nproper functioning of hybrid.\n\nPass the ETag when calling `setSyncAuthorization` to ensure that\nyou are updating the correct version. To get an ETag,\ncall [getSyncAuthorization](getSyncAuthorization).\nIf you don't pass the ETag in the call to `setSyncAuthorization`, then the\nexisting authorization is overwritten indiscriminately.\n\nFor more information, see\n[Enable Synchronizer\naccess](https://docs.apigee.com/hybrid/latest/synchronizer-access#enable-synchronizer-access).\n\n**Note**: Available to Apigee hybrid only.", + "description": "Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid. Pass the ETag when calling `setSyncAuthorization` to ensure that you are updating the correct version. To get an ETag, call [getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. For more information, see [Enable Synchronizer access](https://docs.apigee.com/hybrid/latest/synchronizer-access#enable-synchronizer-access). **Note**: Available to Apigee hybrid only.", "flatPath": "v1/organizations/{organizationsId}:setSyncAuthorization", "httpMethod": "POST", "id": "apigee.organizations.setSyncAuthorization", @@ -277,7 +277,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the Apigee organization. Use the following structure in your\nrequest:\n `organizations/{org}`", + "description": "Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -296,7 +296,7 @@ ] }, "update": { - "description": "Updates the properties for an Apigee organization. No other fields in the\norganization profile will be updated.", + "description": "Updates the properties for an Apigee organization. No other fields in the organization profile will be updated.", "flatPath": "v1/organizations/{organizationsId}", "httpMethod": "PUT", "id": "apigee.organizations.update", @@ -305,7 +305,7 @@ ], "parameters": { "name": { - "description": "Required. Apigee organization name in the following format:\n `organizations/{org}`", + "description": "Required. Apigee organization name in the following format: `organizations/{org}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -339,7 +339,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent organization name.\nMust be of the form `organizations/{org}`.", + "description": "Required. The parent organization name. Must be of the form `organizations/{org}`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -367,7 +367,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the Datastore to be deleted. Must be of the\nform `organizations/{org}/analytics/datastores/{datastoreId}`", + "description": "Required. Resource name of the Datastore to be deleted. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}`", "location": "path", "pattern": "^organizations/[^/]+/analytics/datastores/[^/]+$", "required": true, @@ -392,7 +392,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the Datastore to be get. Must be of the\nform `organizations/{org}/analytics/datastores/{datastoreId}`", + "description": "Required. Resource name of the Datastore to be get. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}`", "location": "path", "pattern": "^organizations/[^/]+/analytics/datastores/[^/]+$", "required": true, @@ -417,7 +417,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent organization name.\nMust be of the form `organizations/{org}`.", + "description": "Required. The parent organization name. Must be of the form `organizations/{org}`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -438,7 +438,7 @@ ] }, "test": { - "description": "Test if Datastore configuration is correct. This includes checking\nif credentials provided by customer have required permissions in target\ndestination storage", + "description": "Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage", "flatPath": "v1/organizations/{organizationsId}/analytics/datastores:test", "httpMethod": "POST", "id": "apigee.organizations.analytics.datastores.test", @@ -447,7 +447,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent organization name\nMust be of the form `organizations/{org}`", + "description": "Required. The parent organization name Must be of the form `organizations/{org}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -475,7 +475,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of datastore to be updated. Must be of the\nform `organizations/{org}/analytics/datastores/{datastoreId}`", + "description": "Required. The resource name of datastore to be updated. Must be of the form `organizations/{org}/analytics/datastores/{datastoreId}`", "location": "path", "pattern": "^organizations/[^/]+/analytics/datastores/[^/]+$", "required": true, @@ -500,7 +500,7 @@ "apiproducts": { "methods": { "attributes": { - "description": "Updates or creates API product attributes. This API **replaces** the\ncurrent list of attributes with the attributes specified in the request\nbody. In this way, you can update existing attributes, add new attributes,\nor delete existing attributes by omitting them from the request body.\n\nOAuth access tokens and Key Management Service (KMS) entities (apps,\ndevelopers, and API products) are cached for 180 seconds (current default).\nAny custom attributes associated with entities also get cached for at least\n180 seconds after entity is accessed during runtime.\nIn this case, the `ExpiresIn` element on the OAuthV2 policy won't be able\nto expire an access token in less than 180 seconds.", + "description": "Updates or creates API product attributes. This API **replaces** the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", "flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes", "httpMethod": "POST", "id": "apigee.organizations.apiproducts.attributes", @@ -509,7 +509,7 @@ ], "parameters": { "name": { - "description": "**Required.** API product name in the following form:\n

organizations/organization_ID/apiproducts/api_product_name
", + "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name ", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -528,7 +528,7 @@ ] }, "create": { - "description": "Creates an API product in an organization.\nYou create API products after\nyou have proxied backend services using API proxies.\nAn API product is a\ncollection of API resources combined with quota settings and metadata that\nyou can use to deliver customized and productized API bundles to your\ndeveloper community. This metadata can include:\n\n- Scope\n- Environments\n- API proxies\n- Extensible profile\n\nAPI products enable you repackage APIs\non-the-fly, without having to do any additional coding or configuration.\nApigee recommends that you start with a simple API product including only\nrequired elements. You then provision credentials to apps to enable them to\nstart testing your APIs.\n\nAfter you have authentication and authorization\nworking against a simple API product, you can iterate to create finer\ngrained API products, defining different sets of API resources for each API\nproduct.\n\n\n\nFor more information, see {{what_api_product}}", + "description": "Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on-the-fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer grained API products, defining different sets of API resources for each API product. *WARNING:* - If you don't specify an API proxy in the request body, *any* app associated with the product can make calls to *any* API in your entire organization. - If you don't specify an environment in the request body, the product allows access to all environments. For more information, see {{what_api_product}}", "flatPath": "v1/organizations/{organizationsId}/apiproducts", "httpMethod": "POST", "id": "apigee.organizations.apiproducts.create", @@ -537,7 +537,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent organization name under which the API product will\nbe created. Must be in the following form:\n
organizations/organization_ID
", + "description": "Required. The parent organization name under which the API product will be created. Must be in the following form: organizations/organization_ID ", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -556,7 +556,7 @@ ] }, "delete": { - "description": "Deletes an API product from an organization.\n\nDeleting an API product\ncauses app requests to the resource URIs defined in the API product to\nfail.\n\nEnsure that you create a new API product to serve existing apps, unless\nyour intention is to disable access to the resources defined in the API\nproduct.\n\nThe API product name required in the request URL is the internal name of\nthe product, not the display name. While they may be the same, it depends\non whether the API product was created via the UI or the API. View the list\nof API products to verify the internal name.", + "description": "Deletes an API product from an organization. Deleting an API product causes app requests to the resource URIs defined in the API product to fail. Ensure that you create a new API product to serve existing apps, unless your intention is to disable access to the resources defined in the API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.", "flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}", "httpMethod": "DELETE", "id": "apigee.organizations.apiproducts.delete", @@ -565,7 +565,7 @@ ], "parameters": { "name": { - "description": "Required. API product name in the following form:\n
organizations/organization_ID/apiproducts/api_product_name
", + "description": "Required. API product name in the following form: organizations/organization_ID/apiproducts/api_product_name ", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -581,7 +581,7 @@ ] }, "get": { - "description": "Gets configuration details for an API product.\n\nThe API product name required in the request URL is the internal name of\nthe product, not the display name. While they may be the same, it depends\non whether the API product was created via the UI or the API. View the list\nof API products to verify the internal name.", + "description": "Gets configuration details for an API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.", "flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}", "httpMethod": "GET", "id": "apigee.organizations.apiproducts.get", @@ -590,7 +590,7 @@ ], "parameters": { "name": { - "description": "**Required.** API product name in the following form:\n
organizations/organization_ID/apiproducts/api_product_name
", + "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name ", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -606,7 +606,7 @@ ] }, "list": { - "description": "Lists all API product names for an organization.\nFilter the list by passing an `attributename` and `attibutevalue`.\n\nThe limit on the number of API products returned by the API is 1000. You\ncan paginate the list of API products returned using the `startKey` and\n`count` query parameters.", + "description": "Lists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The limit on the number of API products returned by the API is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters.", "flatPath": "v1/organizations/{organizationsId}/apiproducts", "httpMethod": "GET", "id": "apigee.organizations.apiproducts.list", @@ -625,7 +625,7 @@ "type": "string" }, "count": { - "description": "Enter the number of API products you want returned in the API call. The\nlimit is 1000.", + "description": "Enter the number of API products you want returned in the API call. The limit is 1000.", "format": "int64", "location": "query", "type": "string" @@ -636,14 +636,14 @@ "type": "boolean" }, "parent": { - "description": "**Required.** The parent organization name in the following form:\n
organizations/organization_ID
", + "description": "**Required.** The parent organization name in the following form: organizations/organization_ID ", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, "type": "string" }, "startKey": { - "description": "Gets a list of API products starting with a specific API product in the\nlist. For example, if you're returning 50 API products at a time (using the\n`count` query parameter), you can view products 50-99 by entering the name\nof the 50th API product in the first API (without using `startKey`).\nProduct name is case sensitive.", + "description": "Gets a list of API products starting with a specific API product in the list. For example, if you're returning 50 API products at a time (using the `count` query parameter), you can view products 50-99 by entering the name of the 50th API product in the first API (without using `startKey`). Product name is case sensitive.", "location": "query", "type": "string" } @@ -657,7 +657,7 @@ ] }, "update": { - "description": "Updates an existing API product. You must include all required values,\nwhether or not you are updating them, as well as any optional values that\nyou are updating.\n\nThe API product name required in the request URL is the\ninternal name of the product, not the Display Name. While they may be the\nsame, it depends on whether the API product was created via UI or API. View\nthe list of API products to identify their internal names.", + "description": "Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the Display Name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names.", "flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}", "httpMethod": "PUT", "id": "apigee.organizations.apiproducts.update", @@ -666,7 +666,7 @@ ], "parameters": { "name": { - "description": "**Required.** API product name in the following form:\n
organizations/organization_ID/apiproducts/api_product_name
", + "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name ", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -698,7 +698,7 @@ ], "parameters": { "name": { - "description": "**Required.** API product name in the following form:\n
organizations/organization_ID/apiproducts/api_product_name/attributes/attribute_name
", + "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name/attributes/attribute_name ", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$", "required": true, @@ -723,7 +723,7 @@ ], "parameters": { "name": { - "description": "**Required.** API product name in the following form:\n
organizations/organization_ID/apiproducts/api_product_name/attributes/attribute_name
", + "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name/attributes/attribute_name ", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$", "required": true, @@ -748,7 +748,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent organization name. Must be in the following form:\n
organizations/organization_ID/apiproducts/api_product_name
", + "description": "Required. The parent organization name. Must be in the following form: organizations/organization_ID/apiproducts/api_product_name ", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -764,7 +764,7 @@ ] }, "updateApiProductAttribute": { - "description": "Updates the value of an API product attribute. Limitations are:\n\nOAuth access tokens and Key Management Service (KMS) entities (apps,\ndevelopers, and API products) are cached for 180 seconds (current default).\nAny custom attributes associated with entities also get cached for at least\n180 seconds after entity is accessed during runtime.\nIn this case, the `ExpiresIn` element on the OAuthV2 policy won't be able\nto expire an access token in less than 180 seconds.", + "description": "Updates the value of an API product attribute. Limitations are: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", "flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}", "httpMethod": "POST", "id": "apigee.organizations.apiproducts.attributes.updateApiProductAttribute", @@ -773,7 +773,7 @@ ], "parameters": { "name": { - "description": "**Required.** API product name in the following form:\n
organizations/organization_ID/apiproducts/api_product_name
", + "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name ", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$", "required": true, @@ -798,7 +798,7 @@ "apis": { "methods": { "create": { - "description": "Creates an API proxy.\nThe API proxy created will not be accessible at runtime until it is\ndeployed to an environment.\n\nCreate a new API proxy by setting the `name` query parameter to the\nname of the API proxy.\n\nImport an API proxy configuration bundle stored in zip format\non your local machine to your organization by doing the following:\n\n* Set the `name` query parameter to the name of the API proxy.\n* Set the `action` query parameter to `import`.\n* Set the `Content-Type` header to `multipart/form-data`.\n* Pass as a file the name of API proxy\n configuration bundle stored in zip format on your local machine using\n the `file` form field.\n\n**Note**: To validate the API proxy configuration bundle only\n without importing it, set the `action` query\n parameter to `validate`.\n\nWhen importing an API proxy configuration bundle, if the API proxy\ndoes not exist, it will be created.\nIf the API proxy exists, then a new revision is created. Invalid API\nproxy configurations are rejected, and a list of validation errors is\nreturned to the client.", + "description": "Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the `name` query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: * Set the `name` query parameter to the name of the API proxy. * Set the `action` query parameter to `import`. * Set the `Content-Type` header to `multipart/form-data`. * Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the `file` form field. **Note**: To validate the API proxy configuration bundle only without importing it, set the `action` query parameter to `validate`. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.", "flatPath": "v1/organizations/{organizationsId}/apis", "httpMethod": "POST", "id": "apigee.organizations.apis.create", @@ -807,7 +807,7 @@ ], "parameters": { "action": { - "description": "Action to perform when importing an API proxy configuration bundle. Set\nthis parameter to one of the following values:\n\n* `import` to import the API proxy configuration bundle.\n* `validate` to validate the API proxy configuration bundle without\n importing it.", + "description": "Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * `import` to import the API proxy configuration bundle. * `validate` to validate the API proxy configuration bundle without importing it.", "location": "query", "type": "string" }, @@ -817,14 +817,14 @@ "type": "string" }, "parent": { - "description": "Required. Name of the organization in the following format:\n `organizations/{org}`", + "description": "Required. Name of the organization in the following format: `organizations/{org}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, "type": "string" }, "validate": { - "description": "Ignored. All uploads are validated regardless of the value of this\nfield. Maintained for compatibility with Apigee Edge API.", + "description": "Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.", "location": "query", "type": "boolean" } @@ -841,7 +841,7 @@ ] }, "delete": { - "description": "Deletes an API proxy and all associated endpoints, policies, resources, and\nrevisions. The API proxy must be undeployed before you can delete it.", + "description": "Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it.", "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}", "httpMethod": "DELETE", "id": "apigee.organizations.apis.delete", @@ -850,7 +850,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the API proxy in the following format:\n `organizations/{org}/apis/{api}`", + "description": "Required. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+$", "required": true, @@ -875,7 +875,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the API proxy in the following format:\n `organizations/{org}/apis/{api}`", + "description": "Required. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+$", "required": true, @@ -891,7 +891,7 @@ ] }, "list": { - "description": "Lists the names of all API proxies in an organization. The names returned\ncorrespond to the names defined in the configuration files for each API\nproxy.", + "description": "Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy.", "flatPath": "v1/organizations/{organizationsId}/apis", "httpMethod": "GET", "id": "apigee.organizations.apis.list", @@ -910,7 +910,7 @@ "type": "boolean" }, "parent": { - "description": "Required. Name of the organization in the following format:\n `organizations/{org}`", + "description": "Required. Name of the organization in the following format: `organizations/{org}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -939,7 +939,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the API proxy for which to return deployment information in the\nfollowing format:\n `organizations/{org}/apis/{api}`", + "description": "Required. Name of the API proxy for which to return deployment information in the following format: `organizations/{org}/apis/{api}`", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+$", "required": true, @@ -968,7 +968,7 @@ ], "parameters": { "parent": { - "description": "Required. The name of the environment in which to create the key value map.\nMust be of the form\n`organizations/{organization}/apis/{api}`.", + "description": "Required. The name of the environment in which to create the key value map. Must be of the form `organizations/{organization}/apis/{api}`.", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+$", "required": true, @@ -996,7 +996,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the key value map.\nMust be of the form\n`organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`.", + "description": "Required. The name of the key value map. Must be of the form `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`.", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+/keyvaluemaps/[^/]+$", "required": true, @@ -1016,7 +1016,7 @@ "revisions": { "methods": { "delete": { - "description": "Deletes an API proxy revision and all policies, resources, endpoints,\nand revisions associated with it. The API proxy revision must be undeployed\nbefore you can delete it.", + "description": "Deletes an API proxy revision and all policies, resources, endpoints, and revisions associated with it. The API proxy revision must be undeployed before you can delete it.", "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}", "httpMethod": "DELETE", "id": "apigee.organizations.apis.revisions.delete", @@ -1025,7 +1025,7 @@ ], "parameters": { "name": { - "description": "Required. API proxy revision in the following format:\n `organizations/{org}/apis/{api}/revisions/{rev}`", + "description": "Required. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, @@ -1041,7 +1041,7 @@ ] }, "get": { - "description": "Gets an API proxy revision.\n\nTo download the API proxy configuration bundle for the specified revision\nas a zip file, do the following:\n\n * Set the `format` query parameter to `bundle`.\n * Set the `Accept` header to `application/zip`.\n\nIf you are using curl, specify `-o filename.zip` to save the output to a\nfile; otherwise, it displays to `stdout`. Then, develop the API proxy\nconfiguration locally and upload the updated API proxy configuration\nrevision, as described in\n[updateApiProxyRevision](updateApiProxyRevision).", + "description": "Gets an API proxy revision. To download the API proxy configuration bundle for the specified revision as a zip file, do the following: * Set the `format` query parameter to `bundle`. * Set the `Accept` header to `application/zip`. If you are using curl, specify `-o filename.zip` to save the output to a file; otherwise, it displays to `stdout`. Then, develop the API proxy configuration locally and upload the updated API proxy configuration revision, as described in [updateApiProxyRevision](updateApiProxyRevision).", "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}", "httpMethod": "GET", "id": "apigee.organizations.apis.revisions.get", @@ -1050,12 +1050,12 @@ ], "parameters": { "format": { - "description": "Format used when downloading the API proxy configuration revision.\nSet to `bundle` to download the API proxy configuration revision as a zip\nfile.", + "description": "Format used when downloading the API proxy configuration revision. Set to `bundle` to download the API proxy configuration revision as a zip file.", "location": "query", "type": "string" }, "name": { - "description": "Required. API proxy revision in the following format:\n `organizations/{org}/apis/{api}/revisions/{rev}`", + "description": "Required. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, @@ -1071,7 +1071,7 @@ ] }, "updateApiProxyRevision": { - "description": "Updates an existing API proxy revision by uploading the API proxy\nconfiguration bundle as a zip file from your local machine.\n\nYou can update only API proxy revisions\nthat have never been deployed. After deployment, an API proxy revision\nbecomes immutable, even if it is undeployed.\n\nSet the `Content-Type` header to either\n`multipart/form-data` or `application/octet-stream`.", + "description": "Updates an existing API proxy revision by uploading the API proxy configuration bundle as a zip file from your local machine. You can update only API proxy revisions that have never been deployed. After deployment, an API proxy revision becomes immutable, even if it is undeployed. Set the `Content-Type` header to either `multipart/form-data` or `application/octet-stream`.", "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}", "httpMethod": "POST", "id": "apigee.organizations.apis.revisions.updateApiProxyRevision", @@ -1080,14 +1080,14 @@ ], "parameters": { "name": { - "description": "Required. API proxy revision to update in the following format:\n `organizations/{org}/apis/{api}/revisions/{rev}`", + "description": "Required. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, "type": "string" }, "validate": { - "description": "Ignored. All uploads are validated regardless of the value of this field.\nMaintained for compatibility with Apigee Edge API.", + "description": "Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.", "location": "query", "type": "boolean" } @@ -1117,7 +1117,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the API proxy revision for which to return deployment information\nin the following format:\n `organizations/{org}/apis/{api}/revisions/{rev}`.", + "description": "Required. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`.", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, @@ -1150,7 +1150,7 @@ ], "parameters": { "name": { - "description": "Required. App ID in the following format:\n `organizations/{org}/apps/{app}`", + "description": "Required. App ID in the following format: `organizations/{org}/apps/{app}`", "location": "path", "pattern": "^organizations/[^/]+/apps/[^/]+$", "required": true, @@ -1166,7 +1166,7 @@ ] }, "list": { - "description": "Lists IDs of apps within an organization that have the specified app status\n(approved or revoked) or are of the specified app type\n(developer or company).", + "description": "Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company).", "flatPath": "v1/organizations/{organizationsId}/apps", "httpMethod": "GET", "id": "apigee.organizations.apps.list", @@ -1180,12 +1180,12 @@ "type": "string" }, "apptype": { - "description": "Optional. Filter by the type of the app. Valid values are `company` or\n`developer`. Defaults to `developer`.", + "description": "Optional. Filter by the type of the app. Valid values are `company` or `developer`. Defaults to `developer`.", "location": "query", "type": "string" }, "expand": { - "description": "Optional. Flag that specifies whether to return an expanded list of\napps for the organization. Defaults to `false`.", + "description": "Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to `false`.", "location": "query", "type": "boolean" }, @@ -1195,17 +1195,17 @@ "type": "string" }, "includeCred": { - "description": "Optional. Flag that specifies whether to include credentials in the\nresponse.", + "description": "Optional. Flag that specifies whether to include credentials in the response.", "location": "query", "type": "boolean" }, "keyStatus": { - "description": "Optional. Key status of the app. Valid values include `approved` or\n`revoked`. Defaults to `approved`.", + "description": "Optional. Key status of the app. Valid values include `approved` or `revoked`. Defaults to `approved`.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Resource path of the parent in the following format:\n `organizations/{org}`", + "description": "Required. Resource path of the parent in the following format: `organizations/{org}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -1223,7 +1223,7 @@ "type": "string" }, "status": { - "description": "Optional. Filter by the status of the app. Valid values are `approved`\nor `revoked`. Defaults to `approved`.", + "description": "Optional. Filter by the status of the app. Valid values are `approved` or `revoked`. Defaults to `approved`.", "location": "query", "type": "string" } @@ -1250,14 +1250,14 @@ ], "parameters": { "parent": { - "description": "Required. Name of the organization for which to return deployment information in the\nfollowing format:\n `organizations/{org}`", + "description": "Required. Name of the organization for which to return deployment information in the following format: `organizations/{org}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, "type": "string" }, "sharedFlows": { - "description": "Optional. Flag that specifies whether to return shared flow or API proxy deployments.\nSet to `true` to return shared flow deployments; set to `false`\nto return API proxy deployments. Defaults to `false`.", + "description": "Optional. Flag that specifies whether to return shared flow or API proxy deployments. Set to `true` to return shared flow deployments; set to `false` to return API proxy deployments. Defaults to `false`.", "location": "query", "type": "boolean" } @@ -1275,7 +1275,7 @@ "developers": { "methods": { "attributes": { - "description": "Updates developer attributes.\n\nThis API replaces the\nexisting attributes with those specified in the request.\nAdd new attributes, and include or exclude any existing\nattributes that you want to retain or\nremove, respectively.\n\nThe custom attribute limit is 18.\n\n**Note**: OAuth access tokens and Key Management Service (KMS) entities\n(apps, developers, and API products) are cached for 180 seconds\n(default). Any custom attributes associated with these entities\nare cached for at least 180 seconds after the entity is accessed at\nruntime. Therefore, an `ExpiresIn` element on the OAuthV2 policy\nwon't be able to expire an access token in less than 180 seconds.", + "description": "Updates developer attributes. This API replaces the existing attributes with those specified in the request. Add new attributes, and include or exclude any existing attributes that you want to retain or remove, respectively. The custom attribute limit is 18. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/attributes", "httpMethod": "POST", "id": "apigee.organizations.developers.attributes", @@ -1284,7 +1284,7 @@ ], "parameters": { "parent": { - "description": "Required. Email address of the developer for which attributes are being updated in\nthe following format:\n `organizations/{org}/developers/{developer_email}`", + "description": "Required. Email address of the developer for which attributes are being updated in the following format: `organizations/{org}/developers/{developer_email}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+$", "required": true, @@ -1303,7 +1303,7 @@ ] }, "create": { - "description": "Creates a developer. Once created,\nthe developer can register an app and obtain an API key.\n\nAt creation time, a developer is set as `active`. To change the developer\nstatus, use the SetDeveloperStatus API.", + "description": "Creates a developer. Once created, the developer can register an app and obtain an API key. At creation time, a developer is set as `active`. To change the developer status, use the SetDeveloperStatus API.", "flatPath": "v1/organizations/{organizationsId}/developers", "httpMethod": "POST", "id": "apigee.organizations.developers.create", @@ -1312,7 +1312,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the Apigee organization in which the developer is created.\nUse the following structure in your request:\n `organizations/{org}`.", + "description": "Required. Name of the Apigee organization in which the developer is created. Use the following structure in your request: `organizations/{org}`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -1331,7 +1331,7 @@ ] }, "delete": { - "description": "Deletes a developer. All apps and API keys associated\nwith the developer are also removed.\n\n**Warning**: This API will permanently delete the developer\nand related artifacts.\n\nTo avoid permanently deleting developers and their artifacts,\nset the developer status to `inactive` using\nthe SetDeveloperStatus API.\n\n**Note**: The delete operation is asynchronous. The developer app is\ndeleted immediately,\nbut its associated resources, such as apps and API keys, may take anywhere\nfrom a few seconds to a few minutes to be deleted.", + "description": "Deletes a developer. All apps and API keys associated with the developer are also removed. **Warning**: This API will permanently delete the developer and related artifacts. To avoid permanently deleting developers and their artifacts, set the developer status to `inactive` using the SetDeveloperStatus API. **Note**: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}", "httpMethod": "DELETE", "id": "apigee.organizations.developers.delete", @@ -1340,7 +1340,7 @@ ], "parameters": { "name": { - "description": "Required. Email address of the developer. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}`", + "description": "Required. Email address of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+$", "required": true, @@ -1356,7 +1356,7 @@ ] }, "get": { - "description": "Returns the developer details, including the\ndeveloper's name, email address, apps, and other information.\n\n**Note**: The response includes only the first 100 developer apps.", + "description": "Returns the developer details, including the developer's name, email address, apps, and other information. **Note**: The response includes only the first 100 developer apps.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}", "httpMethod": "GET", "id": "apigee.organizations.developers.get", @@ -1370,7 +1370,7 @@ "type": "string" }, "name": { - "description": "Required. Email address of the developer. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}`", + "description": "Required. Email address of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+$", "required": true, @@ -1386,7 +1386,7 @@ ] }, "list": { - "description": "Lists all developers in an organization by email address.\n\nBy default,\nthe response does not include company developers. Set the `includeCompany`\nquery parameter to `true` to include company developers.\n\n**Note**: A maximum of 1000 developers are returned in the response. You\npaginate the list of developers returned using the `startKey` and `count`\nquery parameters.", + "description": "Lists all developers in an organization by email address. By default, the response does not include company developers. Set the `includeCompany` query parameter to `true` to include company developers. **Note**: A maximum of 1000 developers are returned in the response. You paginate the list of developers returned using the `startKey` and `count` query parameters.", "flatPath": "v1/organizations/{organizationsId}/developers", "httpMethod": "GET", "id": "apigee.organizations.developers.list", @@ -1395,13 +1395,13 @@ ], "parameters": { "count": { - "description": "Optional. Number of developers to return in the API call. Use with the `startKey`\nparameter to provide more targeted filtering.\nThe limit is 1000.", + "description": "Optional. Number of developers to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The limit is 1000.", "format": "int64", "location": "query", "type": "string" }, "expand": { - "description": "Specifies whether to expand the results. Set to `true`\nto expand the results. This query parameter is not valid if you use\nthe `count` or `startKey` query parameters.", + "description": "Specifies whether to expand the results. Set to `true` to expand the results. This query parameter is not valid if you use the `count` or `startKey` query parameters.", "location": "query", "type": "boolean" }, @@ -1416,14 +1416,14 @@ "type": "boolean" }, "parent": { - "description": "Required. Name of the Apigee organization. Use the following structure in your\nrequest:\n `organizations/{org}`.", + "description": "Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, "type": "string" }, "startKey": { - "description": "**Note**: Must be used in conjunction with the `count` parameter.\n\nEmail address of the developer from which to start displaying the list of\ndevelopers. For example, if the an unfiltered list returns:\n\n```\nwestley@example.com\nfezzik@example.com\nbuttercup@example.com\n```\n\nand your `startKey` is `fezzik@example.com`, the list returned will be\n\n```\nfezzik@example.com\nbuttercup@example.com\n```", + "description": "**Note**: Must be used in conjunction with the `count` parameter. Email address of the developer from which to start displaying the list of developers. For example, if the an unfiltered list returns: ``` westley@example.com fezzik@example.com buttercup@example.com ``` and your `startKey` is `fezzik@example.com`, the list returned will be ``` fezzik@example.com buttercup@example.com ```", "location": "query", "type": "string" } @@ -1437,7 +1437,7 @@ ] }, "setDeveloperStatus": { - "description": "Sets the status of a developer. Valid values are `active` or `inactive`.\n\nA developer is `active` by default. If you set a developer's status to\n`inactive`, the API keys assigned to the developer apps are no longer valid\neven though the API keys are set to `approved`. Inactive developers\ncan still sign in to the developer portal and create apps; however, any\nnew API keys generated during app creation won't work.\n\nIf successful, the API call returns the\nfollowing HTTP status code: `204 No Content`", + "description": "Sets the status of a developer. Valid values are `active` or `inactive`. A developer is `active` by default. If you set a developer's status to `inactive`, the API keys assigned to the developer apps are no longer valid even though the API keys are set to `approved`. Inactive developers can still sign in to the developer portal and create apps; however, any new API keys generated during app creation won't work. If successful, the API call returns the following HTTP status code: `204 No Content`", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}", "httpMethod": "POST", "id": "apigee.organizations.developers.setDeveloperStatus", @@ -1451,7 +1451,7 @@ "type": "string" }, "name": { - "description": "Required. Email address of the developer. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}`", + "description": "Required. Email address of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+$", "required": true, @@ -1467,7 +1467,7 @@ ] }, "update": { - "description": "Updates a developer.\n\nThis API replaces the existing developer details with those specified\nin the request. Include or exclude any existing details that\nyou want to retain or delete, respectively.\n\nThe custom attribute limit is 18.\n\n**Note**: OAuth access tokens and Key Management Service (KMS) entities\n(apps, developers, and API products) are cached for 180 seconds\n(current default). Any custom attributes associated with these entities\nare cached for at least 180 seconds after the entity is accessed at\nruntime. Therefore, an `ExpiresIn` element on the OAuthV2 policy\nwon't be able to expire an access token in less than 180 seconds.", + "description": "Updates a developer. This API replaces the existing developer details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. The custom attribute limit is 18. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}", "httpMethod": "PUT", "id": "apigee.organizations.developers.update", @@ -1476,7 +1476,7 @@ ], "parameters": { "name": { - "description": "Required. Email address of the developer. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}`", + "description": "Required. Email address of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+$", "required": true, @@ -1499,7 +1499,7 @@ "apps": { "methods": { "attributes": { - "description": "Updates attributes for a developer app. This API replaces the\ncurrent attributes with those specified in the request.", + "description": "Updates attributes for a developer app. This API replaces the current attributes with those specified in the request.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes", "httpMethod": "POST", "id": "apigee.organizations.developers.apps.attributes", @@ -1508,7 +1508,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the developer app. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}`", + "description": "Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$", "required": true, @@ -1527,7 +1527,7 @@ ] }, "create": { - "description": "Creates an app associated with a developer. This API associates the\ndeveloper app with the specified API\nproduct and auto-generates an API key for the app to use in calls to API\nproxies inside that API product.\n\nThe `name` is the unique ID of the app\nthat you can use in API calls. The `DisplayName` (set as an\nattribute) appears in the UI. If you don't set the\n`DisplayName` attribute, the `name` appears in the UI.", + "description": "Creates an app associated with a developer. This API associates the developer app with the specified API product and auto-generates an API key for the app to use in calls to API proxies inside that API product. The `name` is the unique ID of the app that you can use in API calls. The `DisplayName` (set as an attribute) appears in the UI. If you don't set the `DisplayName` attribute, the `name` appears in the UI.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps", "httpMethod": "POST", "id": "apigee.organizations.developers.apps.create", @@ -1536,7 +1536,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the developer. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}`", + "description": "Required. Name of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+$", "required": true, @@ -1555,7 +1555,7 @@ ] }, "delete": { - "description": "Deletes a developer app.\n\n**Note**: The delete operation is asynchronous. The developer app is\ndeleted immediately,\nbut its associated resources, such as app\nkeys or access tokens, may take anywhere from a few seconds to a\nfew minutes to be deleted.", + "description": "Deletes a developer app. **Note**: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}", "httpMethod": "DELETE", "id": "apigee.organizations.developers.apps.delete", @@ -1564,7 +1564,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the developer app. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}`", + "description": "Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$", "required": true, @@ -1580,7 +1580,7 @@ ] }, "generateKeyPairOrUpdateDeveloperAppStatus": { - "description": "Manages access to a developer app by enabling you to:\n\n* Approve or revoke a developer app\n* Generate a new consumer key and secret for a developer app\n\nTo approve or revoke a developer app, set the `action` query parameter to\n`approved` or `revoked`, respectively, and the\n`Content-Type` header to `application/octet-stream`. If a developer app is\nrevoked, none of its API keys are valid for API calls even though\nthe keys are still `approved`. If successful, the API call returns the\nfollowing HTTP status code: `204 No Content`\n\nTo generate a new consumer key and secret for a developer\napp, pass the new key/secret details. Rather than\nreplace an existing key, this API generates a new\nkey. In this case, multiple key\npairs may be associated with a single developer app. Each key pair has an\nindependent status (`approved` or `revoked`) and expiration time.\nAny approved, non-expired key can be used in an API call.\n\nFor example, if you're using API key rotation, you can generate new\nkeys with expiration times that overlap keys that are going to expire.\nYou might also generate a new consumer key/secret if the security of the\noriginal key/secret is compromised.\n\nThe `keyExpiresIn` property defines the\nexpiration time for the API key in milliseconds. If you don't set\nthis property or set it to `-1`, the API key never expires.\n\n**Notes**:\n\n* When generating a new key/secret, this API replaces the\nexisting attributes, notes, and callback URLs with those specified in the\nrequest. Include or exclude any existing information that you want to\nretain or delete, respectively.\n* To migrate existing consumer keys and secrets to hybrid from another\nsystem, see the\nCreateDeveloperAppKey API.", + "description": "Manages access to a developer app by enabling you to: * Approve or revoke a developer app * Generate a new consumer key and secret for a developer app To approve or revoke a developer app, set the `action` query parameter to `approved` or `revoked`, respectively, and the `Content-Type` header to `application/octet-stream`. If a developer app is revoked, none of its API keys are valid for API calls even though the keys are still `approved`. If successful, the API call returns the following HTTP status code: `204 No Content` To generate a new consumer key and secret for a developer app, pass the new key/secret details. Rather than replace an existing key, this API generates a new key. In this case, multiple key pairs may be associated with a single developer app. Each key pair has an independent status (`approved` or `revoked`) and expiration time. Any approved, non-expired key can be used in an API call. For example, if you're using API key rotation, you can generate new keys with expiration times that overlap keys that are going to expire. You might also generate a new consumer key/secret if the security of the original key/secret is compromised. The `keyExpiresIn` property defines the expiration time for the API key in milliseconds. If you don't set this property or set it to `-1`, the API key never expires. **Notes**: * When generating a new key/secret, this API replaces the existing attributes, notes, and callback URLs with those specified in the request. Include or exclude any existing information that you want to retain or delete, respectively. * To migrate existing consumer keys and secrets to hybrid from another system, see the CreateDeveloperAppKey API.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}", "httpMethod": "POST", "id": "apigee.organizations.developers.apps.generateKeyPairOrUpdateDeveloperAppStatus", @@ -1594,7 +1594,7 @@ "type": "string" }, "name": { - "description": "Required. Name of the developer app. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}`", + "description": "Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$", "required": true, @@ -1622,19 +1622,19 @@ ], "parameters": { "entity": { - "description": "**Note**: Must be used in conjunction with the `query` parameter.\n\nSet to `apiresources`\nto return the number of API resources\nthat have been approved for access by a developer app in the\nspecified Apigee organization.", + "description": "**Note**: Must be used in conjunction with the `query` parameter. Set to `apiresources` to return the number of API resources that have been approved for access by a developer app in the specified Apigee organization.", "location": "query", "type": "string" }, "name": { - "description": "Required. Name of the developer app. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}`", + "description": "Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$", "required": true, "type": "string" }, "query": { - "description": "**Note**: Must be used in conjunction with the `entity` parameter.\n\nSet to `count` to return the number of API resources\nthat have been approved for access by a developer app in the\nspecified Apigee organization.", + "description": "**Note**: Must be used in conjunction with the `entity` parameter. Set to `count` to return the number of API resources that have been approved for access by a developer app in the specified Apigee organization.", "location": "query", "type": "string" } @@ -1648,7 +1648,7 @@ ] }, "list": { - "description": "Lists all apps created by a developer in an Apigee organization.\nOptionally, you can request an expanded view of the developer apps.\n\nA maximum of 100 developer apps are returned per API call. You can paginate\nthe list of deveoper apps returned using the `startKey` and `count` query\nparameters.", + "description": "Lists all apps created by a developer in an Apigee organization. Optionally, you can request an expanded view of the developer apps. A maximum of 100 developer apps are returned per API call. You can paginate the list of deveoper apps returned using the `startKey` and `count` query parameters.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps", "httpMethod": "GET", "id": "apigee.organizations.developers.apps.list", @@ -1657,30 +1657,30 @@ ], "parameters": { "count": { - "description": "Number of developer apps to return in the API call. Use with the `startKey`\nparameter to provide more targeted filtering.\nThe limit is 1000.", + "description": "Number of developer apps to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The limit is 1000.", "format": "int64", "location": "query", "type": "string" }, "expand": { - "description": "Optional. Specifies whether to expand the results. Set to `true`\nto expand the results. This query parameter is not valid if you use\nthe `count` or `startKey` query parameters.", + "description": "Optional. Specifies whether to expand the results. Set to `true` to expand the results. This query parameter is not valid if you use the `count` or `startKey` query parameters.", "location": "query", "type": "boolean" }, "parent": { - "description": "Required. Name of the developer. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}`", + "description": "Required. Name of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+$", "required": true, "type": "string" }, "shallowExpand": { - "description": "Optional. Specifies whether to expand the results in shallow mode.\nSet to `true` to expand the results in shallow mode.", + "description": "Optional. Specifies whether to expand the results in shallow mode. Set to `true` to expand the results in shallow mode.", "location": "query", "type": "boolean" }, "startKey": { - "description": "**Note**: Must be used in conjunction with the `count` parameter.\n\nName of the developer app from which to start displaying the list of\ndeveloper apps. For example, if you're returning 50 developer apps at\na time (using the `count` query parameter), you can view developer apps\n50-99 by entering the name of the 50th developer app.\nThe developer app name is case sensitive.", + "description": "**Note**: Must be used in conjunction with the `count` parameter. Name of the developer app from which to start displaying the list of developer apps. For example, if you're returning 50 developer apps at a time (using the `count` query parameter), you can view developer apps 50-99 by entering the name of the 50th developer app. The developer app name is case sensitive.", "location": "query", "type": "string" } @@ -1694,7 +1694,7 @@ ] }, "update": { - "description": "Updates the details for a developer app. In addition, you can\nadd an API product to a developer app and automatically generate\nan API key for the app to use when calling APIs in the API product.\n\nIf you want to use an existing API key for the API product,\nadd the API product to the API key using the\nUpdateDeveloperAppKey\nAPI.\n\nUsing this API, you cannot update the following:\n\n* App name as it is the primary key used to identify the app and cannot\n be changed.\n* Scopes associated with the app. Instead, use the\n ReplaceDeveloperAppKey API.\n\nThis API replaces the\nexisting attributes with those specified in the request.\nInclude or exclude any existing attributes that you want to retain or\ndelete, respectively.", + "description": "Updates the details for a developer app. In addition, you can add an API product to a developer app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateDeveloperAppKey API. Using this API, you cannot update the following: * App name as it is the primary key used to identify the app and cannot be changed. * Scopes associated with the app. Instead, use the ReplaceDeveloperAppKey API. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}", "httpMethod": "PUT", "id": "apigee.organizations.developers.apps.update", @@ -1703,7 +1703,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the developer app. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}`", + "description": "Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$", "required": true, @@ -1735,7 +1735,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the developer app attribute. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}`", + "description": "Required. Name of the developer app attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/attributes/[^/]+$", "required": true, @@ -1760,7 +1760,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the developer app attribute. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}`", + "description": "Required. Name of the developer app attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/attributes/[^/]+$", "required": true, @@ -1785,7 +1785,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the developer app. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}`", + "description": "Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$", "required": true, @@ -1801,7 +1801,7 @@ ] }, "updateDeveloperAppAttribute": { - "description": "Updates a developer app attribute.\n\n**Note**: OAuth access tokens and Key Management Service (KMS) entities\n(apps, developers, and API products) are cached for 180 seconds\n(current default). Any custom attributes associated with these entities\nare cached for at least 180 seconds after the entity is accessed at\nruntime. Therefore, an `ExpiresIn` element on the OAuthV2 policy\nwon't be able to expire an access token in less than 180 seconds.", + "description": "Updates a developer app attribute. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}", "httpMethod": "POST", "id": "apigee.organizations.developers.apps.attributes.updateDeveloperAppAttribute", @@ -1810,7 +1810,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the developer app attribute. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}`", + "description": "Required. Name of the developer app attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/attributes/[^/]+$", "required": true, @@ -1833,7 +1833,7 @@ "keys": { "methods": { "create": { - "description": "Creates a custom consumer key and secret for a developer app. This is\nparticularly useful if you want to migrate existing consumer keys and\nsecrets to Apigee hybrid from another system.\n\nConsumer keys and secrets can contain letters, numbers, underscores, and\nhyphens. No other special characters are allowed. To avoid service\ndisruptions, a consumer key and secret should not exceed 2 KBs each.\n\n**Note**: When creating the consumer key and secret, an association to\nAPI products will not be made. Therefore, you should not specify the\nassociated API products in your request. Instead, use the\nUpdateDeveloperAppKey API to\nmake the association after the consumer key and secret are created.\n\nIf a consumer key and secret already exist, you can keep them or\ndelete them using the\nDeleteDeveloperAppKey API.", + "description": "Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee hybrid from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys", "httpMethod": "POST", "id": "apigee.organizations.developers.apps.keys.create", @@ -1842,7 +1842,7 @@ ], "parameters": { "parent": { - "description": "Parent of the developer app key. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}/apps`", + "description": "Parent of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$", "required": true, @@ -1861,7 +1861,7 @@ ] }, "delete": { - "description": "Deletes an app's consumer key and removes all API products\nassociated with the app. After the consumer key is deleted,\nit cannot be used to access any APIs.\n\n**Note**: After you delete a consumer key, you may want to:\n1. Create a new consumer key and secret for the developer app using the\nCreateDeveloperAppKey API, and\nsubsequently add an API product to the key using the\nUpdateDeveloperAppKey API.\n2. Delete the developer app, if it is no longer required.", + "description": "Deletes an app's consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs. **Note**: After you delete a consumer key, you may want to: 1. Create a new consumer key and secret for the developer app using the CreateDeveloperAppKey API, and subsequently add an API product to the key using the UpdateDeveloperAppKey API. 2. Delete the developer app, if it is no longer required.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}", "httpMethod": "DELETE", "id": "apigee.organizations.developers.apps.keys.delete", @@ -1870,7 +1870,7 @@ ], "parameters": { "name": { - "description": "Name of the developer app key. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`", + "description": "Name of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+$", "required": true, @@ -1886,7 +1886,7 @@ ] }, "get": { - "description": "Returns details for a consumer key for a developer app, including the key\nand secret value, associated API products, and other information.", + "description": "Returns details for a consumer key for a developer app, including the key and secret value, associated API products, and other information.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}", "httpMethod": "GET", "id": "apigee.organizations.developers.apps.keys.get", @@ -1895,7 +1895,7 @@ ], "parameters": { "name": { - "description": "Name of the developer app key. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`", + "description": "Name of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+$", "required": true, @@ -1911,7 +1911,7 @@ ] }, "replaceDeveloperAppKey": { - "description": "Updates the scope of an app.\n\nThis API replaces the\nexisting scopes with those specified in the request.\nInclude or exclude any existing scopes that you want to retain or\ndelete, respectively. The specified scopes must already\nbe defined for the API products associated with the app.\n\nThis API sets the `scopes` element\nunder the `apiProducts` element in the attributes of the app.", + "description": "Updates the scope of an app. This API replaces the existing scopes with those specified in the request. Include or exclude any existing scopes that you want to retain or delete, respectively. The specified scopes must already be defined for the API products associated with the app. This API sets the `scopes` element under the `apiProducts` element in the attributes of the app.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}", "httpMethod": "PUT", "id": "apigee.organizations.developers.apps.keys.replaceDeveloperAppKey", @@ -1920,7 +1920,7 @@ ], "parameters": { "name": { - "description": "Name of the developer app key. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`", + "description": "Name of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+$", "required": true, @@ -1939,7 +1939,7 @@ ] }, "updateDeveloperAppKey": { - "description": "Adds an API product to a developer app key, enabling the app that holds\nthe key to access the API resources bundled in the API product.\n\nIn addition, you can add\nattributes to a developer app key. This API replaces the\nexisting attributes with those specified in the request.\nInclude or exclude any existing attributes that you want to retain or\ndelete, respectively.\n\nYou can use the same key to access all API products\nassociated with the app.", + "description": "Adds an API product to a developer app key, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes to a developer app key. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. You can use the same key to access all API products associated with the app.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}", "httpMethod": "POST", "id": "apigee.organizations.developers.apps.keys.updateDeveloperAppKey", @@ -1948,12 +1948,12 @@ ], "parameters": { "action": { - "description": "Approve or revoke the consumer key by setting this value to\n`approve` or `revoke`, respectively.", + "description": "Approve or revoke the consumer key by setting this value to `approve` or `revoke`, respectively.", "location": "query", "type": "string" }, "name": { - "description": "Name of the developer app key. Use the following structure in your request:\n `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`", + "description": "Name of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+$", "required": true, @@ -1976,7 +1976,7 @@ "apiproducts": { "methods": { "delete": { - "description": "Removes an API product from an app's consumer key. After the API product is\nremoved, the app cannot access the API resources defined in\nthat API product.\n\n**Note**: The consumer key is not removed, only its association with the\nAPI product.", + "description": "Removes an API product from an app's consumer key. After the API product is removed, the app cannot access the API resources defined in that API product. **Note**: The consumer key is not removed, only its association with the API product.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}", "httpMethod": "DELETE", "id": "apigee.organizations.developers.apps.keys.apiproducts.delete", @@ -1985,7 +1985,7 @@ ], "parameters": { "name": { - "description": "Name of the API product in the developer app key in the following\nformat:\n `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}/apiproducts/{apiproduct}`", + "description": "Name of the API product in the developer app key in the following format: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}/apiproducts/{apiproduct}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+/apiproducts/[^/]+$", "required": true, @@ -2001,7 +2001,7 @@ ] }, "updateDeveloperAppKeyApiProduct": { - "description": "Approve or revoke an app's consumer key. After a consumer key is approved,\nthe app can use it to access APIs.\n\nA consumer key that is revoked or pending cannot be used to access an API.\nAny access tokens associated with a revoked consumer key will remain\nactive. However, Apigee hybrid checks the status of the consumer key and\nif set to `revoked` will not allow access to the API.", + "description": "Approve or revoke an app's consumer key. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee hybrid checks the status of the consumer key and if set to `revoked` will not allow access to the API.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}", "httpMethod": "POST", "id": "apigee.organizations.developers.apps.keys.apiproducts.updateDeveloperAppKeyApiProduct", @@ -2010,12 +2010,12 @@ ], "parameters": { "action": { - "description": "Approve or revoke the consumer key by setting this value to\n`approve` or `revoke`, respectively.", + "description": "Approve or revoke the consumer key by setting this value to `approve` or `revoke`, respectively.", "location": "query", "type": "string" }, "name": { - "description": "Name of the API product in the developer app key in the following\nformat:\n `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}/apiproducts/{apiproduct}`", + "description": "Name of the API product in the developer app key in the following format: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}/apiproducts/{apiproduct}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+/keys/[^/]+/apiproducts/[^/]+$", "required": true, @@ -2035,7 +2035,7 @@ "create": { "methods": { "create": { - "description": "Creates a custom consumer key and secret for a developer app. This is\nparticularly useful if you want to migrate existing consumer keys and\nsecrets to Apigee hybrid from another system.\n\nConsumer keys and secrets can contain letters, numbers, underscores, and\nhyphens. No other special characters are allowed. To avoid service\ndisruptions, a consumer key and secret should not exceed 2 KBs each.\n\n**Note**: When creating the consumer key and secret, an association to\nAPI products will not be made. Therefore, you should not specify the\nassociated API products in your request. Instead, use the\nUpdateDeveloperAppKey API to\nmake the association after the consumer key and secret are created.\n\nIf a consumer key and secret already exist, you can keep them or\ndelete them using the\nDeleteDeveloperAppKey API.", + "description": "Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee hybrid from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/create", "httpMethod": "POST", "id": "apigee.organizations.developers.apps.keys.create.create", @@ -2044,7 +2044,7 @@ ], "parameters": { "parent": { - "description": "Parent of the developer app key. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}/apps`", + "description": "Parent of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/apps/[^/]+$", "required": true, @@ -2080,7 +2080,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the developer attribute. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}/attributes/{attribute}`", + "description": "Required. Name of the developer attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/attributes/{attribute}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/attributes/[^/]+$", "required": true, @@ -2105,7 +2105,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the developer attribute. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}/attributes/{attribute}`", + "description": "Required. Name of the developer attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/attributes/{attribute}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/attributes/[^/]+$", "required": true, @@ -2130,7 +2130,7 @@ ], "parameters": { "parent": { - "description": "Required. Email address of the developer for which attributes are being listed in the\nfollowing format:\n `organizations/{org}/developers/{developer_email}`", + "description": "Required. Email address of the developer for which attributes are being listed in the following format: `organizations/{org}/developers/{developer_email}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+$", "required": true, @@ -2146,7 +2146,7 @@ ] }, "updateDeveloperAttribute": { - "description": "Updates a developer attribute.\n\n**Note**: OAuth access tokens and Key Management Service (KMS) entities\n(apps, developers, and API products) are cached for 180 seconds\n(default). Any custom attributes associated with these entities\nare cached for at least 180 seconds after the entity is accessed at\nruntime. Therefore, an `ExpiresIn` element on the OAuthV2 policy\nwon't be able to expire an access token in less than 180 seconds.", + "description": "Updates a developer attribute. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}", "httpMethod": "POST", "id": "apigee.organizations.developers.attributes.updateDeveloperAttribute", @@ -2155,7 +2155,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the developer attribute. Use the following structure in your\nrequest:\n `organizations/{org}/developers/{developer_email}/attributes/{attribute}`", + "description": "Required. Name of the developer attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/attributes/{attribute}`", "location": "path", "pattern": "^organizations/[^/]+/developers/[^/]+/attributes/[^/]+$", "required": true, @@ -2189,12 +2189,12 @@ ], "parameters": { "name": { - "description": "ID of the environment group. Overrides any ID in the environment_group\nresource.", + "description": "ID of the environment group. Overrides any ID in the environment_group resource.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Name of the organization in which to create the environment group in the\nfollowing format: `organizations/{org}`.", + "description": "Required. Name of the organization in which to create the environment group in the following format: `organizations/{org}`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2222,7 +2222,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the environment group in the following format:\n`organizations/{org}/envgroups/{envgroup}`.", + "description": "Required. Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`.", "location": "path", "pattern": "^organizations/[^/]+/envgroups/[^/]+$", "required": true, @@ -2247,7 +2247,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the environment group in the following format:\n`organizations/{org}/envgroups/{envgroup}`.", + "description": "Required. Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`.", "location": "path", "pattern": "^organizations/[^/]+/envgroups/[^/]+$", "required": true, @@ -2272,18 +2272,18 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of environment groups to return. The page size defaults\nto 25.", + "description": "Maximum number of environment groups to return. The page size defaults to 25.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Page token, returned from a previous ListEnvironmentGroups call, that you\ncan use to retrieve the next page.", + "description": "Page token, returned from a previous ListEnvironmentGroups call, that you can use to retrieve the next page.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Name of the organization for which to list environment groups in the\nfollowing format: `organizations/{org}`.", + "description": "Required. Name of the organization for which to list environment groups in the following format: `organizations/{org}`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2308,7 +2308,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the environment group to update in the format:\n`organizations/{org}/envgroups/{envgroup}.", + "description": "Required. Name of the environment group to update in the format: `organizations/{org}/envgroups/{envgroup}.", "location": "path", "pattern": "^organizations/[^/]+/envgroups/[^/]+$", "required": true, @@ -2346,7 +2346,7 @@ ], "parameters": { "parent": { - "description": "Required. EnvironmentGroup under which to create the attachment in the following\nformat: `organizations/{org}/envgroups/{envgroup}`.", + "description": "Required. EnvironmentGroup under which to create the attachment in the following format: `organizations/{org}/envgroups/{envgroup}`.", "location": "path", "pattern": "^organizations/[^/]+/envgroups/[^/]+$", "required": true, @@ -2374,7 +2374,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the environment group attachment to delete in the following format:\n`organizations/{org}/envgroups/{envgroup}/attachments/{attachment}`.", + "description": "Required. Name of the environment group attachment to delete in the following format: `organizations/{org}/envgroups/{envgroup}/attachments/{attachment}`.", "location": "path", "pattern": "^organizations/[^/]+/envgroups/[^/]+/attachments/[^/]+$", "required": true, @@ -2399,7 +2399,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the environment group attachment in the following format:\n`organizations/{org}/envgroups/{envgroup}/attachments/{attachment}`", + "description": "Required. Name of the environment group attachment in the following format: `organizations/{org}/envgroups/{envgroup}/attachments/{attachment}`", "location": "path", "pattern": "^organizations/[^/]+/envgroups/[^/]+/attachments/[^/]+$", "required": true, @@ -2424,13 +2424,13 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of environment group attachments to return. The page size\ndefaults to 25.", + "description": "Maximum number of environment group attachments to return. The page size defaults to 25.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Page token, returned by a previous ListEnvironmentGroupAttachments call,\nthat you can use to retrieve the next page.", + "description": "Page token, returned by a previous ListEnvironmentGroupAttachments call, that you can use to retrieve the next page.", "location": "query", "type": "string" }, @@ -2466,12 +2466,12 @@ ], "parameters": { "name": { - "description": "Optional. Name of the environment. Alternatively, the name may\nbe specified in the request body in the\nname field.", + "description": "Optional. Name of the environment. Alternatively, the name may be specified in the request body in the name field.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Name of the organization in which the environment will\nbe created. Use the following structure in your request:\n `organizations/{org}`", + "description": "Required. Name of the organization in which the environment will be created. Use the following structure in your request: `organizations/{org}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2499,7 +2499,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the environment. Use the following structure in your\nrequest:\n `organizations/{org}/environments/{env}`", + "description": "Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -2524,7 +2524,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the environment. Use the following structure in your request:\n `organizations/{org}/environments/{env}`", + "description": "Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -2549,7 +2549,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the debug mask. Use the following structure in your request:\n `organizations/{org}/environments/{env}/debugmask`.", + "description": "Required. Name of the debug mask. Use the following structure in your request: `organizations/{org}/environments/{env}/debugmask`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/debugmask$", "required": true, @@ -2574,7 +2574,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the environment deployed configuration resource. Use the following\nstructure in your request:\n `organizations/{org}/environments/{env}/deployedConfig`", + "description": "Required. Name of the environment deployed configuration resource. Use the following structure in your request: `organizations/{org}/environments/{env}/deployedConfig`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/deployedConfig$", "required": true, @@ -2590,7 +2590,7 @@ ] }, "getIamPolicy": { - "description": "Gets the IAM policy on an environment. For more information, see\n[Manage users, roles, and permissions\nusing the API](https://docs.apigee.com/hybrid/latest/manage-users-roles).\n\nYou must have the `apigee.environments.getIamPolicy` permission to call\nthis API.", + "description": "Gets the IAM policy on an environment. For more information, see [Manage users, roles, and permissions using the API](https://docs.apigee.com/hybrid/latest/manage-users-roles). You must have the `apigee.environments.getIamPolicy` permission to call this API.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}:getIamPolicy", "httpMethod": "GET", "id": "apigee.organizations.environments.getIamPolicy", @@ -2599,13 +2599,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": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -2621,7 +2621,7 @@ ] }, "setIamPolicy": { - "description": "Sets the IAM policy on an environment, if the policy already\nexists it will be replaced. For more information, see\n[Manage users, roles, and permissions\nusing the API](https://docs.apigee.com/hybrid/latest/manage-users-roles).\n\nYou must have the `apigee.environments.setIamPolicy` permission to\ncall this API.", + "description": "Sets the IAM policy on an environment, if the policy already exists it will be replaced. For more information, see [Manage users, roles, and permissions using the API](https://docs.apigee.com/hybrid/latest/manage-users-roles). You must have the `apigee.environments.setIamPolicy` permission to call this API.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}:setIamPolicy", "httpMethod": "POST", "id": "apigee.organizations.environments.setIamPolicy", @@ -2630,7 +2630,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": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -2649,7 +2649,7 @@ ] }, "subscribe": { - "description": "Creates a subscription for the environment's Pub/Sub topic.\nThe server will assign a random name for this subscription.\nThe \"name\" and \"push_config\" must *not* be specified.", + "description": "Creates a subscription for the environment's Pub/Sub topic. The server will assign a random name for this subscription. The \"name\" and \"push_config\" must *not* be specified.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}:subscribe", "httpMethod": "POST", "id": "apigee.organizations.environments.subscribe", @@ -2658,7 +2658,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the environment. Use the following structure in your request:\n `organizations/{org}/environments/{env}`", + "description": "Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -2674,7 +2674,7 @@ ] }, "testIamPermissions": { - "description": "Tests the permissions of a user on an environment,\nand returns a subset of permissions that the user has on the environment.\nIf the environment does not exist, an empty permission set is returned\n(a NOT_FOUND error is not returned).", + "description": "Tests the permissions of a user on an environment, and returns a subset of permissions that the user has on the environment. If the environment does not exist, an empty permission set is returned (a NOT_FOUND error is not returned).", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}:testIamPermissions", "httpMethod": "POST", "id": "apigee.organizations.environments.testIamPermissions", @@ -2683,7 +2683,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": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -2711,7 +2711,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the environment. Use the following structure in your request:\n `organizations/{org}/environments/{env}`", + "description": "Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -2730,7 +2730,7 @@ ] }, "update": { - "description": "Updates an existing environment.\n\nWhen updating properties, you must pass all existing properties to the API,\neven if they are not being changed. If you omit properties from the\npayload, the properties are removed. To get the current list of\nproperties for the environment, use the [Get Environment API](get).", + "description": "Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get).", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}", "httpMethod": "PUT", "id": "apigee.organizations.environments.update", @@ -2739,7 +2739,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the environment. Use the following structure in your request:\n `organizations/{org}/environments/{env}`", + "description": "Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -2774,7 +2774,7 @@ "type": "string" }, "replaceRepeatedFields": { - "description": "Boolean flag that specifies whether to replace existing values in the debug\nmask when doing an update. Set to true to replace existing values.\nThe default behavior is to append the values (false).", + "description": "Boolean flag that specifies whether to replace existing values in the debug mask when doing an update. Set to true to replace existing values. The default behavior is to append the values (false).", "location": "query", "type": "boolean" }, @@ -2797,7 +2797,7 @@ ] }, "updateEnvironment": { - "description": "Updates an existing environment.\n\nWhen updating properties, you must pass all existing properties to the API,\neven if they are not being changed. If you omit properties from the\npayload, the properties are removed. To get the current list of\nproperties for the environment, use the [Get Environment API](get).", + "description": "Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get).", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}", "httpMethod": "POST", "id": "apigee.organizations.environments.updateEnvironment", @@ -2806,7 +2806,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the environment. Use the following structure in your request:\n `organizations/{org}/environments/{env}`", + "description": "Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -2831,7 +2831,7 @@ "admin": { "methods": { "getSchemav2": { - "description": "Get a list of metrics and dimensions which can be used for creating\nanalytics queries and reports.\nEach schema element contains the name of the field with its associated type\nand if it is either custom field or standard field.", + "description": "Get a list of metrics and dimensions which can be used for creating analytics queries and reports. Each schema element contains the name of the field with its associated type and if it is either custom field or standard field.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/admin/schemav2", "httpMethod": "GET", "id": "apigee.organizations.environments.analytics.admin.getSchemav2", @@ -2840,14 +2840,14 @@ ], "parameters": { "name": { - "description": "Required. The parent organization and environment names. Must be of the\nform `organizations/{org}/environments/{env}/analytics/admin/schemav2`.", + "description": "Required. The parent organization and environment names. Must be of the form `organizations/{org}/environments/{env}/analytics/admin/schemav2`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/analytics/admin/schemav2$", "required": true, "type": "string" }, "type": { - "description": "Required. Type refers to the dataset name whose schema needs to be\nretrieved E.g. type=fact or type=agg_cus1", + "description": "Required. Type refers to the dataset name whose schema needs to be retrieved E.g. type=fact or type=agg_cus1", "location": "query", "type": "string" } @@ -2865,7 +2865,7 @@ "exports": { "methods": { "create": { - "description": "Submit a data export job to be processed in the background.\nIf the request is successful, the API returns a 201 status, a URI that can\nbe used to retrieve the status of the export job, and the `state` value of\n\"enqueued\".", + "description": "Submit a data export job to be processed in the background. If the request is successful, the API returns a 201 status, a URI that can be used to retrieve the status of the export job, and the `state` value of \"enqueued\".", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports", "httpMethod": "POST", "id": "apigee.organizations.environments.analytics.exports.create", @@ -2874,7 +2874,7 @@ ], "parameters": { "parent": { - "description": "Required. Names of the parent organization and environment.\nMust be of the form `organizations/{org}/environments/{env}`.", + "description": "Required. Names of the parent organization and environment. Must be of the form `organizations/{org}/environments/{env}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -2893,7 +2893,7 @@ ] }, "get": { - "description": "Gets the details and status of an analytics export job.\nIf the export job is still in progress, its `state` is set to \"running\".\nAfter the export job has completed successfully, its `state` is set to\n\"completed\".\nIf the export job fails, its `state` is set to `failed`.", + "description": "Gets the details and status of an analytics export job. If the export job is still in progress, its `state` is set to \"running\". After the export job has completed successfully, its `state` is set to \"completed\". If the export job fails, its `state` is set to `failed`.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports/{exportsId}", "httpMethod": "GET", "id": "apigee.organizations.environments.analytics.exports.get", @@ -2918,7 +2918,7 @@ ] }, "list": { - "description": "Lists the details and status of all analytics export jobs belonging to the\nparent organization and environment.", + "description": "Lists the details and status of all analytics export jobs belonging to the parent organization and environment.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports", "httpMethod": "GET", "id": "apigee.organizations.environments.analytics.exports.list", @@ -2927,7 +2927,7 @@ ], "parameters": { "parent": { - "description": "Required. Names of the parent organization and environment.\nMust be of the form `organizations/{org}/environments/{env}`.", + "description": "Required. Names of the parent organization and environment. Must be of the form `organizations/{org}/environments/{env}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -2960,7 +2960,7 @@ ], "parameters": { "parent": { - "description": "Required. Name representing an API proxy in an environment in the following\nformat:\n `organizations/{org}/environments/{env}/apis/{api}`", + "description": "Required. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+$", "required": true, @@ -2980,7 +2980,7 @@ "revisions": { "methods": { "deployments": { - "description": "Undeploys an API proxy revision from an environment.\n\nBecause multiple revisions of the same API proxy can be deployed in\nthe same environment if the base paths are different, you must specify the\nrevision number of the API proxy.", + "description": "Undeploys an API proxy revision from an environment. Because multiple revisions of the same API proxy can be deployed in the same environment if the base paths are different, you must specify the revision number of the API proxy.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments", "httpMethod": "DELETE", "id": "apigee.organizations.environments.apis.revisions.deployments", @@ -2989,14 +2989,14 @@ ], "parameters": { "name": { - "description": "Required. Name of the API proxy revision deployment in the following format:\n `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", + "description": "Required. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, "type": "string" }, "sequencedRollout": { - "description": "If true, a best-effort attempt will be made to remove the environment group\nrouting rules corresponding to this deployment before removing the\ndeployment from the runtime. This is likely to be a rare use case; it is\nonly needed when the intended effect of undeploying this proxy is to cause\nthe traffic it currently handles to be rerouted to some other existing\nproxy in the environment group. The GenerateUndeployChangeReport API may be\nused to examine routing changes before issuing the undeployment request,\nand its response will indicate if a sequenced rollout is recommended for\nthe undeployment.", + "description": "If true, a best-effort attempt will be made to remove the environment group routing rules corresponding to this deployment before removing the deployment from the runtime. This is likely to be a rare use case; it is only needed when the intended effect of undeploying this proxy is to cause the traffic it currently handles to be rerouted to some other existing proxy in the environment group. The GenerateUndeployChangeReport API may be used to examine routing changes before issuing the undeployment request, and its response will indicate if a sequenced rollout is recommended for the undeployment.", "location": "query", "type": "boolean" } @@ -3010,7 +3010,7 @@ ] }, "getDeployments": { - "description": "Gets the deployment of an API proxy revision and actual state reported by\nruntime pods.", + "description": "Gets the deployment of an API proxy revision and actual state reported by runtime pods.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments", "httpMethod": "GET", "id": "apigee.organizations.environments.apis.revisions.getDeployments", @@ -3019,7 +3019,7 @@ ], "parameters": { "name": { - "description": "Required. Name representing an API proxy revision in an\nenvironment in the following format:\n `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", + "description": "Required. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, @@ -3048,14 +3048,14 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the API Proxy revision deployment for which\nto create the DebugSession. Must be of the form\n `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.", + "description": "Required. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, "type": "string" }, "timeout": { - "description": "Optional. The time in seconds after which this DebugSession should end.\nA timeout specified in DebugSession will overwrite this value.", + "description": "Optional. The time in seconds after which this DebugSession should end. A timeout specified in DebugSession will overwrite this value.", "format": "int64", "location": "query", "type": "string" @@ -3073,7 +3073,7 @@ ] }, "deleteData": { - "description": "Deletes the data from a debug session. This does not cancel the debug\nsession or prevent further data from being collected if the session is\nstill active in runtime pods.", + "description": "Deletes the data from a debug session. This does not cancel the debug session or prevent further data from being collected if the session is still active in runtime pods.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data", "httpMethod": "DELETE", "id": "apigee.organizations.environments.apis.revisions.debugsessions.deleteData", @@ -3082,7 +3082,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the debug session to delete.\nMust be of the form:\n `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`.", + "description": "Required. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+/debugsessions/[^/]+$", "required": true, @@ -3107,7 +3107,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the debug session to retrieve.\nMust be of the form:\n `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`.", + "description": "Required. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+/debugsessions/[^/]+$", "required": true, @@ -3123,7 +3123,7 @@ ] }, "list": { - "description": "Lists debug sessions that are currently active in the given API Proxy\nrevision.", + "description": "Lists debug sessions that are currently active in the given API Proxy revision.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions", "httpMethod": "GET", "id": "apigee.organizations.environments.apis.revisions.debugsessions.list", @@ -3132,18 +3132,18 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of debug sessions to return. The page size defaults\nto 25.", + "description": "Maximum number of debug sessions to return. The page size defaults to 25.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Page token, returned from a previous ListDebugSessions call, that you\ncan use to retrieve the next page.", + "description": "Page token, returned from a previous ListDebugSessions call, that you can use to retrieve the next page.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The name of the API Proxy revision deployment for which\nto list debug sessions. Must be of the form:\n `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.", + "description": "Required. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, @@ -3172,7 +3172,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the debug session transaction. Must be of the form:\n `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`.", + "description": "Required. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+/debugsessions/[^/]+/data/[^/]+$", "required": true, @@ -3194,7 +3194,7 @@ "deployments": { "methods": { "generateDeployChangeReport": { - "description": "Generates a report for a dry run analysis of a DeployApiProxy request\nwithout committing the deployment.\n\nIn addition to the standard validations performed when adding deployments,\nadditional analysis will be done to detect possible traffic routing changes\nthat would result from this deployment being created. Any potential routing\nconflicts or unsafe changes will be reported in the response. This routing\nanalysis is not performed for a non-dry-run DeployApiProxy request.", + "description": "Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment. In addition to the standard validations performed when adding deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being created. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run DeployApiProxy request.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateDeployChangeReport", "httpMethod": "POST", "id": "apigee.organizations.environments.apis.revisions.deployments.generateDeployChangeReport", @@ -3203,19 +3203,19 @@ ], "parameters": { "basepath": { - "description": "Base path where the API proxy revision should be deployed. Defaults to '/'\nif not provided.", + "description": "Base path where the API proxy revision should be deployed. Defaults to '/' if not provided.", "location": "query", "type": "string" }, "name": { - "description": "Name of the API proxy revision deployment in the following format:\n `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", + "description": "Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, "type": "string" }, "override": { - "description": "Flag that specifies whether to force the deployment of the new revision\nover the currently deployed revision by overriding conflict checks.", + "description": "Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks.", "location": "query", "type": "boolean" } @@ -3229,7 +3229,7 @@ ] }, "generateUndeployChangeReport": { - "description": "Generates a report for a dry run analysis of an UndeployApiProxy request\nwithout committing the undeploy.\n\nIn addition to the standard validations performed when removing\ndeployments, additional analysis will be done to detect possible traffic\nrouting changes that would result from this deployment being removed. Any\npotential routing conflicts or unsafe changes will be reported in the\nresponse. This routing analysis is not performed for a non-dry-run\nUndeployApiProxy request.", + "description": "Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy. In addition to the standard validations performed when removing deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being removed. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run UndeployApiProxy request.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateUndeployChangeReport", "httpMethod": "POST", "id": "apigee.organizations.environments.apis.revisions.deployments.generateUndeployChangeReport", @@ -3238,7 +3238,7 @@ ], "parameters": { "name": { - "description": "Name of the API proxy revision deployment in the following format:\n `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", + "description": "Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, @@ -3271,7 +3271,7 @@ ], "parameters": { "name": { - "description": "Required. Cache resource name of the form:\n `organizations/{organization_id}/environments/{environment_id}/caches/{cache_id}`", + "description": "Required. Cache resource name of the form: `organizations/{organization_id}/environments/{environment_id}/caches/{cache_id}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/caches/[^/]+$", "required": true, @@ -3300,14 +3300,14 @@ ], "parameters": { "parent": { - "description": "Required. Name of the environment for which to return deployment information in the\nfollowing format:\n `organizations/{org}/environments/{env}`", + "description": "Required. Name of the environment for which to return deployment information in the following format: `organizations/{org}/environments/{env}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, "type": "string" }, "sharedFlows": { - "description": "Optional. Flag that specifies whether to return shared flow or API proxy deployments.\nSet to `true` to return shared flow deployments; set to `false`\nto return API proxy deployments. Defaults to `false`.", + "description": "Optional. Flag that specifies whether to return shared flow or API proxy deployments. Set to `true` to return shared flow deployments; set to `false` to return API proxy deployments. Defaults to `false`.", "location": "query", "type": "boolean" } @@ -3334,7 +3334,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the flow hook to which the shared flow should be\nattached in the following format:\n `organizations/{org}/environments/{env}/flowhooks/{flowhook}`", + "description": "Required. Name of the flow hook to which the shared flow should be attached in the following format: `organizations/{org}/environments/{env}/flowhooks/{flowhook}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/flowhooks/[^/]+$", "required": true, @@ -3362,7 +3362,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the flow hook to detach in the following format:\n `organizations/{org}/environments/{env}/flowhooks/{flowhook}`", + "description": "Required. Name of the flow hook to detach in the following format: `organizations/{org}/environments/{env}/flowhooks/{flowhook}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/flowhooks/[^/]+$", "required": true, @@ -3378,7 +3378,7 @@ ] }, "get": { - "description": "Returns the name of the shared flow attached to the specified flow hook. If\nthere's no shared flow attached to the flow hook, the API does not return\nan error; it simply does not return a name in the response.", + "description": "Returns the name of the shared flow attached to the specified flow hook. If there's no shared flow attached to the flow hook, the API does not return an error; it simply does not return a name in the response.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}", "httpMethod": "GET", "id": "apigee.organizations.environments.flowhooks.get", @@ -3387,7 +3387,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the flow hook in the following format:\n `organizations/{org}/environments/{env}/flowhooks/{flowhook}`", + "description": "Required. Name of the flow hook in the following format: `organizations/{org}/environments/{env}/flowhooks/{flowhook}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/flowhooks/[^/]+$", "required": true, @@ -3407,7 +3407,7 @@ "keystores": { "methods": { "create": { - "description": "Creates a keystore or truststore:\n * Keystore: Contains certificates and their associated keys.\n * Truststore: Contains trusted certificates used to validate a\n server's certificate. These certificates are typically self-signed\n certificates or certificates that are not signed by a trusted CA.", + "description": "Creates a keystore or truststore: * Keystore: Contains certificates and their associated keys. * Truststore: Contains trusted certificates used to validate a server's certificate. These certificates are typically self-signed certificates or certificates that are not signed by a trusted CA.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores", "httpMethod": "POST", "id": "apigee.organizations.environments.keystores.create", @@ -3421,7 +3421,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the environment in which to create the keystore.\nMust be of the form\n`organizations/{organization}/environments/{environment}`.", + "description": "Required. The name of the environment in which to create the keystore. Must be of the form `organizations/{organization}/environments/{environment}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -3449,7 +3449,7 @@ ], "parameters": { "name": { - "description": "Required. The name of keystore to delete. Must be of the form\n`organizations/{organization}/environments/{environment}/keystores/{keystore}`.", + "description": "Required. The name of keystore to delete. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+$", "required": true, @@ -3474,7 +3474,7 @@ ], "parameters": { "name": { - "description": "Required. The name of keystore. Must be of the form\n`organizations/{organization}/environments/{environment}/keystores/{keystore}`.", + "description": "Required. The name of keystore. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+$", "required": true, @@ -3494,7 +3494,7 @@ "aliases": { "methods": { "create": { - "description": "Creates an alias from a key, certificate pair.\nThe structure of the request is controlled by the `format` query parameter:\n * `keycertfile` - Separate PEM-encoded key and certificate files are\n uploaded. The request must have `Content-Type: multipart/form-data` and\n include fields `keyFile` and `certFile`. If uploading to a truststore,\n omit `keyFile`.\n* `pkcs12` - A PKCS12 file is uploaded. The request must have\n`Content-Type: multipart/form-data` with the file provided in the only\nfield.\n* `selfsignedcert` - A new private key and certificate are generated. The\nrequest must have `Content-Type: application/json` and a body of\nCertificateGenerationSpec.", + "description": "Creates an alias from a key, certificate pair. The structure of the request is controlled by the `format` query parameter: * `keycertfile` - Separate PEM-encoded key and certificate files are uploaded. The request must have `Content-Type: multipart/form-data` and include fields `keyFile` and `certFile`. If uploading to a truststore, omit `keyFile`. * `pkcs12` - A PKCS12 file is uploaded. The request must have `Content-Type: multipart/form-data` with the file provided in the only field. * `selfsignedcert` - A new private key and certificate are generated. The request must have `Content-Type: application/json` and a body of CertificateGenerationSpec.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases", "httpMethod": "POST", "id": "apigee.organizations.environments.keystores.aliases.create", @@ -3508,12 +3508,12 @@ "type": "string" }, "alias": { - "description": "The alias for the key, certificate pair. Values must match\nregular expression `[\\w\\s-.]{1,255}`. This must be provided for all formats\nexcept 'selfsignedcert'; self-signed certs may specify the alias in either\nthis parameter or the JSON body.", + "description": "The alias for the key, certificate pair. Values must match regular expression `[\\w\\s-.]{1,255}`. This must be provided for all formats except 'selfsignedcert'; self-signed certs may specify the alias in either this parameter or the JSON body.", "location": "query", "type": "string" }, "format": { - "description": "Required. The format of the data. Must be either `selfsignedcert`,\n`keycertfile`, or `pkcs12`.", + "description": "Required. The format of the data. Must be either `selfsignedcert`, `keycertfile`, or `pkcs12`.", "location": "query", "type": "string" }, @@ -3523,12 +3523,12 @@ "type": "boolean" }, "ignoreNewlineValidation": { - "description": "If `true`, do not throw an error when the file contains a chain with no\nnewline between each certificate. By default, a newline is needed between\neach certificate in a chain.", + "description": "If `true`, do not throw an error when the file contains a chain with no newline between each certificate. By default, a newline is needed between each certificate in a chain.", "location": "query", "type": "boolean" }, "parent": { - "description": "Required. The name of the keystore. Must be of the form\n`organizations/{organization}/environments/{environment}/keystores/{keystore}`.", + "description": "Required. The name of the keystore. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+$", "required": true, @@ -3547,7 +3547,7 @@ ] }, "csr": { - "description": "Generates a PKCS #10 Certificate Signing Request for the private key in\nan alias.", + "description": "Generates a PKCS #10 Certificate Signing Request for the private key in an alias.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/csr", "httpMethod": "GET", "id": "apigee.organizations.environments.keystores.aliases.csr", @@ -3556,7 +3556,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the alias. Must be of the form\n`organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", + "description": "Required. The name of the alias. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$", "required": true, @@ -3581,7 +3581,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the alias. Must be of the form\n`organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", + "description": "Required. The name of the alias. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$", "required": true, @@ -3606,7 +3606,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the alias. Must be of the form\n`organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", + "description": "Required. The name of the alias. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$", "required": true, @@ -3631,7 +3631,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the alias. Must be of the form\n`organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", + "description": "Required. The name of the alias. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$", "required": true, @@ -3661,12 +3661,12 @@ "type": "boolean" }, "ignoreNewlineValidation": { - "description": "If `true`, do not throw an error when the file contains a chain with no\nnewline between each certificate. By default, a newline is needed between\neach certificate in a chain.", + "description": "If `true`, do not throw an error when the file contains a chain with no newline between each certificate. By default, a newline is needed between each certificate in a chain.", "location": "query", "type": "boolean" }, "name": { - "description": "Required. The name of the alias. Must be of the form\n`organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", + "description": "Required. The name of the alias. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$", "required": true, @@ -3700,7 +3700,7 @@ ], "parameters": { "parent": { - "description": "Required. The name of the environment in which to create the key value map.\nMust be of the form\n`organizations/{organization}/environments/{environment}`.", + "description": "Required. The name of the environment in which to create the key value map. Must be of the form `organizations/{organization}/environments/{environment}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -3728,7 +3728,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the key value map.\nMust be of the form\n`organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}`.", + "description": "Required. The name of the key value map. Must be of the form `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keyvaluemaps/[^/]+$", "required": true, @@ -3748,7 +3748,7 @@ "optimizedStats": { "methods": { "get": { - "description": "This api is similar to GetStats\nexcept that the response is less verbose.\nIn the current scheme, a query parameter _optimized instructs\nEdge Analytics to change the response but since this behavior\nis not possible with protocol buffer and since this parameter is\npredominantly used by Edge UI, we are introducing a separate api.", + "description": "This api is similar to GetStats except that the response is less verbose. In the current scheme, a query parameter _optimized instructs Edge Analytics to change the response but since this behavior is not possible with protocol buffer and since this parameter is predominantly used by Edge UI, we are introducing a separate api.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/optimizedStats/{optimizedStatsId}", "httpMethod": "GET", "id": "apigee.organizations.environments.optimizedStats.get", @@ -3762,7 +3762,7 @@ "type": "string" }, "aggTable": { - "description": "If customers want to query custom aggregate tables, then this parameter\ncan be used to specify the table name. If this parameter is skipped, then\nEdge Query will try to retrieve the data from fact tables which will be\nexpensive.", + "description": "If customers want to query custom aggregate tables, then this parameter can be used to specify the table name. If this parameter is skipped, then Edge Query will try to retrieve the data from fact tables which will be expensive.", "location": "query", "type": "string" }, @@ -3772,19 +3772,19 @@ "type": "string" }, "limit": { - "description": "This parameter is used to limit the number of result items.\nDefault and the max value is 14400.", + "description": "This parameter is used to limit the number of result items. Default and the max value is 14400.", "location": "query", "type": "string" }, "name": { - "description": "Required. The resource name for which the interactive query will be executed.\nMust be of the form\n `organizations/{organization_id}/environments/{environment_id/stats/{dimensions}`\nDimensions let you view metrics in meaningful groupings. E.g. apiproxy,\ntarget_host. The value of dimensions should be comma separated list as\nshown below\n`organizations/{org}/environments/{env}/stats/apiproxy,request_verb`", + "description": "Required. The resource name for which the interactive query will be executed. Must be of the form `organizations/{organization_id}/environments/{environment_id/stats/{dimensions}` Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown below `organizations/{org}/environments/{env}/stats/apiproxy,request_verb`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/optimizedStats/.*$", "required": true, "type": "string" }, "offset": { - "description": "Use offset with limit to enable pagination of results. For example,\nto display results 11-20, set limit to '10' and offset to '10'.", + "description": "Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.", "location": "query", "type": "string" }, @@ -3794,7 +3794,7 @@ "type": "boolean" }, "select": { - "description": "Required. The select parameter contains a comma separated list of metrics.\nE.g. sum(message_count),sum(error_count)", + "description": "Required. The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)", "location": "query", "type": "string" }, @@ -3804,7 +3804,7 @@ "type": "boolean" }, "sort": { - "description": "This parameter specifies if the sort order should be ascending or\ndescending Supported values are DESC and ASC.", + "description": "This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.", "location": "query", "type": "string" }, @@ -3814,22 +3814,22 @@ "type": "string" }, "timeRange": { - "description": "Required. Time interval for the interactive query.\nTime range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59", + "description": "Required. Time interval for the interactive query. Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59", "location": "query", "type": "string" }, "timeUnit": { - "description": "A value of second, minute, hour, day, week, month.\nTime Unit specifies the granularity of metrics returned.", + "description": "A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.", "location": "query", "type": "string" }, "topk": { - "description": "Take 'top k' results from results, for example, to return the top 5\nresults 'topk=5'.", + "description": "Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.", "location": "query", "type": "string" }, "tsAscending": { - "description": "Lists timestamps in ascending order if set to true. Recommend setting\nthis value to true if you are using sortby with sort=DESC.", + "description": "Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.", "location": "query", "type": "boolean" }, @@ -3852,7 +3852,7 @@ "queries": { "methods": { "create": { - "description": "Submit a query to be processed in the background.\nIf the submission of the query succeeds, the API returns a 201 status and\nan ID that refer to the query. In addition to the HTTP status 201, the\n`state` of \"enqueued\" means that the request succeeded.", + "description": "Submit a query to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the `state` of \"enqueued\" means that the request succeeded.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/queries", "httpMethod": "POST", "id": "apigee.organizations.environments.queries.create", @@ -3861,7 +3861,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource name.\nMust be of the form `organizations/{org}/environments/{env}`.", + "description": "Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -3880,7 +3880,7 @@ ] }, "get": { - "description": "Get query status\nIf the query is still in progress, the `state` is set to \"running\"\nAfter the query has completed successfully, `state` is set to \"completed\"", + "description": "Get query status If the query is still in progress, the `state` is set to \"running\" After the query has completed successfully, `state` is set to \"completed\"", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}", "httpMethod": "GET", "id": "apigee.organizations.environments.queries.get", @@ -3889,7 +3889,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the asynchronous query to get. Must be of the form\n`organizations/{org}/environments/{env}/queries/{queryId}`.", + "description": "Required. Name of the asynchronous query to get. Must be of the form `organizations/{org}/environments/{env}/queries/{queryId}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/queries/[^/]+$", "required": true, @@ -3905,7 +3905,7 @@ ] }, "getResult": { - "description": "After the query is completed, use this API to retrieve the results.\nIf the request succeeds, and there is a non-zero result set, the result is\ndownloaded to the client as a zipped JSON file.\nThe name of the downloaded file will be:\n OfflineQueryResult-.zip\n\nExample: `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip`", + "description": "After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON file. The name of the downloaded file will be: OfflineQueryResult-.zip Example: `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip`", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/result", "httpMethod": "GET", "id": "apigee.organizations.environments.queries.getResult", @@ -3914,7 +3914,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the asynchronous query result to get. Must be of the\nform `organizations/{org}/environments/{env}/queries/{queryId}/result`.", + "description": "Required. Name of the asynchronous query result to get. Must be of the form `organizations/{org}/environments/{env}/queries/{queryId}/result`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/queries/[^/]+/result$", "required": true, @@ -3939,12 +3939,12 @@ ], "parameters": { "dataset": { - "description": "Filter response list by dataset.\n\nExample: `api`, `mint`", + "description": "Filter response list by dataset. Example: `api`, `mint`", "location": "query", "type": "string" }, "from": { - "description": "Filter response list by returning asynchronous queries that\ncreated after this date time.\nTime must be in ISO date-time format like '2011-12-03T10:15:30Z'.", + "description": "Filter response list by returning asynchronous queries that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.", "location": "query", "type": "string" }, @@ -3954,7 +3954,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource name.\nMust be of the form `organizations/{org}/environments/{env}`.", + "description": "Required. The parent resource name. Must be of the form `organizations/{org}/environments/{env}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -3971,7 +3971,7 @@ "type": "string" }, "to": { - "description": "Filter response list by returning asynchronous queries that\ncreated before this date time.\nTime must be in ISO date-time format like '2011-12-03T10:16:30Z'.", + "description": "Filter response list by returning asynchronous queries that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'.", "location": "query", "type": "string" } @@ -3998,7 +3998,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent environment name under which the Reference will\nbe created. Must be of the form `organizations/{org}/environments/{env}`.", + "description": "Required. The parent environment name under which the Reference will be created. Must be of the form `organizations/{org}/environments/{env}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -4017,7 +4017,7 @@ ] }, "delete": { - "description": "Deletes a Reference from an environment. Returns the deleted\nReference resource.", + "description": "Deletes a Reference from an environment. Returns the deleted Reference resource.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}", "httpMethod": "DELETE", "id": "apigee.organizations.environments.references.delete", @@ -4026,7 +4026,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Reference to delete. Must be\nof the form `organizations/{org}/environments/{env}/references/{ref}`.", + "description": "Required. The name of the Reference to delete. Must be of the form `organizations/{org}/environments/{env}/references/{ref}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/references/[^/]+$", "required": true, @@ -4051,7 +4051,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Reference to get. Must be of the form\n`organizations/{org}/environments/{env}/references/{ref}`.", + "description": "Required. The name of the Reference to get. Must be of the form `organizations/{org}/environments/{env}/references/{ref}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/references/[^/]+$", "required": true, @@ -4067,7 +4067,7 @@ ] }, "update": { - "description": "Updates an existing Reference. Note that this operation has PUT\nsemantics; it will replace the entirety of the existing Reference with\nthe resource in the request body.", + "description": "Updates an existing Reference. Note that this operation has PUT semantics; it will replace the entirety of the existing Reference with the resource in the request body.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}", "httpMethod": "PUT", "id": "apigee.organizations.environments.references.update", @@ -4076,7 +4076,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Reference to update. Must be of the form\n`organizations/{org}/environments/{env}/references/{ref}`.", + "description": "Required. The name of the Reference to update. Must be of the form `organizations/{org}/environments/{env}/references/{ref}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/references/[^/]+$", "required": true, @@ -4099,7 +4099,7 @@ "resourcefiles": { "methods": { "create": { - "description": "Creates a resource file.\n\nSpecify the `Content-Type` as `application/octet-stream` or\n`multipart/form-data`.\n\nFor more information about resource files, see\n[Resource files](/api-platform/develop/resource-files).", + "description": "Creates a resource file. Specify the `Content-Type` as `application/octet-stream` or `multipart/form-data`. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles", "httpMethod": "POST", "id": "apigee.organizations.environments.resourcefiles.create", @@ -4108,12 +4108,12 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource file. Must match the regular expression:\n[a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}", + "description": "Required. Name of the resource file. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}", "location": "query", "type": "string" }, "parent": { - "description": "Required. Name of the environment in which to create the resource file in the\nfollowing format:\n `organizations/{org}/environments/{env}`.", + "description": "Required. Name of the environment in which to create the resource file in the following format: `organizations/{org}/environments/{env}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -4137,7 +4137,7 @@ ] }, "delete": { - "description": "Deletes a resource file.\n\nFor more information about resource files, see\n[Resource files](/api-platform/develop/resource-files).", + "description": "Deletes a resource file. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}", "httpMethod": "DELETE", "id": "apigee.organizations.environments.resourcefiles.delete", @@ -4148,13 +4148,13 @@ ], "parameters": { "name": { - "description": "Required. ID of the resource file to delete. Must match the regular\nexpression: [a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}", + "description": "Required. ID of the resource file to delete. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}", "location": "path", "required": true, "type": "string" }, "parent": { - "description": "Required. Name of the environment in the following format:\n `organizations/{org}/environments/{env}`.", + "description": "Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -4176,7 +4176,7 @@ ] }, "get": { - "description": "Gets the contents of a resource file.\n\nFor more information about resource files, see\n[Resource files](/api-platform/develop/resource-files).", + "description": "Gets the contents of a resource file. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}", "httpMethod": "GET", "id": "apigee.organizations.environments.resourcefiles.get", @@ -4187,20 +4187,20 @@ ], "parameters": { "name": { - "description": "Required. ID of the resource file. Must match the regular\nexpression: [a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}", + "description": "Required. ID of the resource file. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}", "location": "path", "required": true, "type": "string" }, "parent": { - "description": "Required. Name of the environment in the following format:\n `organizations/{org}/environments/{env}`.", + "description": "Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, "type": "string" }, "type": { - "description": "Required. Resource file type. {{ resource_file_type }}", + "description": "Required. Resource file type. {{ resource_file_type }}", "location": "path", "required": true, "type": "string" @@ -4215,7 +4215,7 @@ ] }, "list": { - "description": "Lists all resource files.\n\nFor more information about resource files, see\n[Resource files](/api-platform/develop/resource-files).", + "description": "Lists all resource files. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles", "httpMethod": "GET", "id": "apigee.organizations.environments.resourcefiles.list", @@ -4224,14 +4224,14 @@ ], "parameters": { "parent": { - "description": "Required. Name of the environment in which to list resource files in the following\nformat:\n `organizations/{org}/environments/{env}`.", + "description": "Required. Name of the environment in which to list resource files in the following format: `organizations/{org}/environments/{env}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, "type": "string" }, "type": { - "description": "Optional. Type of resource files to list.\n{{ resource_file_type }}", + "description": "Optional. Type of resource files to list. {{ resource_file_type }}", "location": "query", "type": "string" } @@ -4245,7 +4245,7 @@ ] }, "listEnvironmentResources": { - "description": "Lists all resource files.\n\nFor more information about resource files, see\n[Resource files](/api-platform/develop/resource-files).", + "description": "Lists all resource files. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}", "httpMethod": "GET", "id": "apigee.organizations.environments.resourcefiles.listEnvironmentResources", @@ -4255,14 +4255,14 @@ ], "parameters": { "parent": { - "description": "Required. Name of the environment in which to list resource files in the following\nformat:\n `organizations/{org}/environments/{env}`.", + "description": "Required. Name of the environment in which to list resource files in the following format: `organizations/{org}/environments/{env}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, "type": "string" }, "type": { - "description": "Optional. Type of resource files to list.\n{{ resource_file_type }}", + "description": "Optional. Type of resource files to list. {{ resource_file_type }}", "location": "path", "required": true, "type": "string" @@ -4277,7 +4277,7 @@ ] }, "update": { - "description": "Updates a resource file.\n\nSpecify the `Content-Type` as `application/octet-stream` or\n`multipart/form-data`.\n\nFor more information about resource files, see\n[Resource files](/api-platform/develop/resource-files).", + "description": "Updates a resource file. Specify the `Content-Type` as `application/octet-stream` or `multipart/form-data`. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}", "httpMethod": "PUT", "id": "apigee.organizations.environments.resourcefiles.update", @@ -4288,13 +4288,13 @@ ], "parameters": { "name": { - "description": "Required. ID of the resource file to update. Must match the regular\nexpression: [a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}", + "description": "Required. ID of the resource file to update. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}", "location": "path", "required": true, "type": "string" }, "parent": { - "description": "Required. Name of the environment in the following format:\n `organizations/{org}/environments/{env}`.", + "description": "Required. Name of the environment in the following format: `organizations/{org}/environments/{env}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -4334,7 +4334,7 @@ ], "parameters": { "parent": { - "description": "Required. Name representing a shared flow in an environment in the following\nformat:\n `organizations/{org}/environments/{env}/sharedflows/{sharedflow}`", + "description": "Required. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/sharedflows/[^/]+$", "required": true, @@ -4363,7 +4363,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the shared flow revision to undeploy in the following format:\n `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`", + "description": "Required. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", "required": true, @@ -4379,7 +4379,7 @@ ] }, "getDeployments": { - "description": "Gets the deployment of a shared flow revision and actual state reported by\nruntime pods.", + "description": "Gets the deployment of a shared flow revision and actual state reported by runtime pods.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments", "httpMethod": "GET", "id": "apigee.organizations.environments.sharedflows.revisions.getDeployments", @@ -4388,7 +4388,7 @@ ], "parameters": { "name": { - "description": "Required. Name representing a shared flow in an environment in the following\nformat:\n `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`", + "description": "Required. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", "required": true, @@ -4410,7 +4410,7 @@ "stats": { "methods": { "get": { - "description": "Retrieve metrics grouped by dimensions.\nThe types of metrics you can retrieve include traffic, message counts,\nAPI call latency, response size, and cache hits and counts.\nDimensions let you view metrics in meaningful groups.\nThe stats api does accept dimensions as path params. The dimensions are\noptional in which case the metrics are computed on the entire data\nfor the given timerange.", + "description": "Retrieve metrics grouped by dimensions. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/stats/{statsId}", "httpMethod": "GET", "id": "apigee.organizations.environments.stats.get", @@ -4419,12 +4419,12 @@ ], "parameters": { "accuracy": { - "description": "Legacy field: not used anymore.\nThis field is present to support UI calls which still use this parameter.", + "description": "Legacy field: not used anymore. This field is present to support UI calls which still use this parameter.", "location": "query", "type": "string" }, "aggTable": { - "description": "If customers want to query custom aggregate tables, then this parameter\ncan be used to specify the table name. If this parameter is skipped, then\nEdge Query will try to retrieve the data from fact tables which will be\nexpensive.", + "description": "If customers want to query custom aggregate tables, then this parameter can be used to specify the table name. If this parameter is skipped, then Edge Query will try to retrieve the data from fact tables which will be expensive.", "location": "query", "type": "string" }, @@ -4434,19 +4434,19 @@ "type": "string" }, "limit": { - "description": "This parameter is used to limit the number of result items.\nDefault and the max value is 14400.", + "description": "This parameter is used to limit the number of result items. Default and the max value is 14400.", "location": "query", "type": "string" }, "name": { - "description": "Required. The resource name for which the interactive query will be executed.\nMust be of the form\n `organizations/{organization_id}/environments/{environment_id/stats/{dimensions}`\nDimensions let you view metrics in meaningful groupings. E.g. apiproxy,\ntarget_host. The value of dimensions should be comma separated list as\nshown below\n`organizations/{org}/environments/{env}/stats/apiproxy,request_verb`", + "description": "Required. The resource name for which the interactive query will be executed. Must be of the form `organizations/{organization_id}/environments/{environment_id/stats/{dimensions}` Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown below `organizations/{org}/environments/{env}/stats/apiproxy,request_verb`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/stats/.*$", "required": true, "type": "string" }, "offset": { - "description": "Use offset with limit to enable pagination of results. For example,\nto display results 11-20, set limit to '10' and offset to '10'.", + "description": "Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.", "location": "query", "type": "string" }, @@ -4456,7 +4456,7 @@ "type": "boolean" }, "select": { - "description": "The select parameter contains a comma separated list of metrics.\nE.g. sum(message_count),sum(error_count)", + "description": "The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)", "location": "query", "type": "string" }, @@ -4466,7 +4466,7 @@ "type": "boolean" }, "sort": { - "description": "This parameter specifies if the sort order should be ascending or\ndescending Supported values are DESC and ASC.", + "description": "This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.", "location": "query", "type": "string" }, @@ -4476,22 +4476,22 @@ "type": "string" }, "timeRange": { - "description": "Time interval for the interactive query.\nTime range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59", + "description": "Time interval for the interactive query. Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59", "location": "query", "type": "string" }, "timeUnit": { - "description": "A value of second, minute, hour, day, week, month.\nTime Unit specifies the granularity of metrics returned.", + "description": "A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.", "location": "query", "type": "string" }, "topk": { - "description": "Take 'top k' results from results, for example, to return the top 5\nresults 'topk=5'.", + "description": "Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.", "location": "query", "type": "string" }, "tsAscending": { - "description": "Lists timestamps in ascending order if set to true. Recommend setting\nthis value to true if you are using sortby with sort=DESC.", + "description": "Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.", "location": "query", "type": "boolean" }, @@ -4523,12 +4523,12 @@ ], "parameters": { "name": { - "description": "Optional. The ID to give the TargetServer. This will overwrite the\nvalue in TargetServer.", + "description": "Optional. The ID to give the TargetServer. This will overwrite the value in TargetServer.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent environment name under which the TargetServer will\nbe created. Must be of the form `organizations/{org}/environments/{env}`.", + "description": "Required. The parent environment name under which the TargetServer will be created. Must be of the form `organizations/{org}/environments/{env}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -4547,7 +4547,7 @@ ] }, "delete": { - "description": "Deletes a TargetServer from an environment. Returns the deleted\nTargetServer resource.", + "description": "Deletes a TargetServer from an environment. Returns the deleted TargetServer resource.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}", "httpMethod": "DELETE", "id": "apigee.organizations.environments.targetservers.delete", @@ -4556,7 +4556,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the TargetServer to delete. Must be\nof the form\n`organizations/{org}/environments/{env}/targetservers/{target_server_id}`.", + "description": "Required. The name of the TargetServer to delete. Must be of the form `organizations/{org}/environments/{env}/targetservers/{target_server_id}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/targetservers/[^/]+$", "required": true, @@ -4581,7 +4581,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the TargetServer to get. Must be of the form\n`organizations/{org}/environments/{env}/targetservers/{target_server_id}`.", + "description": "Required. The name of the TargetServer to get. Must be of the form `organizations/{org}/environments/{env}/targetservers/{target_server_id}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/targetservers/[^/]+$", "required": true, @@ -4597,7 +4597,7 @@ ] }, "update": { - "description": "Updates an existing TargetServer. Note that this operation has PUT\nsemantics; it will replace the entirety of the existing TargetServer with\nthe resource in the request body.", + "description": "Updates an existing TargetServer. Note that this operation has PUT semantics; it will replace the entirety of the existing TargetServer with the resource in the request body.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}", "httpMethod": "PUT", "id": "apigee.organizations.environments.targetservers.update", @@ -4606,7 +4606,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the TargetServer to replace. Must be of the form\n`organizations/{org}/environments/{env}/targetservers/{target_server_id}`.", + "description": "Required. The name of the TargetServer to replace. Must be of the form `organizations/{org}/environments/{env}/targetservers/{target_server_id}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/targetservers/[^/]+$", "required": true, @@ -4631,7 +4631,7 @@ "instances": { "methods": { "create": { - "description": "Creates an Apigee runtime instance. The instance is accessible from the\nauthorized network configured on the organization.\n\n**Note:** Not supported for Apigee hybrid.", + "description": "Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. **Note:** Not supported for Apigee hybrid.", "flatPath": "v1/organizations/{organizationsId}/instances", "httpMethod": "POST", "id": "apigee.organizations.instances.create", @@ -4640,7 +4640,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the organization. Use the following structure in your request:\n `organizations/{org}`.", + "description": "Required. Name of the organization. Use the following structure in your request: `organizations/{org}`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -4659,7 +4659,7 @@ ] }, "delete": { - "description": "Deletes an Apigee runtime instance. The instance stops serving\nrequests and the runtime data is deleted.\n\n**Note:** Not supported for Apigee hybrid.", + "description": "Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. **Note:** Not supported for Apigee hybrid.", "flatPath": "v1/organizations/{organizationsId}/instances/{instancesId}", "httpMethod": "DELETE", "id": "apigee.organizations.instances.delete", @@ -4668,7 +4668,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the instance. Use the following structure in your request:\n `organizations/{org}/instance/{instance}`.", + "description": "Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instance/{instance}`.", "location": "path", "pattern": "^organizations/[^/]+/instances/[^/]+$", "required": true, @@ -4684,7 +4684,7 @@ ] }, "get": { - "description": "Gets the details for an Apigee runtime instance.\n\n**Note:** Not supported for Apigee hybrid.", + "description": "Gets the details for an Apigee runtime instance. **Note:** Not supported for Apigee hybrid.", "flatPath": "v1/organizations/{organizationsId}/instances/{instancesId}", "httpMethod": "GET", "id": "apigee.organizations.instances.get", @@ -4693,7 +4693,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the instance. Use the following structure in your request:\n `organizations/{org}/instances/{instance}`.", + "description": "Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`.", "location": "path", "pattern": "^organizations/[^/]+/instances/[^/]+$", "required": true, @@ -4709,7 +4709,7 @@ ] }, "list": { - "description": "Lists all Apigee runtime instances for the organization.\n\n**Note:** Not supported for Apigee hybrid.", + "description": "Lists all Apigee runtime instances for the organization. **Note:** Not supported for Apigee hybrid.", "flatPath": "v1/organizations/{organizationsId}/instances", "httpMethod": "GET", "id": "apigee.organizations.instances.list", @@ -4724,12 +4724,12 @@ "type": "integer" }, "pageToken": { - "description": "Page token, returned from a previous ListInstances call, that you can\nuse to retrieve the next page of content.", + "description": "Page token, returned from a previous ListInstances call, that you can use to retrieve the next page of content.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Name of the organization. Use the following structure in your request:\n `organizations/{org}`.", + "description": "Required. Name of the organization. Use the following structure in your request: `organizations/{org}`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -4754,7 +4754,7 @@ ], "parameters": { "instance": { - "description": "The name of the instance reporting this status. For SaaS the request\nwill be rejected if no instance exists under this name.\nFormat is organizations/{org}/instances/{instance}", + "description": "The name of the instance reporting this status. For SaaS the request will be rejected if no instance exists under this name. Format is organizations/{org}/instances/{instance}", "location": "path", "pattern": "^organizations/[^/]+/instances/[^/]+$", "required": true, @@ -4777,7 +4777,7 @@ "attachments": { "methods": { "create": { - "description": "Creates a new attachment of an environment to an instance.\n\n**Note:** Not supported for Apigee hybrid.", + "description": "Creates a new attachment of an environment to an instance. **Note:** Not supported for Apigee hybrid.", "flatPath": "v1/organizations/{organizationsId}/instances/{instancesId}/attachments", "httpMethod": "POST", "id": "apigee.organizations.instances.attachments.create", @@ -4786,7 +4786,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the instance. Use the following structure in your request:\n `organizations/{org}/instances/{instance}`.", + "description": "Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`.", "location": "path", "pattern": "^organizations/[^/]+/instances/[^/]+$", "required": true, @@ -4805,7 +4805,7 @@ ] }, "delete": { - "description": "Deletes an attachment.\n\n**Note:** Not supported for Apigee hybrid.", + "description": "Deletes an attachment. **Note:** Not supported for Apigee hybrid.", "flatPath": "v1/organizations/{organizationsId}/instances/{instancesId}/attachments/{attachmentsId}", "httpMethod": "DELETE", "id": "apigee.organizations.instances.attachments.delete", @@ -4814,7 +4814,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the attachment. Use the following structure in your request:\n `organizations/{org}/instances/{instance}/attachments/{attachment}`.", + "description": "Required. Name of the attachment. Use the following structure in your request: `organizations/{org}/instances/{instance}/attachments/{attachment}`.", "location": "path", "pattern": "^organizations/[^/]+/instances/[^/]+/attachments/[^/]+$", "required": true, @@ -4830,7 +4830,7 @@ ] }, "get": { - "description": "Gets an attachment.\n\n**Note:** Not supported for Apigee hybrid.", + "description": "Gets an attachment. **Note:** Not supported for Apigee hybrid.", "flatPath": "v1/organizations/{organizationsId}/instances/{instancesId}/attachments/{attachmentsId}", "httpMethod": "GET", "id": "apigee.organizations.instances.attachments.get", @@ -4839,7 +4839,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the attachment. Use the following structure in your request:\n `organizations/{org}/instances/{instance}/attachments/{attachment}`", + "description": "Required. Name of the attachment. Use the following structure in your request: `organizations/{org}/instances/{instance}/attachments/{attachment}`", "location": "path", "pattern": "^organizations/[^/]+/instances/[^/]+/attachments/[^/]+$", "required": true, @@ -4855,7 +4855,7 @@ ] }, "list": { - "description": "Lists all attachments to an instance.\n\n**Note:** Not supported for Apigee hybrid.", + "description": "Lists all attachments to an instance. **Note:** Not supported for Apigee hybrid.", "flatPath": "v1/organizations/{organizationsId}/instances/{instancesId}/attachments", "httpMethod": "GET", "id": "apigee.organizations.instances.attachments.list", @@ -4870,12 +4870,12 @@ "type": "integer" }, "pageToken": { - "description": "Page token, returned by a previous ListInstanceAttachments call, that you\ncan use to retrieve the next page of content.", + "description": "Page token, returned by a previous ListInstanceAttachments call, that you can use to retrieve the next page of content.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Name of the organization. Use the following structure in your request:\n `organizations/{org}/instances/{instance}`", + "description": "Required. Name of the organization. Use the following structure in your request: `organizations/{org}/instances/{instance}`", "location": "path", "pattern": "^organizations/[^/]+/instances/[^/]+$", "required": true, @@ -4906,7 +4906,7 @@ ], "parameters": { "parent": { - "description": "Required. The name of the organization in which to create the key value map\nfile. Must be of the form `organizations/{organization}`.", + "description": "Required. The name of the organization in which to create the key value map file. Must be of the form `organizations/{organization}`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -4934,7 +4934,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the key value map.\nMust be of the form\n`organizations/{organization}/keyvaluemaps/{keyvaluemap}`.", + "description": "Required. The name of the key value map. Must be of the form `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.", "location": "path", "pattern": "^organizations/[^/]+/keyvaluemaps/[^/]+$", "required": true, @@ -4954,7 +4954,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": "v1/organizations/{organizationsId}/operations/{operationsId}", "httpMethod": "GET", "id": "apigee.organizations.operations.get", @@ -4979,7 +4979,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/organizations/{organizationsId}/operations", "httpMethod": "GET", "id": "apigee.organizations.operations.list", @@ -5024,7 +5024,7 @@ "reports": { "methods": { "create": { - "description": "Creates a Custom Report for an Organization. A Custom Report\nprovides Apigee Customers to create custom dashboards in addition\nto the standard dashboards which are provided. The Custom Report in its\nsimplest form contains specifications about metrics, dimensions and\nfilters. It is important to note that the custom report by itself does not\nprovide an executable entity. The Edge UI converts the custom report\ndefinition into an analytics query and displays the result in a chart.", + "description": "Creates a Custom Report for an Organization. A Custom Report provides Apigee Customers to create custom dashboards in addition to the standard dashboards which are provided. The Custom Report in its simplest form contains specifications about metrics, dimensions and filters. It is important to note that the custom report by itself does not provide an executable entity. The Edge UI converts the custom report definition into an analytics query and displays the result in a chart.", "flatPath": "v1/organizations/{organizationsId}/reports", "httpMethod": "POST", "id": "apigee.organizations.reports.create", @@ -5033,7 +5033,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent organization name under which the Custom Report will\nbe created. Must be of the form:\n `organizations/{organization_id}/reports`", + "description": "Required. The parent organization name under which the Custom Report will be created. Must be of the form: `organizations/{organization_id}/reports`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -5061,7 +5061,7 @@ ], "parameters": { "name": { - "description": "Required. Custom Report name of the form:\n `organizations/{organization_id}/reports/{report_name}`", + "description": "Required. Custom Report name of the form: `organizations/{organization_id}/reports/{report_name}`", "location": "path", "pattern": "^organizations/[^/]+/reports/[^/]+$", "required": true, @@ -5086,7 +5086,7 @@ ], "parameters": { "name": { - "description": "Required. Custom Report name of the form:\n `organizations/{organization_id}/reports/{report_name}`", + "description": "Required. Custom Report name of the form: `organizations/{organization_id}/reports/{report_name}`", "location": "path", "pattern": "^organizations/[^/]+/reports/[^/]+$", "required": true, @@ -5116,7 +5116,7 @@ "type": "boolean" }, "parent": { - "description": "Required. The parent organization name under which the API product will\nbe listed\n `organizations/{organization_id}/reports`", + "description": "Required. The parent organization name under which the API product will be listed `organizations/{organization_id}/reports`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -5141,7 +5141,7 @@ ], "parameters": { "name": { - "description": "Required. Custom Report name of the form:\n `organizations/{organization_id}/reports/{report_name}`", + "description": "Required. Custom Report name of the form: `organizations/{organization_id}/reports/{report_name}`", "location": "path", "pattern": "^organizations/[^/]+/reports/[^/]+$", "required": true, @@ -5164,7 +5164,7 @@ "sharedflows": { "methods": { "create": { - "description": "Uploads a ZIP-formatted shared flow configuration bundle to an\norganization. If the shared flow already exists, this creates a new\nrevision of it. If the shared flow does not exist, this creates it.\n\nOnce imported, the shared flow revision must be deployed before it can be\naccessed at runtime.\n\nThe size limit of a shared flow bundle is 15 MB.", + "description": "Uploads a ZIP-formatted shared flow configuration bundle to an organization. If the shared flow already exists, this creates a new revision of it. If the shared flow does not exist, this creates it. Once imported, the shared flow revision must be deployed before it can be accessed at runtime. The size limit of a shared flow bundle is 15 MB.", "flatPath": "v1/organizations/{organizationsId}/sharedflows", "httpMethod": "POST", "id": "apigee.organizations.sharedflows.create", @@ -5183,7 +5183,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the parent organization under which to create the\nshared flow. Must be of the form:\n `organizations/{organization_id}`", + "description": "Required. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -5202,7 +5202,7 @@ ] }, "delete": { - "description": "Deletes a shared flow and all it's revisions. The shared flow must be\nundeployed before you can delete it.", + "description": "Deletes a shared flow and all it's revisions. The shared flow must be undeployed before you can delete it.", "flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}", "httpMethod": "DELETE", "id": "apigee.organizations.sharedflows.delete", @@ -5211,7 +5211,7 @@ ], "parameters": { "name": { - "description": "Required. shared flow name of the form:\n `organizations/{organization_id}/sharedflows/{shared_flow_id}`", + "description": "Required. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`", "location": "path", "pattern": "^organizations/[^/]+/sharedflows/[^/]+$", "required": true, @@ -5236,7 +5236,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the shared flow to get. Must be of the\nform:\n `organizations/{organization_id}/sharedflows/{shared_flow_id}`", + "description": "Required. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`", "location": "path", "pattern": "^organizations/[^/]+/sharedflows/[^/]+$", "required": true, @@ -5271,7 +5271,7 @@ "type": "boolean" }, "parent": { - "description": "Required. The name of the parent organization under which to get shared\nflows. Must be of the form:\n `organizations/{organization_id}`", + "description": "Required. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -5300,7 +5300,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the shared flow for which to return deployment information in the\nfollowing format:\n `organizations/{org}/sharedflows/{sharedflow}`", + "description": "Required. Name of the shared flow for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}`", "location": "path", "pattern": "^organizations/[^/]+/sharedflows/[^/]+$", "required": true, @@ -5320,7 +5320,7 @@ "revisions": { "methods": { "delete": { - "description": "Deletes a shared flow and all associated policies, resources, and\nrevisions. You must undeploy the shared flow before deleting it.", + "description": "Deletes a shared flow and all associated policies, resources, and revisions. You must undeploy the shared flow before deleting it.", "flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}", "httpMethod": "DELETE", "id": "apigee.organizations.sharedflows.revisions.delete", @@ -5329,7 +5329,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the shared flow revision to delete. Must be of the\nform:\n `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`", + "description": "Required. The name of the shared flow revision to delete. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`", "location": "path", "pattern": "^organizations/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", "required": true, @@ -5345,7 +5345,7 @@ ] }, "get": { - "description": "Gets a revision of a shared flow.\n\nIf `format=bundle` is passed, it instead outputs a shared flow revision as\na ZIP-formatted bundle of code and config files.", + "description": "Gets a revision of a shared flow. If `format=bundle` is passed, it instead outputs a shared flow revision as a ZIP-formatted bundle of code and config files.", "flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}", "httpMethod": "GET", "id": "apigee.organizations.sharedflows.revisions.get", @@ -5354,12 +5354,12 @@ ], "parameters": { "format": { - "description": "Specify `bundle` to export the contents of the shared flow bundle.\nOtherwise, the bundle metadata is returned.", + "description": "Specify `bundle` to export the contents of the shared flow bundle. Otherwise, the bundle metadata is returned.", "location": "query", "type": "string" }, "name": { - "description": "Required. The name of the shared flow revision to get. Must be of the\nform:\n `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`", + "description": "Required. The name of the shared flow revision to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`", "location": "path", "pattern": "^organizations/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", "required": true, @@ -5375,7 +5375,7 @@ ] }, "updateSharedFlowRevision": { - "description": "Updates a shared flow revision. This operation is only allowed on revisions\nwhich have never been deployed. After deployment a revision becomes\nimmutable, even if it becomes undeployed.\n\nThe payload is a ZIP-formatted shared flow. Content type must be either\nmultipart/form-data or application/octet-stream.", + "description": "Updates a shared flow revision. This operation is only allowed on revisions which have never been deployed. After deployment a revision becomes immutable, even if it becomes undeployed. The payload is a ZIP-formatted shared flow. Content type must be either multipart/form-data or application/octet-stream.", "flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}", "httpMethod": "POST", "id": "apigee.organizations.sharedflows.revisions.updateSharedFlowRevision", @@ -5384,14 +5384,14 @@ ], "parameters": { "name": { - "description": "Required. The name of the shared flow revision to update.\nMust be of the form:\n `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`", + "description": "Required. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`", "location": "path", "pattern": "^organizations/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", "required": true, "type": "string" }, "validate": { - "description": "Ignored. All uploads are validated regardless of the value of this field.\nIt is kept for compatibility with existing APIs. Must be `true` or `false`\nif provided.", + "description": "Ignored. All uploads are validated regardless of the value of this field. It is kept for compatibility with existing APIs. Must be `true` or `false` if provided.", "location": "query", "type": "boolean" } @@ -5421,7 +5421,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the API proxy revision for which to return deployment information\nin the following format:\n `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`.", + "description": "Required. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`.", "location": "path", "pattern": "^organizations/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", "required": true, @@ -5445,11 +5445,11 @@ } } }, - "revision": "20200720", + "revision": "20200801", "rootUrl": "https://apigee.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": { @@ -5462,7 +5462,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.", @@ -5491,7 +5491,7 @@ "type": "object" }, "GoogleCloudApigeeV1AccessGet": { - "description": "Get action. For example,\n\"Get\" : {\n \"name\" : \"target.name\",\n \"value\" : \"default\"\n}", + "description": "Get action. For example, \"Get\" : { \"name\" : \"target.name\", \"value\" : \"default\" }", "id": "GoogleCloudApigeeV1AccessGet", "properties": { "name": { @@ -5504,7 +5504,7 @@ "type": "object" }, "GoogleCloudApigeeV1AccessRemove": { - "description": "Remove action. For example,\n\"Remove\" : {\n \"name\" : \"target.name\",\n \"success\" : true\n}", + "description": "Remove action. For example, \"Remove\" : { \"name\" : \"target.name\", \"success\" : true }", "id": "GoogleCloudApigeeV1AccessRemove", "properties": { "name": { @@ -5517,7 +5517,7 @@ "type": "object" }, "GoogleCloudApigeeV1AccessSet": { - "description": "Set action. For example,\n\"Set\" : {\n \"name\" : \"target.name\",\n \"success\" : true,\n \"value\" : \"default\"\n}", + "description": "Set action. For example, \"Set\" : { \"name\" : \"target.name\", \"success\" : true, \"value\" : \"default\" }", "id": "GoogleCloudApigeeV1AccessSet", "properties": { "name": { @@ -5537,7 +5537,7 @@ "id": "GoogleCloudApigeeV1Alias", "properties": { "alias": { - "description": "The resource ID for this alias. Values must match regular expression\n`[^/]{1,255}`.", + "description": "The resource ID for this alias. Values must match regular expression `[^/]{1,255}`.", "type": "string" }, "certsInfo": { @@ -5569,7 +5569,7 @@ "type": "string" }, "name": { - "description": "The name of the alias revision included in the keystore. Must be of the\nform:\n'organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}'.", + "description": "The name of the alias revision included in the keystore. Must be of the form: 'organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}'.", "type": "string" }, "type": { @@ -5592,61 +5592,61 @@ "id": "GoogleCloudApigeeV1ApiProduct", "properties": { "apiResources": { - "description": "Comma-separated list of API resources to be bundled in the API Product.\n\nBy default, the resource paths are mapped from the `proxy.pathsuffix`\nvariable.\n\nThe proxy path suffix is defined as the URI fragment following the\nProxyEndpoint base path.\nFor example, if the `apiResources` element is defined to be\n`/forecastrss` and the base path defined for the API proxy is\n`/weather`, then only requests to `/weather/forecastrss` are permitted by\nthe API product.\n\nYou can select a specific path, or you can select all subpaths with the\nfollowing wildcard:\n\n- /**: Indicates that all sub-URIs are included.\n- /* : Indicates that only URIs one level down are included.\n\nBy default, / supports the same resources as /** as well as the base path\ndefined by the API proxy.\n\nFor example, if the base path of the API proxy is `/v1/weatherapikey`,\nthen the API product supports requests to `/v1/weatherapikey` and to any\nsub-URIs, such as `/v1/weatherapikey/forecastrss`,\n`/v1/weatherapikey/region/CA`, and so on.\nFor more information, see:\n\n- Manage API\nproducts\n- Managing\na transaction recording policy using the API", + "description": "Comma-separated list of API resources to be bundled in the API Product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - /**: Indicates that all sub-URIs are included. - /* : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see: - Manage API products - Managing a transaction recording policy using the API", "items": { "type": "string" }, "type": "array" }, "approvalType": { - "description": "Specifies how API keys are approved to access the APIs defined by the API\nproduct.\n\nIf set to `manual`, the consumer key is generated and returned in \"pending\"\nstate. In this case, the API keys won't work until they have been\nexplicitly approved.\n\nIf set to `auto`, the consumer key is generated and returned in \"approved\"\nstate and can be used immediately.\n\n", + "description": "Specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in \"pending\" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in \"approved\" state and can be used immediately. *NOTE:* Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities.", "type": "string" }, "attributes": { - "description": "Array of attributes that may be used to extend the default API product\nprofile with customer-specific metadata. You can specify a maximum of 18\nattributes.\n\nUse this property to specify the access level of the API product as either\n`public`, `private`, or `internal`.\n\nOnly products marked `public` are available to developers in the Apigee\ndeveloper portal. For example, you can set a product to `internal` while it\nis in development and then change access to `public` when it is ready to\nrelease on the portal.\n\nAPI products marked as `private` do not appear on the portal but\ncan be accessed by external developers.\n\nFor monetization, you can use the attributes field to:\n\n- Specify transaction success criteria\n- Specify custom attributes on which you base rate plan\ncharges.", + "description": "Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal but can be accessed by external developers. For monetization, you can use the attributes field to: - Specify transaction success criteria - Specify custom attributes on which you base rate plan charges.", "items": { "$ref": "GoogleCloudApigeeV1Attribute" }, "type": "array" }, "createdAt": { - "description": "Response only. Creation time of this environment as milliseconds since\nepoch.", + "description": "Response only. Creation time of this environment as milliseconds since epoch.", "format": "int64", "type": "string" }, "description": { - "description": "An overview of the API product. Include key information about the API\nproduct that is not captured by other fields.", + "description": "An overview of the API product. Include key information about the API product that is not captured by other fields.", "type": "string" }, "displayName": { - "description": "The name to be displayed in the UI or developer portal to developers\nregistering for API access.", + "description": "The name to be displayed in the UI or developer portal to developers registering for API access.", "type": "string" }, "environments": { - "description": "A comma-separated list of environment names to which the API product is\nbound. Requests to environments that are not listed are rejected.\n\nBy specifying one or more environments, you can bind the resources listed\nin the API product to a specific environment, preventing developers from\naccessing those resources through API proxies deployed in another\nenvironment.\n\nThis setting is used, for example, to prevent resources associated with\nAPI proxies in 'prod' from being accessed by API proxies deployed in\n'test'.", + "description": "A comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in 'prod' from being accessed by API proxies deployed in 'test'.", "items": { "type": "string" }, "type": "array" }, "lastModifiedAt": { - "description": "Response only. Modified time of this environment as milliseconds since\nepoch.", + "description": "Response only. Modified time of this environment as milliseconds since epoch.", "format": "int64", "type": "string" }, "name": { - "description": "The internal name of the API Product. Characters you can use in the name\nare restricted to: A-Z0-9._\\-$ %.\n\n", + "description": "The internal name of the API Product. Characters you can use in the name are restricted to: A-Z0-9._\\-$ %. *NOTE:* The internal name cannot be edited when updating the API product.", "type": "string" }, "proxies": { - "description": "A comma-separated list of API proxy names to which this API product is\nbound. By specifying API proxies, you can associate resources in the API\nproduct with specific API proxies, preventing developers from accessing\nthose resources through other API proxies.\n\nEdge rejects requests to API proxies that are not listed.\n\n", + "description": "A comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Edge rejects requests to API proxies that are not listed. *NOTE:* The API proxy names must already exist in the specified environment as they will be validated upon creation.", "items": { "type": "string" }, "type": "array" }, "quota": { - "description": "The number of request messages permitted per app by this API product for\nthe specified `quotaInterval` and `quotaTimeUnit`.\n\nFor example, a `quota` of 50, for a `quotaInterval` of 12 and a\n`quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.", + "description": "The number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.", "type": "string" }, "quotaInterval": { @@ -5654,11 +5654,11 @@ "type": "string" }, "quotaTimeUnit": { - "description": "The time unit defined for the `quotaInterval`. Valid values include minute,\nhour, day, or month.", + "description": "The time unit defined for the `quotaInterval`. Valid values include minute, hour, day, or month.", "type": "string" }, "scopes": { - "description": "A comma-separated list of OAuth scopes that are validated at runtime.\nEdge validates that the scopes in any access token presented match the\nscopes defined in the OAuth policy assoicated with the API product.", + "description": "A comma-separated list of OAuth scopes that are validated at runtime. Edge validates that the scopes in any access token presented match the scopes defined in the OAuth policy assoicated with the API product.", "items": { "type": "string" }, @@ -5720,14 +5720,14 @@ }, "configurationVersion": { "$ref": "GoogleCloudApigeeV1ConfigVersion", - "description": "Version of the API proxy configuration schema to which the API proxy\nconforms. Currently, the only supported value is 4.0\n(`majorVersion.minorVersion`). This setting may be used in the future to\ntrack the evolution of the API proxy format." + "description": "Version of the API proxy configuration schema to which the API proxy conforms. Currently, the only supported value is 4.0 (`majorVersion.minorVersion`). This setting may be used in the future to track the evolution of the API proxy format." }, "contextInfo": { "description": "Revision number, app name, and organization for the API proxy.", "type": "string" }, "createdAt": { - "description": "Time that the API proxy revision was created in milliseconds since\nepoch.", + "description": "Time that the API proxy revision was created in milliseconds since epoch.", "format": "int64", "type": "string" }, @@ -5747,7 +5747,7 @@ "type": "object" }, "lastModifiedAt": { - "description": "Time that the API proxy revision was last modified in\nmilliseconds since epoch.", + "description": "Time that the API proxy revision was last modified in milliseconds since epoch.", "format": "int64", "type": "string" }, @@ -5770,7 +5770,7 @@ "type": "array" }, "proxyEndpoints": { - "description": "List of ProxyEndpoints in the `/proxies` directory of the API proxy.\nTypically, this element is included only when the API proxy was created\nusing the Edge UI. This is a 'manifest' setting designed to\nprovide visibility into the contents of the API proxy.", + "description": "List of ProxyEndpoints in the `/proxies` directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.", "items": { "type": "string" }, @@ -5781,7 +5781,7 @@ "description": "List of resource files included in the API proxy revision." }, "resources": { - "description": "List of the resources included in the API proxy revision formatted as\n\"{type}://{name}\".", + "description": "List of the resources included in the API proxy revision formatted as \"{type}://{name}\".", "items": { "type": "string" }, @@ -5799,18 +5799,18 @@ "type": "array" }, "spec": { - "description": "OpenAPI Specification that is associated with the API proxy.\nThe value is set to a URL or to a path in the specification store.", + "description": "OpenAPI Specification that is associated with the API proxy. The value is set to a URL or to a path in the specification store.", "type": "string" }, "targetEndpoints": { - "description": "List of TargetEndpoints in the `/targets` directory of the API proxy.\nTypically, this element is included only when the API proxy was created\nusing the Edge UI. This is a 'manifest' setting designed to\nprovide visibility into the contents of the API proxy.", + "description": "List of TargetEndpoints in the `/targets` directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.", "items": { "type": "string" }, "type": "array" }, "targetServers": { - "description": "List of TargetServers referenced in any TargetEndpoint in the API\nproxy. Typically, you will see this element only when the API proxy was\ncreated using the Edge UI. This is a 'manifest' setting\ndesigned to provide visibility into the contents of the API proxy.", + "description": "List of TargetServers referenced in any TargetEndpoint in the API proxy. Typically, you will see this element only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy.", "items": { "type": "string" }, @@ -5831,7 +5831,7 @@ "type": "array" }, "type": { - "description": "Type. Set to `Application`. Maintained for compatibility with\nthe Apigee Edge API.", + "description": "Type. Set to `Application`. Maintained for compatibility with the Apigee Edge API.", "type": "string" } }, @@ -5859,7 +5859,7 @@ "type": "array" }, "callbackUrl": { - "description": "Callback URL used by OAuth 2.0 authorization servers to communicate\nauthorization codes back to apps.", + "description": "Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps.", "type": "string" }, "companyName": { @@ -5869,27 +5869,30 @@ "createdAt": { "description": "Output only. Unix time when the app was created.", "format": "int64", + "readOnly": true, "type": "string" }, "credentials": { - "description": "Output only. Set of credentials for the app. Credentials are API\nkey/secret pairs associated with API products.", + "description": "Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products.", "items": { "$ref": "GoogleCloudApigeeV1Credential" }, + "readOnly": true, "type": "array" }, "developerId": { - "description": "ID of the developer.", + "description": "ID of the developer.", "type": "string" }, "keyExpiresIn": { - "description": "Duration, in milliseconds, of the consumer key that will\nbe generated for the app. The default value, -1, indicates an\ninfinite validity period. Once set, the expiration can't be updated.\njson key: keyExpiresIn", + "description": "Duration, in milliseconds, of the consumer key that will be generated for the app. The default value, -1, indicates an infinite validity period. Once set, the expiration can't be updated. json key: keyExpiresIn", "format": "int64", "type": "string" }, "lastModifiedAt": { "description": "Output only. Last modified time as milliseconds since epoch.", "format": "int64", + "readOnly": true, "type": "string" }, "name": { @@ -5897,7 +5900,7 @@ "type": "string" }, "scopes": { - "description": "Scopes to apply to the app. The specified scope names must already\nexist on the API product that you associate with the app.", + "description": "Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app.", "items": { "type": "string" }, @@ -5951,7 +5954,7 @@ "type": "string" }, "self": { - "description": "Self link of the query.\n\nExample:\n`/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd`", + "description": "Self link of the query. Example: `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd`", "type": "string" }, "state": { @@ -5973,7 +5976,7 @@ "type": "string" }, "self": { - "description": "Self link of the query results.\n\nExample:\n`/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result`", + "description": "Self link of the query results. Example: `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result`", "type": "string" } }, @@ -6021,7 +6024,7 @@ "type": "string" }, "isValid": { - "description": "\"Yes\" if certificate is valid, \"No\" if expired and \"Not yet\"\nif not yet valid.", + "description": "\"Yes\" if certificate is valid, \"No\" if expired and \"Not yet\" if not yet valid.", "type": "string" }, "issuer": { @@ -6052,7 +6055,7 @@ "type": "array" }, "validFrom": { - "description": "The X.509 validity / notBefore in milliseconds since the\nepoch.", + "description": "The X.509 validity / notBefore in milliseconds since the epoch.", "format": "int64", "type": "string" }, @@ -6090,7 +6093,7 @@ "type": "object" }, "GoogleCloudApigeeV1ConfigVersion": { - "description": "Version of the API proxy configuration schema. Currently, only 4.0 is\nsupported.", + "description": "Version of the API proxy configuration schema. Currently, only 4.0 is supported.", "id": "GoogleCloudApigeeV1ConfigVersion", "properties": { "majorVersion": { @@ -6142,7 +6145,7 @@ "type": "string" }, "scopes": { - "description": "List of scopes to apply to the app. Specified scopes must already\nexist on the API product that you associate with the app.", + "description": "List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.", "items": { "type": "string" }, @@ -6163,15 +6166,16 @@ "type": "string" }, "comments": { - "description": "Legacy field: not used. This field contains a list of comments associated\nwith custom report", + "description": "Legacy field: not used. This field contains a list of comments associated with custom report", "items": { "type": "string" }, "type": "array" }, "createdAt": { - "description": "Output only. Unix time when the app was created\njson key: createdAt", + "description": "Output only. Unix time when the app was created json key: createdAt", "format": "int64", + "readOnly": true, "type": "string" }, "dimensions": { @@ -6187,6 +6191,7 @@ }, "environment": { "description": "Output only. Environment name", + "readOnly": true, "type": "string" }, "filter": { @@ -6198,17 +6203,19 @@ "type": "string" }, "lastModifiedAt": { - "description": "Output only. Modified time of this entity as milliseconds since epoch.\njson key: lastModifiedAt", + "description": "Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt", "format": "int64", + "readOnly": true, "type": "string" }, "lastViewedAt": { "description": "Output only. Last viewed time of this entity as milliseconds since epoch", "format": "int64", + "readOnly": true, "type": "string" }, "limit": { - "description": "Legacy field: not used This field contains the limit for the result\nretrieved", + "description": "Legacy field: not used This field contains the limit for the result retrieved", "type": "string" }, "metrics": { @@ -6219,7 +6226,7 @@ "type": "array" }, "name": { - "description": "Required. Unique identifier for the report\nT his is a legacy field used to encode custom report unique id", + "description": "Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id", "type": "string" }, "offset": { @@ -6228,6 +6235,7 @@ }, "organization": { "description": "Output only. Organization name", + "readOnly": true, "type": "string" }, "properties": { @@ -6249,7 +6257,7 @@ "type": "string" }, "tags": { - "description": "Legacy field: not used. This field contains a list of tags associated with\ncustom report", + "description": "Legacy field: not used. This field contains a list of tags associated with custom report", "items": { "type": "string" }, @@ -6264,14 +6272,14 @@ "type": "string" }, "topk": { - "description": "Legacy field: not used. This field contains the top k parameter value\nfor restricting the result", + "description": "Legacy field: not used. This field contains the top k parameter value for restricting the result", "type": "string" } }, "type": "object" }, "GoogleCloudApigeeV1CustomReportMetric": { - "description": "This encapsulates a metric property of the form sum(message_count)\nwhere name is message_count and function is sum", + "description": "This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum", "id": "GoogleCloudApigeeV1CustomReportMetric", "properties": { "function": { @@ -6290,7 +6298,7 @@ "id": "GoogleCloudApigeeV1DataCollectorConfig", "properties": { "name": { - "description": "The name of the data collector. Must be of the form\n'organizations/{org}/datacollectors/{dc}'.", + "description": "The name of the data collector. Must be of the form 'organizations/{org}/datacollectors/{dc}'.", "type": "string" }, "type": { @@ -6317,12 +6325,13 @@ "type": "object" }, "GoogleCloudApigeeV1Datastore": { - "description": "The data store defines the connection to export data repository\n(Cloud Storage, BigQuery), including the credentials used to access the data\nrepository.", + "description": "The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.", "id": "GoogleCloudApigeeV1Datastore", "properties": { "createTime": { - "description": "Output only. Datastore create time, in milliseconds since the epoch\nof 1970-01-01T00:00:00Z", + "description": "Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z", "format": "int64", + "readOnly": true, "type": "string" }, "datastoreConfig": { @@ -6334,20 +6343,23 @@ "type": "string" }, "lastUpdateTime": { - "description": "Output only. Datastore last update time, in milliseconds since the epoch\nof 1970-01-01T00:00:00Z", + "description": "Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z", "format": "int64", + "readOnly": true, "type": "string" }, "org": { "description": "Output only. Organization that the datastore belongs to", + "readOnly": true, "type": "string" }, "self": { - "description": "Output only. Resource link of Datastore.\n\nExample: `/organizations/{org}/analytics/datastores/{uuid}`", + "description": "Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}`", + "readOnly": true, "type": "string" }, "targetType": { - "description": "Destination storage type.\nSupported types `gcs` or `bigquery`.", + "description": "Destination storage type. Supported types `gcs` or `bigquery`.", "type": "string" } }, @@ -6358,15 +6370,15 @@ "id": "GoogleCloudApigeeV1DatastoreConfig", "properties": { "bucketName": { - "description": "Name of the Cloud Storage bucket.\nRequired for `gcs` target_type.", + "description": "Name of the Cloud Storage bucket. Required for `gcs` target_type.", "type": "string" }, "datasetName": { - "description": "BigQuery dataset name\nRequired for `bigquery` target_type.", + "description": "BigQuery dataset name Required for `bigquery` target_type.", "type": "string" }, "path": { - "description": "Path of Cloud Storage bucket\nRequired for `gcs` target_type.", + "description": "Path of Cloud Storage bucket Required for `gcs` target_type.", "type": "string" }, "projectId": { @@ -6374,7 +6386,7 @@ "type": "string" }, "tablePrefix": { - "description": "Prefix of BigQuery table\nRequired for `bigquery` target_type.", + "description": "Prefix of BigQuery table Required for `bigquery` target_type.", "type": "string" } }, @@ -6385,11 +6397,11 @@ "id": "GoogleCloudApigeeV1DateRange", "properties": { "end": { - "description": "Required. End date (exclusive) of the data to export in the format `yyyy-mm-dd`.\nThe date range ends at 00:00:00 UTC on the end date- which will not be in\nthe output.", + "description": "Required. End date (exclusive) of the data to export in the format `yyyy-mm-dd`. The date range ends at 00:00:00 UTC on the end date- which will not be in the output.", "type": "string" }, "start": { - "description": "Required. Start date of the data to export in the format `yyyy-mm-dd`.\nThe date range begins at 00:00:00 UTC on the start date.", + "description": "Required. Start date of the data to export in the format `yyyy-mm-dd`. The date range begins at 00:00:00 UTC on the start date.", "type": "string" } }, @@ -6399,14 +6411,14 @@ "id": "GoogleCloudApigeeV1DebugMask", "properties": { "faultJSONPaths": { - "description": "List of JSON paths that specify the JSON elements to be filtered from JSON\npayloads in error flows.", + "description": "List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows.", "items": { "type": "string" }, "type": "array" }, "faultXPaths": { - "description": "List of XPaths that specify the XML elements to be filtered from XML\npayloads in error flows.", + "description": "List of XPaths that specify the XML elements to be filtered from XML payloads in error flows.", "items": { "type": "string" }, @@ -6424,28 +6436,28 @@ "type": "object" }, "requestJSONPaths": { - "description": "List of JSON paths that specify the JSON elements to be filtered from JSON\nrequest message payloads.", + "description": "List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads.", "items": { "type": "string" }, "type": "array" }, "requestXPaths": { - "description": "List of XPaths that specify the XML elements to be filtered from XML\nrequest message payloads.", + "description": "List of XPaths that specify the XML elements to be filtered from XML request message payloads.", "items": { "type": "string" }, "type": "array" }, "responseJSONPaths": { - "description": "List of JSON paths that specify the JSON elements to be filtered from JSON\nresponse message payloads.", + "description": "List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads.", "items": { "type": "string" }, "type": "array" }, "responseXPaths": { - "description": "List of XPaths that specify the XML elements to be filtered from XML\nresponse message payloads.", + "description": "List of XPaths that specify the XML elements to be filtered from XML response message payloads.", "items": { "type": "string" }, @@ -6465,12 +6477,12 @@ "id": "GoogleCloudApigeeV1DebugSession", "properties": { "count": { - "description": "Optional. The number of request to be traced. Min = 1, Max = 15, Default\n= 10.", + "description": "Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.", "format": "int32", "type": "integer" }, "filter": { - "description": "Optional. A conditional statement which is evaluated against the request\nmessage to determine if it should be traced. Syntax matches that of on\nAPI Proxy bundle flow Condition.", + "description": "Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.", "type": "string" }, "name": { @@ -6478,17 +6490,17 @@ "type": "string" }, "timeout": { - "description": "Optional. The time in seconds after which this DebugSession should end.\nThis value will override the value in query param, if both are provided.", + "description": "Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.", "format": "int64", "type": "string" }, "tracesize": { - "description": "Optional. The maximum number of bytes captured from the response payload.\nMin = 0, Max = 5120, Default = 5120.", + "description": "Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.", "format": "int32", "type": "integer" }, "validity": { - "description": "Optional. The length of time, in seconds, that this debug session is valid,\nstarting from when it's received in the control plane. Min = 1, Max = 15,\nDefault = 10.", + "description": "Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.", "format": "int32", "type": "integer" } @@ -6496,7 +6508,7 @@ "type": "object" }, "GoogleCloudApigeeV1DebugSessionTransaction": { - "description": "A transaction contains all of the debug information of the entire message\nflow of an API call processed by the runtime plane. The information is\ncollected and recorded at critical points of the message flow in the runtime\napiproxy.", + "description": "A transaction contains all of the debug information of the entire message flow of an API call processed by the runtime plane. The information is collected and recorded at critical points of the message flow in the runtime apiproxy.", "id": "GoogleCloudApigeeV1DebugSessionTransaction", "properties": { "completed": { @@ -6504,7 +6516,7 @@ "type": "boolean" }, "point": { - "description": "List of debug data collected by runtime plane at various defined points in\nthe flow.", + "description": "List of debug data collected by runtime plane at various defined points in the flow.", "items": { "$ref": "GoogleCloudApigeeV1Point" }, @@ -6535,7 +6547,7 @@ "type": "string" }, "deployStartTime": { - "description": "Time the API proxy was marked `deployed` in the control plane in\nmillisconds since epoch.", + "description": "Time the API proxy was marked `deployed` in the control plane in millisconds since epoch.", "format": "int64", "type": "string" }, @@ -6544,21 +6556,21 @@ "type": "string" }, "errors": { - "description": "Errors reported for this deployment. Populated only when state == ERROR.\nThis field is not populated in List APIs.", + "description": "Errors reported for this deployment. Populated only when state == ERROR. This field is not populated in List APIs.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "instances": { - "description": "Status reported by each runtime instance.\nThis field is not populated in List APIs.", + "description": "Status reported by each runtime instance. This field is not populated in List APIs.", "items": { "$ref": "GoogleCloudApigeeV1InstanceDeploymentStatus" }, "type": "array" }, "pods": { - "description": "Status reported by runtime pods. This field is not populated for List\nAPIs.", + "description": "Status reported by runtime pods. This field is not populated for List APIs.", "items": { "$ref": "GoogleCloudApigeeV1PodStatus" }, @@ -6569,14 +6581,14 @@ "type": "string" }, "routeConflicts": { - "description": "Conflicts in the desired state routing configuration. The presence of\nconflicts does not cause the state to be ERROR, but it will mean that\nsome of the deployments basepaths are not routed to its environment. If\nthe conflicts change, the state will transition to PROGRESSING until the\nlatest configuration is rolled out to all instances.\nThis field is not populated in List APIs.", + "description": "Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be ERROR, but it will mean that some of the deployments basepaths are not routed to its environment. If the conflicts change, the state will transition to PROGRESSING until the latest configuration is rolled out to all instances. This field is not populated in List APIs.", "items": { "$ref": "GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict" }, "type": "array" }, "state": { - "description": "Current state of the deployment.\nThis field is not populated in List APIs.", + "description": "Current state of the deployment. This field is not populated in List APIs.", "enum": [ "RUNTIME_STATE_UNSPECIFIED", "READY", @@ -6595,7 +6607,7 @@ "type": "object" }, "GoogleCloudApigeeV1DeploymentChangeReport": { - "description": "Response for\nGenerateDeployChangeReport\nand\nGenerateUndeployChangeReport.\n\nThis report contains any validation failures that would cause the deployment\nto be rejected, as well changes and conflicts in routing that may occur due\nto the new deployment.\n\nThe existence of a routing warning does not necessarily imply that the\ndeployment request is bad, if the desired state of the deployment request is\nto effect a routing change. The primary purposes of the routing messages are:\n\n1) To inform users of routing changes that may have an effect on traffic\ncurrently being routed to other existing deployments.\n\n2) To warn users if some basepath in the proxy will not receive traffic due\nto an existing deployment having already claimed that basepath.\n\nThe presence of routing conflicts/changes will not cause non-dry-run\nDeployApiProxy/UndeployApiProxy requests to be rejected.", + "description": "Response for GenerateDeployChangeReport and GenerateUndeployChangeReport. This report contains any validation failures that would cause the deployment to be rejected, as well changes and conflicts in routing that may occur due to the new deployment. The existence of a routing warning does not necessarily imply that the deployment request is bad, if the desired state of the deployment request is to effect a routing change. The primary purposes of the routing messages are: 1) To inform users of routing changes that may have an effect on traffic currently being routed to other existing deployments. 2) To warn users if some basepath in the proxy will not receive traffic due to an existing deployment having already claimed that basepath. The presence of routing conflicts/changes will not cause non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected.", "id": "GoogleCloudApigeeV1DeploymentChangeReport", "properties": { "routingChanges": { @@ -6614,13 +6626,13 @@ }, "validationErrors": { "$ref": "GoogleRpcPreconditionFailure", - "description": "Validation errors that would cause the deployment change request to be\nrejected." + "description": "Validation errors that would cause the deployment change request to be rejected." } }, "type": "object" }, "GoogleCloudApigeeV1DeploymentChangeReportRoutingChange": { - "description": "Describes a potential routing change that may occur as a result\nof some deployment operation.", + "description": "Describes a potential routing change that may occur as a result of some deployment operation.", "id": "GoogleCloudApigeeV1DeploymentChangeReportRoutingChange", "properties": { "description": { @@ -6636,18 +6648,18 @@ "description": "The basepath/deployment that may stop receiving some traffic." }, "shouldSequenceRollout": { - "description": "True if using sequenced rollout would make this routing change safer.\nNote: this does not necessarily imply that automated sequenced rollout\nmode is supported for the operation.", + "description": "True if using sequenced rollout would make this routing change safer. Note: this does not necessarily imply that automated sequenced rollout mode is supported for the operation.", "type": "boolean" }, "toDeployment": { "$ref": "GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment", - "description": "The basepath/deployment that may start receiving that traffic. May be\nnull if no deployment is able to receive the traffic." + "description": "The basepath/deployment that may start receiving that traffic. May be null if no deployment is able to receive the traffic." } }, "type": "object" }, "GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict": { - "description": "Describes a routing conflict that may cause a deployment not to receive\ntraffic at some basepath.", + "description": "Describes a routing conflict that may cause a deployment not to receive traffic at some basepath.", "id": "GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict", "properties": { "conflictingDeployment": { @@ -6699,7 +6711,7 @@ "type": "object" }, "basePath": { - "description": "Base path where the application needs to be hosted. Default value is\nassumed to be \"/\".", + "description": "Base path where the application needs to be hosted. Default value is assumed to be \"/\".", "type": "string" }, "location": { @@ -6707,7 +6719,7 @@ "type": "string" }, "name": { - "description": "The name of the API or shared flow revision to be deployed. Must be of the\nform 'organizations/{org}/apis/{api}/revisions/{rev}' or\n'organizations/{org}/sharedflows/{sf}/revisions/{rev}'.", + "description": "The name of the API or shared flow revision to be deployed. Must be of the form 'organizations/{org}/apis/{api}/revisions/{rev}' or 'organizations/{org}/sharedflows/{sf}/revisions/{rev}'.", "type": "string" }, "proxyUid": { @@ -6715,7 +6727,7 @@ "type": "string" }, "uid": { - "description": "A unique id that will only change if the deployment is deleted and\nrecreated.", + "description": "A unique id that will only change if the deployment is deleted and recreated.", "type": "string" } }, @@ -6754,16 +6766,17 @@ "type": "array" }, "createdAt": { - "description": "Output only. Time at which the developer was created in milliseconds\nsince epoch.", + "description": "Output only. Time at which the developer was created in milliseconds since epoch.", "format": "int64", + "readOnly": true, "type": "string" }, "developerId": { - "description": "ID of the developer.\n\n**Note**: IDs are generated internally by Apigee and are not\nguaranteed to stay the same over time.", + "description": "ID of the developer. **Note**: IDs are generated internally by Apigee and are not guaranteed to stay the same over time.", "type": "string" }, "email": { - "description": "Required. Email address of the developer. This value is used to uniquely identify\nthe developer in Apigee hybrid.", + "description": "Required. Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid.", "type": "string" }, "firstName": { @@ -6771,8 +6784,9 @@ "type": "string" }, "lastModifiedAt": { - "description": "Output only. Time at which the developer was last modified in\nmilliseconds since epoch.", + "description": "Output only. Time at which the developer was last modified in milliseconds since epoch.", "format": "int64", + "readOnly": true, "type": "string" }, "lastName": { @@ -6781,10 +6795,12 @@ }, "organizationName": { "description": "Output only. Name of the Apigee organization in which the developer resides.", + "readOnly": true, "type": "string" }, "status": { "description": "Output only. Status of the developer. Valid values are `active` and `inactive`.", + "readOnly": true, "type": "string" }, "userName": { @@ -6820,19 +6836,21 @@ "type": "array" }, "callbackUrl": { - "description": "Callback URL used by OAuth 2.0 authorization servers to communicate\nauthorization codes back to developer apps.", + "description": "Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.", "type": "string" }, "createdAt": { "description": "Output only. Time the developer app was created in milliseconds since epoch.", "format": "int64", + "readOnly": true, "type": "string" }, "credentials": { - "description": "Output only. Set of credentials for the developer app consisting of the\nconsumer key/secret pairs associated with the API products.", + "description": "Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products.", "items": { "$ref": "GoogleCloudApigeeV1Credential" }, + "readOnly": true, "type": "array" }, "developerId": { @@ -6840,13 +6858,14 @@ "type": "string" }, "keyExpiresIn": { - "description": "Expiration time, in milliseconds, for the consumer key that\nis generated for the developer app. If not set or left to the default\nvalue of `-1`, the API key never expires.\nThe expiration time can't be updated after it is set.", + "description": "Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set.", "format": "int64", "type": "string" }, "lastModifiedAt": { "description": "Output only. Time the developer app was modified in milliseconds since epoch.", "format": "int64", + "readOnly": true, "type": "string" }, "name": { @@ -6854,7 +6873,7 @@ "type": "string" }, "scopes": { - "description": "Scopes to apply to the developer app. The specified scopes must\nalready exist for the API product that you associate with the developer\napp.", + "description": "Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.", "items": { "type": "string" }, @@ -6871,7 +6890,7 @@ "id": "GoogleCloudApigeeV1DeveloperAppKey", "properties": { "apiProducts": { - "description": "List of API products for which the credential can be used.\n\n**Note**: Do not specify the list of API products when creating a consumer\nkey and secret for a developer app. Instead, use the\nUpdateDeveloperAppKey API to\nmake the association after the consumer key and secret are created.", + "description": "List of API products for which the credential can be used. **Note**: Do not specify the list of API products when creating a consumer key and secret for a developer app. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created.", "items": { "type": "any" }, @@ -6903,7 +6922,7 @@ "type": "string" }, "scopes": { - "description": "Scopes to apply to the app. The specified scope names must already\nbe defined for the API product that you associate with the app.", + "description": "Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.", "items": { "type": "string" }, @@ -6944,7 +6963,7 @@ "type": "string" }, "lastModifiedAt": { - "description": "Time at which the API proxy was most recently modified, in milliseconds\nsince epoch.", + "description": "Time at which the API proxy was most recently modified, in milliseconds since epoch.", "format": "int64", "type": "string" }, @@ -6961,6 +6980,7 @@ "createdAt": { "description": "Output only. Creation time of this environment as milliseconds since epoch.", "format": "int64", + "readOnly": true, "type": "string" }, "description": { @@ -6972,12 +6992,13 @@ "type": "string" }, "lastModifiedAt": { - "description": "Output only. Last modification time of this environment as milliseconds\nsince epoch.", + "description": "Output only. Last modification time of this environment as milliseconds since epoch.", "format": "int64", + "readOnly": true, "type": "string" }, "name": { - "description": "Required. Name of the environment. Values must match the\nregular expression `^[.\\\\p{Alnum}-_]{1,255}$`", + "description": "Required. Name of the environment. Values must match the regular expression `^[.\\\\p{Alnum}-_]{1,255}$`", "type": "string" }, "properties": { @@ -7035,11 +7056,11 @@ "type": "array" }, "name": { - "description": "The name of the environment config. Must be of the form\n'organizations/{org}/environments/{env}/configs/{config_id}", + "description": "The name of the environment config. Must be of the form 'organizations/{org}/environments/{env}/configs/{config_id}", "type": "string" }, "provider": { - "description": "This field can be used by the control plane to add some context\ninformation about itself. This information could help detect the source of\nthe document during diagnostics and debugging.", + "description": "This field can be used by the control plane to add some context information about itself. This information could help detect the source of the document during diagnostics and debugging.", "type": "string" }, "pubsubTopic": { @@ -7061,7 +7082,7 @@ "type": "array" }, "revisionId": { - "description": "Revision id that defines the ordering on the environment config.\nThe higher the revision, the more recently the configuration\nwas deployed.", + "description": "Revision id that defines the ordering on the environment config. The higher the revision, the more recently the configuration was deployed.", "format": "int64", "type": "string" }, @@ -7071,26 +7092,27 @@ "type": "string" }, "targets": { - "description": "A list of target servers in the environment. Disabled target servers are\nnot included.", + "description": "A list of target servers in the environment. Disabled target servers are not included.", "items": { "$ref": "GoogleCloudApigeeV1TargetServerConfig" }, "type": "array" }, "uid": { - "description": "A unique id for the environment config that will only change if the\nenvironment is deleted and recreated.", + "description": "A unique id for the environment config that will only change if the environment is deleted and recreated.", "type": "string" } }, "type": "object" }, "GoogleCloudApigeeV1EnvironmentGroup": { - "description": "EnvironmentGroup configuration. An environment group is used to group one or\nmore Apigee environments under a single host name.", + "description": "EnvironmentGroup configuration. An environment group is used to group one or more Apigee environments under a single host name.", "id": "GoogleCloudApigeeV1EnvironmentGroup", "properties": { "createdAt": { - "description": "Output only. The time at which the environment group was created as milliseconds since\nepoch.", + "description": "Output only. The time at which the environment group was created as milliseconds since epoch.", "format": "int64", + "readOnly": true, "type": "string" }, "hostnames": { @@ -7101,8 +7123,9 @@ "type": "array" }, "lastModifiedAt": { - "description": "Output only. The time at which the environment group was last updated as milliseconds\nsince epoch.", + "description": "Output only. The time at which the environment group was last updated as milliseconds since epoch.", "format": "int64", + "readOnly": true, "type": "string" }, "name": { @@ -7113,12 +7136,13 @@ "type": "object" }, "GoogleCloudApigeeV1EnvironmentGroupAttachment": { - "description": "EnvironmentGroupAttachment is a resource which defines an attachment of an\nenvironment to an environment group.", + "description": "EnvironmentGroupAttachment is a resource which defines an attachment of an environment to an environment group.", "id": "GoogleCloudApigeeV1EnvironmentGroupAttachment", "properties": { "createdAt": { - "description": "Output only. The time at which the environment group attachment was created as\nmilliseconds since epoch.", + "description": "Output only. The time at which the environment group attachment was created as milliseconds since epoch.", "format": "int64", + "readOnly": true, "type": "string" }, "environment": { @@ -7133,7 +7157,7 @@ "type": "object" }, "GoogleCloudApigeeV1EnvironmentGroupConfig": { - "description": "EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and\nits associated routing rules.", + "description": "EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and its associated routing rules.", "id": "GoogleCloudApigeeV1EnvironmentGroupConfig", "properties": { "hostnames": { @@ -7144,23 +7168,23 @@ "type": "array" }, "name": { - "description": "Name of the environment group in the following format:\n`organizations/{org}/envgroups/{envgroup}`.", + "description": "Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`.", "type": "string" }, "revisionId": { - "description": "Revision id that defines the ordering of the EnvironmentGroupConfig\nresource. The higher the revision, the more recently the\nconfiguration was deployed.", + "description": "Revision id that defines the ordering of the EnvironmentGroupConfig resource. The higher the revision, the more recently the configuration was deployed.", "format": "int64", "type": "string" }, "routingRules": { - "description": "Ordered list of routing rules defining how traffic to this environment\ngroup's hostnames should be routed to different environments.", + "description": "Ordered list of routing rules defining how traffic to this environment group's hostnames should be routed to different environments.", "items": { "$ref": "GoogleCloudApigeeV1RoutingRule" }, "type": "array" }, "uid": { - "description": "A unique id for the environment group config that will only change if\nthe environment group is deleted and recreated.", + "description": "A unique id for the environment group config that will only change if the environment group is deleted and recreated.", "type": "string" } }, @@ -7172,6 +7196,7 @@ "properties": { "created": { "description": "Output only. Time the export job was created.", + "readOnly": true, "type": "string" }, "datastoreName": { @@ -7184,10 +7209,12 @@ }, "error": { "description": "Output only. Error is set when export fails", + "readOnly": true, "type": "string" }, "executionTime": { - "description": "Output only. Execution time for this export job.\nIf the job is still in progress, it will be set to the amount of time that\nhas elapsed since`created`, in seconds.\nElse, it will set to (`updated` - `created`), in seconds.", + "description": "Output only. Execution time for this export job. If the job is still in progress, it will be set to the amount of time that has elapsed since`created`, in seconds. Else, it will set to (`updated` - `created`), in seconds.", + "readOnly": true, "type": "string" }, "name": { @@ -7195,15 +7222,18 @@ "type": "string" }, "self": { - "description": "Output only. Self link of the export job.\nA URI that can be used to retrieve the status of an export job.\n\nExample:\n`/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd`", + "description": "Output only. Self link of the export job. A URI that can be used to retrieve the status of an export job. Example: `/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd`", + "readOnly": true, "type": "string" }, "state": { - "description": "Output only. Status of the export job.\nValid values include `enqueued`, `running`, `completed`, and `failed`.", + "description": "Output only. Status of the export job. Valid values include `enqueued`, `running`, `completed`, and `failed`.", + "readOnly": true, "type": "string" }, "updated": { "description": "Output only. Time the export job was last updated.", + "readOnly": true, "type": "string" } }, @@ -7214,7 +7244,7 @@ "id": "GoogleCloudApigeeV1ExportRequest", "properties": { "csvDelimiter": { - "description": "Optional. Delimiter used in the CSV file, if `outputFormat` is set\nto `csv`. Defaults to the `,` (comma) character.\nSupported delimiter characters include comma (`,`), pipe (`|`),\nand tab (`\\t`).", + "description": "Optional. Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`|`), and tab (`\\t`).", "type": "string" }, "datastoreName": { @@ -7234,7 +7264,7 @@ "type": "string" }, "outputFormat": { - "description": "Optional. Output format of the export.\nValid values include: `csv` or `json`. Defaults to `json`.\nNote: Configure the delimiter for CSV output using the `csvDelimiter`\nproperty.", + "description": "Optional. Output format of the export. Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the `csvDelimiter` property.", "type": "string" } }, @@ -7244,7 +7274,7 @@ "id": "GoogleCloudApigeeV1FlowHook", "properties": { "continueOnError": { - "description": "Optional. Flag that specifies whether execution should continue if the flow hook\nthrows an exception. Set to `true` to continue execution. Set to\n`false` to stop execution if the flow hook throws an exception.Defaults\nto `true`.", + "description": "Optional. Flag that specifies whether execution should continue if the flow hook throws an exception. Set to `true` to continue execution. Set to `false` to stop execution if the flow hook throws an exception.Defaults to `true`.", "type": "boolean" }, "description": { @@ -7252,7 +7282,8 @@ "type": "string" }, "flowHookPoint": { - "description": "Output only. Where in the API call flow the flow hook is invoked. Must be one of\n`PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or\n`PostTargetFlowHook`.", + "description": "Output only. Where in the API call flow the flow hook is invoked. Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or `PostTargetFlowHook`.", + "readOnly": true, "type": "string" }, "sharedFlow": { @@ -7266,22 +7297,22 @@ "id": "GoogleCloudApigeeV1FlowHookConfig", "properties": { "continueOnError": { - "description": "Should the flow abort after an error in the flow hook.\nShould default to true if unset.", + "description": "Should the flow abort after an error in the flow hook. Should default to true if unset.", "type": "boolean" }, "name": { - "description": "The name of the flow hook. Must be of the form\n'organizations/{org}/environments/{env}/flowhooks/{point}'.\nKnown points are PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook,\nand PostTargetFlowHook", + "description": "The name of the flow hook. Must be of the form 'organizations/{org}/environments/{env}/flowhooks/{point}'. Known points are PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, and PostTargetFlowHook", "type": "string" }, "sharedFlowName": { - "description": "The name of the shared flow to invoke. Must be of the form\n'organizations/{org}/sharedflows/{sharedflow}'.", + "description": "The name of the shared flow to invoke. Must be of the form 'organizations/{org}/sharedflows/{sharedflow}'.", "type": "string" } }, "type": "object" }, "GoogleCloudApigeeV1GetSyncAuthorizationRequest": { - "description": "Request for\nGetSyncAuthorization.", + "description": "Request for GetSyncAuthorization.", "id": "GoogleCloudApigeeV1GetSyncAuthorizationRequest", "properties": {}, "type": "object" @@ -7297,7 +7328,7 @@ "type": "array" }, "name": { - "description": "Name of the resource in the following format:\n`organizations/{org}/deployedIngressConfig`.", + "description": "Name of the resource in the following format: `organizations/{org}/deployedIngressConfig`.", "type": "string" }, "revisionCreateTime": { @@ -7306,12 +7337,12 @@ "type": "string" }, "revisionId": { - "description": "Revision id that defines the ordering on IngressConfig resources.\nThe higher the revision, the more recently the configuration\nwas deployed.", + "description": "Revision id that defines the ordering on IngressConfig resources. The higher the revision, the more recently the configuration was deployed.", "format": "int64", "type": "string" }, "uid": { - "description": "A unique id for the ingress config that will only change if the\norganization is deleted and recreated.", + "description": "A unique id for the ingress config that will only change if the organization is deleted and recreated.", "type": "string" } }, @@ -7324,6 +7355,7 @@ "createdAt": { "description": "Output only. Time the instance was created in milliseconds since epoch.", "format": "int64", + "readOnly": true, "type": "string" }, "description": { @@ -7339,12 +7371,14 @@ "type": "string" }, "host": { - "description": "Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to\nconnect to the service.", + "description": "Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to connect to the service.", + "readOnly": true, "type": "string" }, "lastModifiedAt": { "description": "Output only. Time the instance was last modified in milliseconds since epoch.", "format": "int64", + "readOnly": true, "type": "string" }, "location": { @@ -7352,23 +7386,25 @@ "type": "string" }, "name": { - "description": "Required. Resource ID of the instance. Values must match the\nregular expression `^a-z{0,30}[a-z\\d]$`.", + "description": "Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\\d]$`.", "type": "string" }, "port": { "description": "Output only. Port number of the exposed Apigee endpoint.", + "readOnly": true, "type": "string" } }, "type": "object" }, "GoogleCloudApigeeV1InstanceAttachment": { - "description": "InstanceAttachment represents the installation of an environment onto an\ninstance.", + "description": "InstanceAttachment represents the installation of an environment onto an instance.", "id": "GoogleCloudApigeeV1InstanceAttachment", "properties": { "createdAt": { "description": "Output only. Time the attachment was created in milliseconds since epoch.", "format": "int64", + "readOnly": true, "type": "string" }, "environment": { @@ -7377,6 +7413,7 @@ }, "name": { "description": "Output only. ID of the attachment.", + "readOnly": true, "type": "string" } }, @@ -7394,7 +7431,7 @@ "type": "array" }, "deployedRoutes": { - "description": "The current routes deployed in the ingress routing table. A route which is\nmissing will be shown with no destination environment.", + "description": "The current routes deployed in the ingress routing table. A route which is missing will be shown with no destination environment.", "items": { "$ref": "GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute" }, @@ -7436,7 +7473,7 @@ "type": "string" }, "environment": { - "description": "The destination environment. This will be empty if the route is not yet\nreported.", + "description": "The destination environment. This will be empty if the route is not yet reported.", "type": "string" }, "percentage": { @@ -7455,7 +7492,7 @@ "type": "string" }, "reference": { - "description": "The reference name. Must be of the form:\norganizations/{org}/environments/{env}/references/{ref}.", + "description": "The reference name. Must be of the form: organizations/{org}/environments/{env}/references/{ref}.", "type": "string" } }, @@ -7485,10 +7522,11 @@ "items": { "type": "string" }, + "readOnly": true, "type": "array" }, "name": { - "description": "Required. The resource ID for this keystore. Values must match the\nregular expression `[\\w[:space:]-.]{1,255}`.", + "description": "Required. The resource ID for this keystore. Values must match the regular expression `[\\w[:space:]-.]{1,255}`.", "type": "string" } }, @@ -7505,7 +7543,7 @@ "type": "array" }, "name": { - "description": "The resource name. Must be of the\nform:\n'organizations/{org}/environments/{env}/keystores/{keystore}'.", + "description": "The resource name. Must be of the form: 'organizations/{org}/environments/{env}/keystores/{keystore}'.", "type": "string" } }, @@ -7593,11 +7631,11 @@ "id": "GoogleCloudApigeeV1ListDebugSessionsResponse", "properties": { "nextPageToken": { - "description": "Page token that you can include in a ListDebugSessionsRequest to\nretrieve the next page. If omitted, no subsequent pages exist.", + "description": "Page token that you can include in a ListDebugSessionsRequest to retrieve the next page. If omitted, no subsequent pages exist.", "type": "string" }, "sessions": { - "description": "Session info that includes debug session ID and the first transaction\ncreation timestamp.", + "description": "Session info that includes debug session ID and the first transaction creation timestamp.", "items": { "$ref": "GoogleCloudApigeeV1Session" }, @@ -7633,7 +7671,7 @@ "type": "object" }, "GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse": { - "description": "Response for\nListEnvironmentGroupAttachments.", + "description": "Response for ListEnvironmentGroupAttachments.", "id": "GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse", "properties": { "environmentGroupAttachments": { @@ -7644,14 +7682,14 @@ "type": "array" }, "nextPageToken": { - "description": "Page token that you can include in a ListEnvironmentGroupAttachments\nrequest to retrieve the next page. If omitted, no subsequent pages exist.", + "description": "Page token that you can include in a ListEnvironmentGroupAttachments request to retrieve the next page. If omitted, no subsequent pages exist.", "type": "string" } }, "type": "object" }, "GoogleCloudApigeeV1ListEnvironmentGroupsResponse": { - "description": "Response for\nListEnvironmentGroups.", + "description": "Response for ListEnvironmentGroups.", "id": "GoogleCloudApigeeV1ListEnvironmentGroupsResponse", "properties": { "environmentGroups": { @@ -7662,14 +7700,14 @@ "type": "array" }, "nextPageToken": { - "description": "Page token that you can include in a ListEnvironmentGroups request to\nretrieve the next page. If omitted, no subsequent pages exist.", + "description": "Page token that you can include in a ListEnvironmentGroups request to retrieve the next page. If omitted, no subsequent pages exist.", "type": "string" } }, "type": "object" }, "GoogleCloudApigeeV1ListEnvironmentResourcesResponse": { - "description": "Response for\nListEnvironmentResources", + "description": "Response for ListEnvironmentResources", "id": "GoogleCloudApigeeV1ListEnvironmentResourcesResponse", "properties": { "resourceFile": { @@ -7710,7 +7748,7 @@ "type": "object" }, "GoogleCloudApigeeV1ListInstanceAttachmentsResponse": { - "description": "Response for\nListInstanceAttachments.", + "description": "Response for ListInstanceAttachments.", "id": "GoogleCloudApigeeV1ListInstanceAttachmentsResponse", "properties": { "attachments": { @@ -7721,7 +7759,7 @@ "type": "array" }, "nextPageToken": { - "description": "Page token that you can include in a ListInstanceAttachments request to\nretrieve the next page of content. If omitted, no subsequent pages exist.", + "description": "Page token that you can include in a ListInstanceAttachments request to retrieve the next page of content. If omitted, no subsequent pages exist.", "type": "string" } }, @@ -7739,7 +7777,7 @@ "type": "array" }, "nextPageToken": { - "description": "Page token that you can include in a ListInstance request to retrieve\nthe next page of content. If omitted, no subsequent pages exist.", + "description": "Page token that you can include in a ListInstance request to retrieve the next page of content. If omitted, no subsequent pages exist.", "type": "string" } }, @@ -7795,7 +7833,7 @@ "type": "array" }, "notices": { - "description": "List of additional information such as data source, if result was\ntruncated etc.\nE.g\n\"notices\": [\n \"Source:Postgres\",\n \"PG Host:uappg0rw.e2e.apigeeks.net\",\n \"query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed\",\n \"Table used: edge.api.uapgroup2.agg_api\"\n ]", + "description": "List of additional information such as data source, if result was truncated etc. E.g \"notices\": [ \"Source:Postgres\", \"PG Host:uappg0rw.e2e.apigeeks.net\", \"query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed\", \"Table used: edge.api.uapgroup2.agg_api\" ]", "items": { "type": "string" }, @@ -7805,7 +7843,7 @@ "type": "object" }, "GoogleCloudApigeeV1Metric": { - "description": "This message type encapsulates the metric data point.\nExample:\n{\n \"name\": \"sum(message_count)\",\n \"values\" : [ {\n \"timestamp\": 1549004400000,\n \"value\": \"39.0\"\n },\n {\n \"timestamp\" : 1548997200000,\n \"value\" : \"0.0\"\n } ]\n}\nor\n{\n \"name\": \"sum(message_count)\",\n \"values\" : [\"39.0\"]\n}", + "description": "This message type encapsulates the metric data point. Example: { \"name\": \"sum(message_count)\", \"values\" : [ { \"timestamp\": 1549004400000, \"value\": \"39.0\" }, { \"timestamp\" : 1548997200000, \"value\" : \"0.0\" } ] } or { \"name\": \"sum(message_count)\", \"values\" : [\"39.0\"] }", "id": "GoogleCloudApigeeV1Metric", "properties": { "name": { @@ -7813,7 +7851,7 @@ "type": "string" }, "values": { - "description": "List of metric values.\nPossible value format:\n\"values\":[\"39.0\"] or\n\"values\":[ { \"value\": \"39.0\", \"timestamp\": 1232434354} ]", + "description": "List of metric values. Possible value format: \"values\":[\"39.0\"] or \"values\":[ { \"value\": \"39.0\", \"timestamp\": 1232434354} ]", "items": { "type": "any" }, @@ -7868,13 +7906,13 @@ "properties": { "Response": { "$ref": "GoogleCloudApigeeV1OptimizedStatsResponse", - "description": "This field wraps the stats response for Js Optimized Scenario\nwith a Response key.\nE.g.\n{\n \"Response\": {\n \"TimeUnit\": [],\n \"metaData\": {\n \"errors\": [],\n \"notices\": [\n \"Source:Postgres\",\n \"Table used: edge.api.aaxgroup001.agg_api\",\n \"PG Host:ruappg08-ro.production.apigeeks.net\",\n \"query served by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca\"\n ]\n },\n \"resultTruncated\": false,\n \"stats\": {\n \"data\": [\n {\n \"identifier\": {\n \"names\": [\n \"apiproxy\"\n ],\n \"values\": [\n \"sirjee\"\n ]\n },\n \"metric\": [\n {\n \"env\": \"prod\",\n \"name\": \"sum(message_count)\",\n \"values\": [\n 36.0\n ]\n },\n {\n \"env\": \"prod\",\n \"name\": \"sum(is_error)\",\n \"values\": [\n 36.0\n ]\n }\n ]\n }\n ]\n }\n }\n}" + "description": "This field wraps the stats response for Js Optimized Scenario with a Response key. E.g. { \"Response\": { \"TimeUnit\": [], \"metaData\": { \"errors\": [], \"notices\": [ \"Source:Postgres\", \"Table used: edge.api.aaxgroup001.agg_api\", \"PG Host:ruappg08-ro.production.apigeeks.net\", \"query served by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca\" ] }, \"resultTruncated\": false, \"stats\": { \"data\": [ { \"identifier\": { \"names\": [ \"apiproxy\" ], \"values\": [ \"sirjee\" ] }, \"metric\": [ { \"env\": \"prod\", \"name\": \"sum(message_count)\", \"values\": [ 36.0 ] }, { \"env\": \"prod\", \"name\": \"sum(is_error)\", \"values\": [ 36.0 ] } ] } ] } } }" } }, "type": "object" }, "GoogleCloudApigeeV1OptimizedStatsNode": { - "description": "This message type encapsulates a data node as represented below:\n {\n \"identifier\": {\n \"names\": [\n \"apiproxy\"\n ],\n \"values\": [\n \"sirjee\"\n ]\n },\n \"metric\": [\n {\n \"env\": \"prod\",\n \"name\": \"sum(message_count)\",\n \"values\": [\n 36.0\n ]\n }\n ]\n }\n\n OR\n {\n \"env\": \"prod\",\n \"name\": \"sum(message_count)\",\n \"values\": [\n 36.0\n ]\n }\nDepending on whether a dimension is present in the query or not\nthe data node type can be a simple metric value or dimension identifier\nwith list of metrics.", + "description": "This message type encapsulates a data node as represented below: { \"identifier\": { \"names\": [ \"apiproxy\" ], \"values\": [ \"sirjee\" ] }, \"metric\": [ { \"env\": \"prod\", \"name\": \"sum(message_count)\", \"values\": [ 36.0 ] } ] } OR { \"env\": \"prod\", \"name\": \"sum(message_count)\", \"values\": [ 36.0 ] } Depending on whether a dimension is present in the query or not the data node type can be a simple metric value or dimension identifier with list of metrics.", "id": "GoogleCloudApigeeV1OptimizedStatsNode", "properties": { "data": { @@ -7891,7 +7929,7 @@ "id": "GoogleCloudApigeeV1OptimizedStatsResponse", "properties": { "TimeUnit": { - "description": "This field contains a list of time unit values. Time unit refers to\nan epoch timestamp value.", + "description": "This field contains a list of time unit values. Time unit refers to an epoch timestamp value.", "items": { "format": "int64", "type": "string" @@ -7903,7 +7941,7 @@ "description": "This field contains metadata information about the query executed" }, "resultTruncated": { - "description": "This ia a boolean field to indicate if the results were truncated\nbased on the limit parameter.", + "description": "This ia a boolean field to indicate if the results were truncated based on the limit parameter.", "type": "boolean" }, "stats": { @@ -7917,7 +7955,7 @@ "id": "GoogleCloudApigeeV1Organization", "properties": { "analyticsRegion": { - "description": "Required. Primary GCP region for analytics data storage. For valid values, see\n[Create an\norganization](https://docs.apigee.com/hybrid/latest/precog-provision).", + "description": "Required. Primary GCP region for analytics data storage. For valid values, see [Create an organization](https://docs.apigee.com/hybrid/latest/precog-provision).", "type": "string" }, "attributes": { @@ -7928,17 +7966,19 @@ "type": "array" }, "authorizedNetwork": { - "description": "Compute Engine network used for ServiceNetworking to\nbe peered with Apigee runtime instances. See\n[Getting started with the Service Networking\nAPI](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started).\nValid only when [RuntimeType] is set to CLOUD. The value can be updated\nonly when there are no runtime instances.\nFor example: \"default\".\n\n**Note:** Not supported for Apigee hybrid.", + "description": "Compute Engine network used for ServiceNetworking to be peered with Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). Valid only when [RuntimeType] is set to CLOUD. The value can be updated only when there are no runtime instances. For example: \"default\". **Note:** Not supported for Apigee hybrid.", "type": "string" }, "caCertificate": { - "description": "Output only. Base64-encoded public certificate for the root CA of the Apigee\norganization. Valid only when [RuntimeType] is CLOUD.", + "description": "Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when [RuntimeType] is CLOUD.", "format": "byte", + "readOnly": true, "type": "string" }, "createdAt": { "description": "Output only. Time that the Apigee organization was created in milliseconds since epoch.", "format": "int64", + "readOnly": true, "type": "string" }, "customerName": { @@ -7957,15 +7997,18 @@ "items": { "type": "string" }, + "readOnly": true, "type": "array" }, "lastModifiedAt": { - "description": "Output only. Time that the Apigee organization was last modified in milliseconds\nsince epoch.", + "description": "Output only. Time that the Apigee organization was last modified in milliseconds since epoch.", "format": "int64", + "readOnly": true, "type": "string" }, "name": { "description": "Output only. Name of the Apigee organization.", + "readOnly": true, "type": "string" }, "projectId": { @@ -7977,7 +8020,7 @@ "description": "Properties defined in the Apigee organization profile." }, "runtimeType": { - "description": "Output only. Runtime type of the Apigee organization based on the Apigee subscription\npurchased.", + "description": "Output only. Runtime type of the Apigee organization based on the Apigee subscription purchased.", "enum": [ "RUNTIME_TYPE_UNSPECIFIED", "CLOUD", @@ -7988,10 +8031,11 @@ "Google-managed Apigee runtime.", "User-managed Apigee hybrid runtime." ], + "readOnly": true, "type": "string" }, "subscriptionType": { - "description": "Output only. Subscription type of the Apigee organization. Valid values include trial\n(free, limited, and for evaluation purposes only) or paid (full\nsubscription has been purchased). See\n[Apigee pricing](https://cloud.google.com/apigee/pricing/).", + "description": "Output only. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased). See [Apigee pricing](https://cloud.google.com/apigee/pricing/).", "enum": [ "SUBSCRIPTION_TYPE_UNSPECIFIED", "PAID", @@ -8000,8 +8044,9 @@ "enumDescriptions": [ "", "Full subscription to Apigee has been purchased.", - "Subscription to Apigee is free, limited, and used for evaluation purposes\nonly." + "Subscription to Apigee is free, limited, and used for evaluation purposes only." ], + "readOnly": true, "type": "string" }, "type": { @@ -8014,8 +8059,8 @@ ], "enumDescriptions": [ "Subscription type not specified.", - "Subscription to Apigee is free, limited, and used for evaluation purposes\nonly.", - "Full subscription to Apigee has been purchased. See\n[Apigee pricing](https://cloud.google.com/apigee/pricing/).", + "Subscription to Apigee is free, limited, and used for evaluation purposes only.", + "Full subscription to Apigee has been purchased. See [Apigee pricing](https://cloud.google.com/apigee/pricing/).", "For internal users only." ], "type": "string" @@ -8048,7 +8093,7 @@ "type": "string" }, "deploymentStatus": { - "description": "Status of the deployment. Valid values\ninclude:\n- `deployed`: Successful.\n- `error` : Failed.\n- `pending` : Pod has not yet reported on the deployment.", + "description": "Status of the deployment. Valid values include: - `deployed`: Successful. - `error` : Failed. - `pending` : Pod has not yet reported on the deployment.", "type": "string" }, "deploymentStatusTime": { @@ -8066,7 +8111,7 @@ "type": "string" }, "podStatus": { - "description": "Overall status of the pod (not this specific deployment). Valid values\ninclude:\n- `active`: Up to date.\n- `stale` : Recently out of date.\n\nPods that have not reported status in a\nlong time are excluded from the output.", + "description": "Overall status of the pod (not this specific deployment). Valid values include: - `active`: Up to date. - `stale` : Recently out of date. Pods that have not reported status in a long time are excluded from the output.", "type": "string" }, "podStatusTime": { @@ -8086,7 +8131,7 @@ "type": "object" }, "GoogleCloudApigeeV1Point": { - "description": "Point is a group of information collected by runtime plane at critical points\nof the message flow of the processed API request.\nThis is a list of supported point IDs, categorized to three major buckets.\nFor each category, debug points that we are currently supporting are listed\nbelow:\n- Flow status debug points:\n StateChange\n FlowInfo\n Condition\n Execution\n DebugMask\n Error\n- Flow control debug points:\n FlowCallout\n Paused\n Resumed\n FlowReturn\n BreakFlow\n Error\n- Runtime debug points:\n ScriptExecutor\n FlowCalloutStepDefinition\n CustomTarget\n StepDefinition\n Oauth2ServicePoint\n RaiseFault\n NodeJS\n\nThe detail information of the given debug point is stored in a list of\nresults.", + "description": "Point is a group of information collected by runtime plane at critical points of the message flow of the processed API request. This is a list of supported point IDs, categorized to three major buckets. For each category, debug points that we are currently supporting are listed below: - Flow status debug points: StateChange FlowInfo Condition Execution DebugMask Error - Flow control debug points: FlowCallout Paused Resumed FlowReturn BreakFlow Error - Runtime debug points: ScriptExecutor FlowCalloutStepDefinition CustomTarget StepDefinition Oauth2ServicePoint RaiseFault NodeJS The detail information of the given debug point is stored in a list of results.", "id": "GoogleCloudApigeeV1Point", "properties": { "id": { @@ -8104,7 +8149,7 @@ "type": "object" }, "GoogleCloudApigeeV1Properties": { - "description": "Message for compatibility with legacy Edge specification for Java Properties\nobject in JSON.", + "description": "Message for compatibility with legacy Edge specification for Java Properties object in JSON.", "id": "GoogleCloudApigeeV1Properties", "properties": { "property": { @@ -8136,22 +8181,22 @@ "id": "GoogleCloudApigeeV1Query", "properties": { "csvDelimiter": { - "description": "Delimiter used in the CSV file, if `outputFormat` is set\nto `csv`. Defaults to the `,` (comma) character.\nSupported delimiter characters include comma (`,`), pipe (`|`),\nand tab (`\\t`).", + "description": "Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`|`), and tab (`\\t`).", "type": "string" }, "dimensions": { - "description": "A list of dimensions.\nhttps://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions", + "description": "A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions", "items": { "type": "string" }, "type": "array" }, "filter": { - "description": "Boolean expression that can be used to filter data.\nFilter expressions can be combined using AND/OR terms and should be fully\nparenthesized to avoid ambiguity. See Analytics metrics, dimensions, and\nfilters reference\nhttps://docs.apigee.com/api-platform/analytics/analytics-reference\nfor more information on the fields available to filter\non. For more information on the tokens that you use to build filter\nexpressions, see Filter expression syntax.\nhttps://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax", + "description": "Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax", "type": "string" }, "groupByTimeUnit": { - "description": "Time unit used to group the result set.\nValid values include: second, minute, hour, day, week, or month.\nIf a query includes groupByTimeUnit, then the result is an aggregation\nbased on the specified time unit and the resultant timestamp does not\ninclude milliseconds precision.\nIf a query omits groupByTimeUnit, then the resultant timestamp includes\nmilliseconds precision.", + "description": "Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.", "type": "string" }, "limit": { @@ -8171,7 +8216,7 @@ "type": "string" }, "outputFormat": { - "description": "Valid values include: `csv` or `json`. Defaults to `json`.\nNote: Configure the delimiter for CSV output using the csvDelimiter\nproperty.", + "description": "Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the csvDelimiter property.", "type": "string" }, "reportDefinitionId": { @@ -8179,7 +8224,7 @@ "type": "string" }, "timeRange": { - "description": "Required. Time range for the query.\nCan use the following predefined strings to specify the time range:\n `last60minutes`\n `last24hours`\n `last7days`\nOr, specify the timeRange as a structure describing start and end\ntimestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ.\n\nExample:\n \"timeRange\": {\n \"start\": \"2018-07-29T00:13:00Z\",\n \"end\": \"2018-08-01T00:18:00Z\"\n }", + "description": "Required. Time range for the query. Can use the following predefined strings to specify the time range: `last60minutes` `last24hours` `last7days` Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: \"timeRange\": { \"start\": \"2018-07-29T00:13:00Z\", \"end\": \"2018-08-01T00:18:00Z\" }", "type": "any" } }, @@ -8200,7 +8245,7 @@ "type": "string" }, "metrics": { - "description": "Metrics of the AsyncQuery.\n\nExample: [\"name:message_count,func:sum,alias:sum_message_count\"]", + "description": "Metrics of the AsyncQuery. Example: [\"name:message_count,func:sum,alias:sum_message_count\"]", "items": { "type": "string" }, @@ -8222,11 +8267,11 @@ "type": "object" }, "GoogleCloudApigeeV1QueryMetric": { - "description": "More info about Metric:\nhttps://docs.apigee.com/api-platform/analytics/analytics-reference#metrics", + "description": "More info about Metric: https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics", "id": "GoogleCloudApigeeV1QueryMetric", "properties": { "alias": { - "description": "Alias for the metric. Alias will be used to replace metric name\nin query results.", + "description": "Alias for the metric. Alias will be used to replace metric name in query results.", "type": "string" }, "function": { @@ -8249,7 +8294,7 @@ "type": "object" }, "GoogleCloudApigeeV1Reference": { - "description": "A Reference configuration. References must refer to a keystore\nthat also exists in the parent environment.", + "description": "A Reference configuration. References must refer to a keystore that also exists in the parent environment.", "id": "GoogleCloudApigeeV1Reference", "properties": { "description": { @@ -8257,15 +8302,15 @@ "type": "string" }, "name": { - "description": "Required. The resource id of this reference. Values must match the\nregular expression [\\w\\s\\-.]+.", + "description": "Required. The resource id of this reference. Values must match the regular expression [\\w\\s\\-.]+.", "type": "string" }, "refers": { - "description": "Required. The id of the resource to which this reference refers.\nMust be the id of a resource that exists in the parent environment and is\nof the given resource_type.", + "description": "Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resource_type.", "type": "string" }, "resourceType": { - "description": "The type of resource referred to by this reference. Valid values\nare 'KeyStore' or 'TrustStore'.", + "description": "The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.", "type": "string" } }, @@ -8275,11 +8320,11 @@ "id": "GoogleCloudApigeeV1ReferenceConfig", "properties": { "name": { - "description": "The name of the reference. Must be of the form\n'organizations/{org}/environments/{env}/references/{ref}'.", + "description": "The name of the reference. Must be of the form 'organizations/{org}/environments/{env}/references/{ref}'.", "type": "string" }, "resourceName": { - "description": "The name of the referred resource. Only references to keystore resources\nare supported. Must be of the form\n'organizations/{org}/environments/{env}/keystores/{ks}'.", + "description": "The name of the referred resource. Only references to keystore resources are supported. Must be of the form 'organizations/{org}/environments/{env}/keystores/{ks}'.", "type": "string" } }, @@ -8290,11 +8335,11 @@ "id": "GoogleCloudApigeeV1ReportInstanceStatusRequest", "properties": { "instanceUid": { - "description": "A unique ID for the instance which is guaranteed to be unique in case the\nuser installs multiple hybrid runtimes with the same instance ID.", + "description": "A unique ID for the instance which is guaranteed to be unique in case the user installs multiple hybrid runtimes with the same instance ID.", "type": "string" }, "reportTime": { - "description": "The time the report was generated in the runtime. Used to prevent an old\nstatus from overwriting a newer one. An instance should space out it's\nstatus reports so that clock skew does not play a factor.", + "description": "The time the report was generated in the runtime. Used to prevent an old status from overwriting a newer one. An instance should space out it's status reports so that clock skew does not play a factor.", "format": "google-datetime", "type": "string" }, @@ -8339,7 +8384,7 @@ "type": "string" }, "name": { - "description": "The resource name. Only environment-scoped resource files are supported.\nMust be of the form\n'organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}'.", + "description": "The resource name. Only environment-scoped resource files are supported. Must be of the form 'organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}'.", "type": "string" } }, @@ -8379,7 +8424,7 @@ "id": "GoogleCloudApigeeV1ResourceStatus", "properties": { "resource": { - "description": "The resource name. Currently only two resources are supported:\nEnvironmentGroup - organizations/{org}/envgroups/{envgroup}\nEnvironmentConfig -\norganizations/{org}/environments/{environment}/deployedConfig", + "description": "The resource name. Currently only two resources are supported: EnvironmentGroup - organizations/{org}/envgroups/{envgroup} EnvironmentConfig - organizations/{org}/environments/{environment}/deployedConfig", "type": "string" }, "revisions": { @@ -8395,33 +8440,33 @@ "type": "integer" }, "uid": { - "description": "The uid of the resource. In the unexpected case that the instance has\nmultiple uids for the same name, they should be reported under separate\nResourceStatuses.", + "description": "The uid of the resource. In the unexpected case that the instance has multiple uids for the same name, they should be reported under separate ResourceStatuses.", "type": "string" } }, "type": "object" }, "GoogleCloudApigeeV1Result": { - "description": "Result is short for \"action result\", could be different types identified by\n\"action_result\" field. Supported types:\n1. DebugInfo : generic debug info collected by runtime recorded as a list of\nproperties. For example, the contents could be virtual host info, state\nchange result, or execution metadata. Required fields : properties, timestamp\n\n2. RequestMessage: information of a http request. Contains headers, request\nURI and http methods type.Required fields : headers, uri, verb\n\n3. ResponseMessage: information of a http response. Contains headers, reason\nphrase and http status code. Required fields : headers, reasonPhrase,\nstatusCode\n\n4. ErrorMessage: information of a http error message. Contains detail error\nmessage, reason phrase and status code. Required fields : content, headers,\nreasonPhrase, statusCode\n\n5. VariableAccess: a list of variable access actions, can be Get, Set and\nRemove. Required fields : accessList", + "description": "Result is short for \"action result\", could be different types identified by \"action_result\" field. Supported types: 1. DebugInfo : generic debug info collected by runtime recorded as a list of properties. For example, the contents could be virtual host info, state change result, or execution metadata. Required fields : properties, timestamp 2. RequestMessage: information of a http request. Contains headers, request URI and http methods type.Required fields : headers, uri, verb 3. ResponseMessage: information of a http response. Contains headers, reason phrase and http status code. Required fields : headers, reasonPhrase, statusCode 4. ErrorMessage: information of a http error message. Contains detail error message, reason phrase and status code. Required fields : content, headers, reasonPhrase, statusCode 5. VariableAccess: a list of variable access actions, can be Get, Set and Remove. Required fields : accessList", "id": "GoogleCloudApigeeV1Result", "properties": { "ActionResult": { - "description": "Type of the action result. Can be one of the five: DebugInfo,\nRequestMessage, ResponseMessage, ErrorMessage, VariableAccess", + "description": "Type of the action result. Can be one of the five: DebugInfo, RequestMessage, ResponseMessage, ErrorMessage, VariableAccess", "type": "string" }, "accessList": { - "description": "A list of variable access actions agaist the api proxy.\nSupported values: Get, Set, Remove.", + "description": "A list of variable access actions agaist the api proxy. Supported values: Get, Set, Remove.", "items": { "$ref": "GoogleCloudApigeeV1Access" }, "type": "array" }, "content": { - "description": "Error message content. for example,\n\"content\" : \"{\\\"fault\\\":{\\\"faultstring\\\":\\\"API timed\nout\\\",\\\"detail\\\":{\\\"errorcode\\\":\\\"flow.APITimedOut\\\"}}}\"", + "description": "Error message content. for example, \"content\" : \"{\\\"fault\\\":{\\\"faultstring\\\":\\\"API timed out\\\",\\\"detail\\\":{\\\"errorcode\\\":\\\"flow.APITimedOut\\\"}}}\"", "type": "string" }, "headers": { - "description": "A list of HTTP headers.\nfor example,\n'\"headers\" : [ {\n \"name\" : \"Content-Length\",\n \"value\" : \"83\"\n}, {\n \"name\" : \"Content-Type\",\n \"value\" : \"application/json\"\n} ]'", + "description": "A list of HTTP headers. for example, '\"headers\" : [ { \"name\" : \"Content-Length\", \"value\" : \"83\" }, { \"name\" : \"Content-Type\", \"value\" : \"application/json\" } ]'", "items": { "$ref": "GoogleCloudApigeeV1Property" }, @@ -8440,11 +8485,11 @@ "type": "string" }, "timestamp": { - "description": "Timestamp of when the result is recorded. Its format is dd-mm-yy\nhh:mm:ss:xxx. For example, `\"timestamp\" : \"12-08-19 00:31:59:960\"`", + "description": "Timestamp of when the result is recorded. Its format is dd-mm-yy hh:mm:ss:xxx. For example, `\"timestamp\" : \"12-08-19 00:31:59:960\"`", "type": "string" }, "uRI": { - "description": "The relative path of the api proxy.\nfor example, `\"uRI\" : \"/iloveapis\"`", + "description": "The relative path of the api proxy. for example, `\"uRI\" : \"/iloveapis\"`", "type": "string" }, "verb": { @@ -8485,11 +8530,11 @@ "id": "GoogleCloudApigeeV1RoutingRule", "properties": { "basepath": { - "description": "URI path prefix used to route to the specified environment. May contain\none or more wildcards. For example, path segments consisting of a single\n`*` character will match any string.", + "description": "URI path prefix used to route to the specified environment. May contain one or more wildcards. For example, path segments consisting of a single `*` character will match any string.", "type": "string" }, "environment": { - "description": "Name of an environment bound to the environment group in the following\nformat: `organizations/{org}/environments/{env}`.", + "description": "Name of an environment bound to the environment group in the following format: `organizations/{org}/environments/{env}`.", "type": "string" } }, @@ -8507,14 +8552,14 @@ "type": "array" }, "meta": { - "description": "Additional metadata associated with schema. This is\na legacy field and usually consists of an empty array of strings.", + "description": "Additional metadata associated with schema. This is a legacy field and usually consists of an empty array of strings.", "items": { "type": "string" }, "type": "array" }, "metrics": { - "description": "List of schema fields grouped as dimensions. These are fields\nthat can be used with an aggregate function such as sum, avg, min, max.", + "description": "List of schema fields grouped as dimensions. These are fields that can be used with an aggregate function such as sum, avg, min, max.", "items": { "$ref": "GoogleCloudApigeeV1SchemaSchemaElement" }, @@ -8533,7 +8578,7 @@ }, "properties": { "$ref": "GoogleCloudApigeeV1SchemaSchemaProperty", - "description": "Property of the schema field\nE.g.\n{\n \"createTime\": \"2016-02-26T10:23:09.592Z\",\n \"custom\": \"false\",\n \"type\": \"string\"\n}" + "description": "Property of the schema field E.g. { \"createTime\": \"2016-02-26T10:23:09.592Z\", \"custom\": \"false\", \"type\": \"string\" }" } }, "type": "object" @@ -8547,7 +8592,7 @@ "type": "string" }, "custom": { - "description": "Custom is a flag signifying if the field was provided as\npart of the standard dataset or a custom field created by the customer", + "description": "Custom is a flag signifying if the field was provided as part of the standard dataset or a custom field created by the customer", "type": "string" }, "type": { @@ -8622,14 +8667,14 @@ "properties": { "configurationVersion": { "$ref": "GoogleCloudApigeeV1ConfigVersion", - "description": "The version of the configuration schema to which this shared flow conforms.\nThe only supported value currently is majorVersion 4 and minorVersion 0.\nThis setting may be used in the future to enable evolution of the shared\nflow format." + "description": "The version of the configuration schema to which this shared flow conforms. The only supported value currently is majorVersion 4 and minorVersion 0. This setting may be used in the future to enable evolution of the shared flow format." }, "contextInfo": { "description": "A textual description of the shared flow revision.", "type": "string" }, "createdAt": { - "description": "Time at which this shared flow revision was created, in milliseconds since\nepoch.", + "description": "Time at which this shared flow revision was created, in milliseconds since epoch.", "format": "int64", "type": "string" }, @@ -8649,7 +8694,7 @@ "type": "object" }, "lastModifiedAt": { - "description": "Time at which this shared flow revision was most recently modified, in\nmilliseconds since epoch.", + "description": "Time at which this shared flow revision was most recently modified, in milliseconds since epoch.", "format": "int64", "type": "string" }, @@ -8669,7 +8714,7 @@ "description": "The resource files included in this shared flow revision." }, "resources": { - "description": "A list of the resources included in this shared flow revision formatted as\n\"{type}://{name}\".", + "description": "A list of the resources included in this shared flow revision formatted as \"{type}://{name}\".", "items": { "type": "string" }, @@ -8712,7 +8757,7 @@ "type": "object" }, "GoogleCloudApigeeV1StatsEnvironmentStats": { - "description": "This message type encapsulates the environment wrapper:\n \"environments\": [\n {\n \"metrics\": [\n {\n \"name\": \"sum(message_count)\",\n \"values\": [\n \"2.52056245E8\"\n ]\n }\n ],\n \"name\": \"prod\"\n }\n ]", + "description": "This message type encapsulates the environment wrapper: \"environments\": [ { \"metrics\": [ { \"name\": \"sum(message_count)\", \"values\": [ \"2.52056245E8\" ] } ], \"name\": \"prod\" } ]", "id": "GoogleCloudApigeeV1StatsEnvironmentStats", "properties": { "dimensions": { @@ -8723,7 +8768,7 @@ "type": "array" }, "metrics": { - "description": "In the final response, only one of the following fields will be present\nbased on the dimensions provided. If no dimensions are provided, then\nonly a top level metrics is provided. If dimensions are included, then\nthere will be a top level dimensions field under environments which will\ncontain metrics values and the dimension name.\nExample:\n \"environments\": [\n {\n \"dimensions\": [\n {\n \"metrics\": [\n {\n \"name\": \"sum(message_count)\",\n \"values\": [\n \"2.14049521E8\"\n ]\n }\n ],\n \"name\": \"nit_proxy\"\n }\n ],\n \"name\": \"prod\"\n }\n ]\n\n OR\n \"environments\": [\n {\n \"metrics\": [\n {\n \"name\": \"sum(message_count)\",\n \"values\": [\n \"2.19026331E8\"\n ]\n }\n ],\n \"name\": \"prod\"\n }\n ]\nThis field contains the list of metric values.", + "description": "In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only a top level metrics is provided. If dimensions are included, then there will be a top level dimensions field under environments which will contain metrics values and the dimension name. Example: \"environments\": [ { \"dimensions\": [ { \"metrics\": [ { \"name\": \"sum(message_count)\", \"values\": [ \"2.14049521E8\" ] } ], \"name\": \"nit_proxy\" } ], \"name\": \"prod\" } ] OR \"environments\": [ { \"metrics\": [ { \"name\": \"sum(message_count)\", \"values\": [ \"2.19026331E8\" ] } ], \"name\": \"prod\" } ] This field contains the list of metric values.", "items": { "$ref": "GoogleCloudApigeeV1Metric" }, @@ -8740,7 +8785,7 @@ "id": "GoogleCloudApigeeV1Subscription", "properties": { "name": { - "description": "Full name of the Pub/Sub subcription. Use the following structure in your\nrequest:\n `subscription \"projects/foo/subscription/bar\"`", + "description": "Full name of the Pub/Sub subcription. Use the following structure in your request: `subscription \"projects/foo/subscription/bar\"`", "type": "string" } }, @@ -8750,12 +8795,12 @@ "id": "GoogleCloudApigeeV1SyncAuthorization", "properties": { "etag": { - "description": "Entity tag (ETag) used for optimistic concurrency control as a way to help\nprevent simultaneous updates from overwriting each other.\n\nFor example, when you call [getSyncAuthorization](getSyncAuthorization)\nan ETag is returned in the response. Pass that ETag when calling\nthe [setSyncAuthorization](setSyncAuthorization) to ensure\nthat you are updating the correct version. If you don't pass the\nETag in the call to `setSyncAuthorization`, then the\nexisting authorization is overwritten indiscriminately.\n\n**Note**: We strongly recommend that you use the ETag in the\nread-modify-write cycle to avoid race conditions.", + "description": "Entity tag (ETag) used for optimistic concurrency control as a way to help prevent simultaneous updates from overwriting each other. For example, when you call [getSyncAuthorization](getSyncAuthorization) an ETag is returned in the response. Pass that ETag when calling the [setSyncAuthorization](setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. **Note**: We strongly recommend that you use the ETag in the read-modify-write cycle to avoid race conditions.", "format": "byte", "type": "string" }, "identities": { - "description": "Required. Array of service accounts to grant access to control plane\nresources, each specified using the following\nformat: `serviceAccount:`service-account-name.\n\nThe service-account-name is formatted like an email address. For\nexample:\n`my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com`\n\nYou might specify multiple service accounts, for example, if you have\nmultiple environments and wish to assign a unique service account to each\none.\n\nThe service accounts must have **Apigee Synchronizer Manager** role.\nSee also [Create service\naccounts](https://docs.apigee.com/hybrid/latest/sa-about#create-the-service-accounts).", + "description": "Required. Array of service accounts to grant access to control plane resources, each specified using the following format: `serviceAccount:` service-account-name. The service-account-name is formatted like an email address. For example: `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` You might specify multiple service accounts, for example, if you have multiple environments and wish to assign a unique service account to each one. The service accounts must have **Apigee Synchronizer Manager** role. See also [Create service accounts](https://docs.apigee.com/hybrid/latest/sa-about#create-the-service-accounts).", "items": { "type": "string" }, @@ -8765,7 +8810,7 @@ "type": "object" }, "GoogleCloudApigeeV1TargetServer": { - "description": "TargetServer configuration. TargetServers are used to decouple a proxy's\nTargetEndpoint HTTPTargetConnections from concrete URLs for backend services.", + "description": "TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.", "id": "GoogleCloudApigeeV1TargetServer", "properties": { "description": { @@ -8773,25 +8818,25 @@ "type": "string" }, "host": { - "description": "Required. The host name this target connects to. Value must be a valid\nhostname as described by RFC-1123.", + "description": "Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.", "type": "string" }, "isEnabled": { - "description": "Optional. Enabling/disabling a TargetServer is useful when TargetServers\nare used in load balancing configurations, and one or more TargetServers\nneed to taken out of rotation periodically. Defaults to true.", + "description": "Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.", "type": "boolean" }, "name": { - "description": "Required. The resource id of this target server. Values must match the\nregular expression ", + "description": "Required. The resource id of this target server. Values must match the regular expression ", "type": "string" }, "port": { - "description": "Required. The port number this target connects to on the given host. Value\nmust be between 1 and 65535, inclusive.", + "description": "Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.", "format": "int32", "type": "integer" }, "sSLInfo": { "$ref": "GoogleCloudApigeeV1TlsInfo", - "description": "Optional. Specifies TLS configuration info for this TargetServer. The JSON\nname is `sSLInfo` for legacy/backwards compatibility reasons -- Edge\noriginally supported SSL, and the name is still used for TLS configuration." + "description": "Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration." } }, "type": "object" @@ -8804,7 +8849,7 @@ "type": "string" }, "name": { - "description": "The target server revision name. Must be of the form\n'organizations/{org}/environments/{env}/targetservers/{ts_id}/revisions/{rev}'.", + "description": "The target server revision name. Must be of the form 'organizations/{org}/environments/{env}/targetservers/{ts_id}/revisions/{rev}'.", "type": "string" }, "port": { @@ -8825,21 +8870,23 @@ "properties": { "error": { "description": "Output only. Error message of test connection failure", + "readOnly": true, "type": "string" }, "state": { "description": "Output only. It could be `completed` or `failed`", + "readOnly": true, "type": "string" } }, "type": "object" }, "GoogleCloudApigeeV1TlsInfo": { - "description": "TLS configuration information for\nVirtualHosts and\nTargetServers.", + "description": "TLS configuration information for VirtualHosts and TargetServers.", "id": "GoogleCloudApigeeV1TlsInfo", "properties": { "ciphers": { - "description": "The SSL/TLS cipher suites to be used. Must be one of the cipher suite names\nlisted in:\nhttp://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites", + "description": "The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites", "items": { "type": "string" }, @@ -8858,15 +8905,15 @@ "type": "boolean" }, "ignoreValidationErrors": { - "description": "If true, Edge ignores TLS certificate errors. Valid when configuring TLS\nfor target servers and target endpoints, and when configuring virtual hosts\nthat use 2-way TLS.\n\nWhen used with a target endpoint/target server, if the backend system uses\nSNI and returns a cert with a subject Distinguished Name (DN) that does not\nmatch the hostname, there is no way to ignore the error and the connection\nfails.", + "description": "If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails.", "type": "boolean" }, "keyAlias": { - "description": "Required if `client_auth_enabled` is true. The resource ID for the\nalias containing the private key and cert.", + "description": "Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert.", "type": "string" }, "keyStore": { - "description": "Required if `client_auth_enabled` is true. The resource ID of the\nkeystore. References not yet supported.", + "description": "Required if `client_auth_enabled` is true. The resource ID of the keystore. References not yet supported.", "type": "string" }, "protocols": { @@ -8877,7 +8924,7 @@ "type": "array" }, "trustStore": { - "description": "The resource ID of the truststore.\nReferences not yet supported.", + "description": "The resource ID of the truststore. References not yet supported.", "type": "string" } }, @@ -8924,7 +8971,7 @@ "type": "boolean" }, "keyAlias": { - "description": "The name of the Alias used for client side auth. It must be of the form:\norganizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}", + "description": "The name of the Alias used for client side auth. It must be of the form: organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}", "type": "string" }, "keyAliasReference": { @@ -8939,7 +8986,7 @@ "type": "array" }, "trustStore": { - "description": "The name of the Keystore or keystore reference containing trusted\ncertificates for the server. It must be of either the form\norganizations/{org}/environments/{env}/keystores/{keystore} or\norganizations/{org}/environments/{env}/references/{reference}.", + "description": "The name of the Keystore or keystore reference containing trusted certificates for the server. It must be of either the form organizations/{org}/environments/{env}/keystores/{keystore} or organizations/{org}/environments/{env}/references/{reference}.", "type": "string" } }, @@ -8971,23 +9018,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 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", - "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" }, @@ -8996,18 +9043,18 @@ "type": "string" }, "resource": { - "description": "The sub resource specific to this error (e.g. a proxy deployed within the\nEnvironmentConfig). If empty the error refers to the top level resource.", + "description": "The sub resource specific to this error (e.g. a proxy deployed within the EnvironmentConfig). If empty the error refers to the top level resource.", "type": "string" }, "type": { - "description": "A string that uniquely identifies the type of error. This provides a\nmore reliable means to deduplicate errors across revisions and instances.", + "description": "A string that uniquely identifies the type of error. This provides a more reliable means to deduplicate errors across revisions and instances.", "type": "string" } }, "type": "object" }, "GoogleIamV1AuditConfig": { - "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. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.", "id": "GoogleIamV1AuditConfig", "properties": { "auditLogConfigs": { @@ -9018,18 +9065,18 @@ "type": "array" }, "service": { - "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", + "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", "type": "string" } }, "type": "object" }, "GoogleIamV1AuditLogConfig": { - "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. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", "id": "GoogleIamV1AuditLogConfig", "properties": { "exemptedMembers": { - "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.", + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "items": { "type": "string" }, @@ -9060,24 +9107,24 @@ "properties": { "condition": { "$ref": "GoogleTypeExpr", - "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" }, "GoogleIamV1Policy": { - "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": "GoogleIamV1Policy", "properties": { "auditConfigs": { @@ -9088,19 +9135,19 @@ "type": "array" }, "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": "GoogleIamV1Binding" }, "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" } @@ -9113,10 +9160,10 @@ "properties": { "policy": { "$ref": "GoogleIamV1Policy", - "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." }, "updateMask": { - "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\n\n`paths: \"bindings, etag\"`", + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", "format": "google-fieldmask", "type": "string" } @@ -9128,7 +9175,7 @@ "id": "GoogleIamV1TestIamPermissionsRequest", "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" }, @@ -9142,7 +9189,7 @@ "id": "GoogleIamV1TestIamPermissionsResponse", "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" }, @@ -9170,11 +9217,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": { @@ -9186,11 +9233,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": { @@ -9198,20 +9245,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" }, "GoogleRpcPreconditionFailure": { - "description": "Describes what preconditions have failed.\n\nFor example, if an RPC failed because it required the Terms of Service to be\nacknowledged, it could list the terms of service violation in the\nPreconditionFailure message.", + "description": "Describes what preconditions have failed. For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message.", "id": "GoogleRpcPreconditionFailure", "properties": { "violations": { @@ -9229,22 +9276,22 @@ "id": "GoogleRpcPreconditionFailureViolation", "properties": { "description": { - "description": "A description of how the precondition failed. Developers can use this\ndescription to understand how to fix the failure.\n\nFor example: \"Terms of service not accepted\".", + "description": "A description of how the precondition failed. Developers can use this description to understand how to fix the failure. For example: \"Terms of service not accepted\".", "type": "string" }, "subject": { - "description": "The subject, relative to the type, that failed.\nFor example, \"google.com/cloud\" relative to the \"TOS\" type would indicate\nwhich terms of service is being referenced.", + "description": "The subject, relative to the type, that failed. For example, \"google.com/cloud\" relative to the \"TOS\" type would indicate which terms of service is being referenced.", "type": "string" }, "type": { - "description": "The type of PreconditionFailure. We recommend using a service-specific\nenum type to define the supported precondition violation subjects. For\nexample, \"TOS\" for \"Terms of Service violation\".", + "description": "The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, \"TOS\" for \"Terms of Service violation\".", "type": "string" } }, "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": { @@ -9253,7 +9300,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.", @@ -9264,30 +9311,30 @@ "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" }, "GoogleTypeExpr": { - "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": "GoogleTypeExpr", "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" } }, diff --git a/discovery/cloudprofiler-v2.json b/discovery/cloudprofiler-v2.json index 9370921b03..8236b398b3 100644 --- a/discovery/cloudprofiler-v2.json +++ b/discovery/cloudprofiler-v2.json @@ -116,7 +116,7 @@ "profiles": { "methods": { "create": { - "description": "CreateProfile creates a new profile resource in the online mode.\n\nThe server ensures that the new profiles are created at a constant rate per\ndeployment, so the creation request may hang for some time until the next\nprofile session is available.\n\nThe request may fail with ABORTED error if the creation is not available\nwithin ~1m, the response will indicate the duration of the backoff the\nclient should take before attempting creating a profile again. The backoff\nduration is returned in google.rpc.RetryInfo extension on the response\nstatus. To a gRPC client, the extension will be return as a\nbinary-serialized proto in the trailing metadata item named\n\"google.rpc.retryinfo-bin\".", + "description": "CreateProfile creates a new profile resource in the online mode. The server ensures that the new profiles are created at a constant rate per deployment, so the creation request may hang for some time until the next profile session is available. The request may fail with ABORTED error if the creation is not available within ~1m, the response will indicate the duration of the backoff the client should take before attempting creating a profile again. The backoff duration is returned in google.rpc.RetryInfo extension on the response status. To a gRPC client, the extension will be return as a binary-serialized proto in the trailing metadata item named \"google.rpc.retryinfo-bin\".", "flatPath": "v2/projects/{projectsId}/profiles", "httpMethod": "POST", "id": "cloudprofiler.projects.profiles.create", @@ -146,7 +146,7 @@ ] }, "createOffline": { - "description": "CreateOfflineProfile creates a new profile resource in the offline mode.\nThe client provides the profile to create along with the profile bytes, the\nserver records it.", + "description": "CreateOfflineProfile creates a new profile resource in the offline mode. The client provides the profile to create along with the profile bytes, the server records it.", "flatPath": "v2/projects/{projectsId}/profiles:createOffline", "httpMethod": "POST", "id": "cloudprofiler.projects.profiles.createOffline", @@ -176,7 +176,7 @@ ] }, "patch": { - "description": "UpdateProfile updates the profile bytes and labels on the profile resource\ncreated in the online mode. Updating the bytes for profiles created in the\noffline mode is currently not supported: the profile content must be\nprovided at the time of the profile creation.", + "description": "UpdateProfile updates the profile bytes and labels on the profile resource created in the online mode. Updating the bytes for profiles created in the offline mode is currently not supported: the profile content must be provided at the time of the profile creation.", "flatPath": "v2/projects/{projectsId}/profiles/{profilesId}", "httpMethod": "PATCH", "id": "cloudprofiler.projects.profiles.patch", @@ -192,7 +192,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask used to specify the fields to be overwritten. Currently only\nprofile_bytes and labels fields are supported by UpdateProfile, so only\nthose fields can be specified in the mask. When no mask is provided, all\nfields are overwritten.", + "description": "Field mask used to specify the fields to be overwritten. Currently only profile_bytes and labels fields are supported by UpdateProfile, so only those fields can be specified in the mask. When no mask is provided, all fields are overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -216,11 +216,11 @@ } } }, - "revision": "20200504", + "revision": "20200803", "rootUrl": "https://cloudprofiler.googleapis.com/", "schemas": { "CreateProfileRequest": { - "description": "CreateProfileRequest describes a profile resource online creation request.\nThe deployment field must be populated. The profile_type specifies the list\nof profile types supported by the agent. The creation call will hang until a\nprofile of one of these types needs to be collected.", + "description": "CreateProfileRequest describes a profile resource online creation request. The deployment field must be populated. The profile_type specifies the list of profile types supported by the agent. The creation call will hang until a profile of one of these types needs to be collected.", "id": "CreateProfileRequest", "properties": { "deployment": { @@ -233,11 +233,11 @@ "Unspecified profile type.", "Thread CPU time sampling.", "Wallclock time sampling. More expensive as stops all threads.", - "In-use heap profile. Represents a snapshot of the allocations that are\nlive at the time of the profiling.", + "In-use heap profile. Represents a snapshot of the allocations that are live at the time of the profiling.", "Single-shot collection of all thread stacks.", "Synchronization contention profile.", "Peak heap profile.", - "Heap allocation profile. It represents the aggregation of all allocations\nmade over the duration of the profile. All allocations are included,\nincluding those that might have been freed by the end of the profiling\ninterval. The profile is in particular useful for garbage collecting\nlanguages to understand which parts of the code create most of the garbage\ncollection pressure to see if those can be optimized." + "Heap allocation profile. It represents the aggregation of all allocations made over the duration of the profile. All allocations are included, including those that might have been freed by the end of the profiling interval. The profile is in particular useful for garbage collecting languages to understand which parts of the code create most of the garbage collection pressure to see if those can be optimized." ], "items": { "enum": [ @@ -250,6 +250,16 @@ "PEAK_HEAP", "HEAP_ALLOC" ], + "enumDescriptions": [ + "Unspecified profile type.", + "Thread CPU time sampling.", + "Wallclock time sampling. More expensive as stops all threads.", + "In-use heap profile. Represents a snapshot of the allocations that are live at the time of the profiling.", + "Single-shot collection of all thread stacks.", + "Synchronization contention profile.", + "Peak heap profile.", + "Heap allocation profile. It represents the aggregation of all allocations made over the duration of the profile. All allocations are included, including those that might have been freed by the end of the profiling interval. The profile is in particular useful for garbage collecting languages to understand which parts of the code create most of the garbage collection pressure to see if those can be optimized." + ], "type": "string" }, "type": "array" @@ -265,15 +275,15 @@ "additionalProperties": { "type": "string" }, - "description": "Labels identify the deployment within the user universe and same target.\nValidation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`.\nValue for an individual label must be <= 512 bytes, the total\nsize of all label names and values must be <= 1024 bytes.\n\nLabel named \"language\" can be used to record the programming language of\nthe profiled deployment. The standard choices for the value include \"java\",\n\"go\", \"python\", \"ruby\", \"nodejs\", \"php\", \"dotnet\".\n\nFor deployments running on Google Cloud Platform, \"zone\" or \"region\" label\nshould be present describing the deployment location. An example of a zone\nis \"us-central1-a\", an example of a region is \"us-central1\" or\n\"us-central\".", + "description": "Labels identify the deployment within the user universe and same target. Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. Value for an individual label must be <= 512 bytes, the total size of all label names and values must be <= 1024 bytes. Label named \"language\" can be used to record the programming language of the profiled deployment. The standard choices for the value include \"java\", \"go\", \"python\", \"ruby\", \"nodejs\", \"php\", \"dotnet\". For deployments running on Google Cloud Platform, \"zone\" or \"region\" label should be present describing the deployment location. An example of a zone is \"us-central1-a\", an example of a region is \"us-central1\" or \"us-central\".", "type": "object" }, "projectId": { - "description": "Project ID is the ID of a cloud project.\nValidation regex: `^a-z{4,61}[a-z0-9]$`.", + "description": "Project ID is the ID of a cloud project. Validation regex: `^a-z{4,61}[a-z0-9]$`.", "type": "string" }, "target": { - "description": "Target is the service name used to group related deployments:\n* Service name for GAE Flex / Standard.\n* Cluster and container name for GKE.\n* User-specified string for direct GCE profiling (e.g. Java).\n* Job name for Dataflow.\nValidation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.", + "description": "Target is the service name used to group related deployments: * Service name for GAE Flex / Standard. * Cluster and container name for GKE. * User-specified string for direct GCE profiling (e.g. Java). * Job name for Dataflow. Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.", "type": "string" } }, @@ -288,7 +298,7 @@ "description": "Deployment this profile corresponds to." }, "duration": { - "description": "Duration of the profiling session.\nInput (for the offline mode) or output (for the online mode).\nThe field represents requested profiling duration. It may slightly differ\nfrom the effective profiling duration, which is recorded in the profile\ndata, in case the profiling can't be stopped immediately (e.g. in case\nstopping the profiling is handled asynchronously).", + "description": "Duration of the profiling session. Input (for the offline mode) or output (for the online mode). The field represents requested profiling duration. It may slightly differ from the effective profiling duration, which is recorded in the profile data, in case the profiling can't be stopped immediately (e.g. in case stopping the profiling is handled asynchronously).", "format": "google-duration", "type": "string" }, @@ -296,7 +306,7 @@ "additionalProperties": { "type": "string" }, - "description": "Input only. Labels associated to this specific profile. These labels will\nget merged with the deployment labels for the final data set. See\ndocumentation on deployment labels for validation rules and limits.", + "description": "Input only. Labels associated to this specific profile. These labels will get merged with the deployment labels for the final data set. See documentation on deployment labels for validation rules and limits.", "type": "object" }, "name": { @@ -304,12 +314,12 @@ "type": "string" }, "profileBytes": { - "description": "Input only. Profile bytes, as a gzip compressed serialized proto, the\nformat is https://github.com/google/pprof/blob/master/proto/profile.proto.", + "description": "Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto.", "format": "byte", "type": "string" }, "profileType": { - "description": "Type of profile.\nFor offline mode, this must be specified when creating the profile. For\nonline mode it is assigned and returned by the server.", + "description": "Type of profile. For offline mode, this must be specified when creating the profile. For online mode it is assigned and returned by the server.", "enum": [ "PROFILE_TYPE_UNSPECIFIED", "CPU", @@ -324,11 +334,11 @@ "Unspecified profile type.", "Thread CPU time sampling.", "Wallclock time sampling. More expensive as stops all threads.", - "In-use heap profile. Represents a snapshot of the allocations that are\nlive at the time of the profiling.", + "In-use heap profile. Represents a snapshot of the allocations that are live at the time of the profiling.", "Single-shot collection of all thread stacks.", "Synchronization contention profile.", "Peak heap profile.", - "Heap allocation profile. It represents the aggregation of all allocations\nmade over the duration of the profile. All allocations are included,\nincluding those that might have been freed by the end of the profiling\ninterval. The profile is in particular useful for garbage collecting\nlanguages to understand which parts of the code create most of the garbage\ncollection pressure to see if those can be optimized." + "Heap allocation profile. It represents the aggregation of all allocations made over the duration of the profile. All allocations are included, including those that might have been freed by the end of the profiling interval. The profile is in particular useful for garbage collecting languages to understand which parts of the code create most of the garbage collection pressure to see if those can be optimized." ], "type": "string" } diff --git a/discovery/container-v1beta1.json b/discovery/container-v1beta1.json index 982627edc8..53962cb96a 100644 --- a/discovery/container-v1beta1.json +++ b/discovery/container-v1beta1.json @@ -2484,7 +2484,7 @@ } } }, - "revision": "20200709", + "revision": "20200724", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2589,7 +2589,7 @@ "description": "NodeManagement configuration for this NodePool." }, "minCpuPlatform": { - "description": "Minimum CPU platform to be used by this instance. The instance may be\nscheduled on the specified or newer CPU platform. Applicable values are the\nfriendly names of CPU platforms, such as\nminCpuPlatform: "Intel Haswell" or\nminCpuPlatform: "Intel Sandy Bridge". For more\ninformation, read [how to specify min CPU\nplatform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)\nTo unset the min cpu platform field pass \"automatic\"\nas field value.", + "description": "Minimum CPU platform to be used by this instance. The instance may be\nscheduled on the specified or newer CPU platform. Applicable values are the\nfriendly names of CPU platforms, such as\n`minCpuPlatform: \"Intel Haswell\"` or\n`minCpuPlatform: \"Intel Sandy Bridge\"`. For more\ninformation, read [how to specify min CPU\nplatform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)\nTo unset the min cpu platform field pass \"automatic\"\nas field value.", "type": "string" }, "oauthScopes": { @@ -3755,7 +3755,7 @@ "id": "MaintenancePolicy", "properties": { "resourceVersion": { - "description": "A hash identifying the version of this policy, so that updates to fields of\nthe policy won't accidentally undo intermediate changes (and so that users\nof the API unaware of some fields won't accidentally remove other fields).\nMake a get() request to the cluster to get the current\nresource version and include it with requests to set the policy.", + "description": "A hash identifying the version of this policy, so that updates to fields of\nthe policy won't accidentally undo intermediate changes (and so that users\nof the API unaware of some fields won't accidentally remove other fields).\nMake a `get()` request to the cluster to get the current\nresource version and include it with requests to set the policy.", "type": "string" }, "window": { @@ -3991,11 +3991,11 @@ "additionalProperties": { "type": "string" }, - "description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the reserved keys:\n \"cluster-location\"\n \"cluster-name\"\n \"cluster-uid\"\n \"configure-sh\"\n \"containerd-configure-sh\"\n \"enable-oslogin\"\n \"gci-ensure-gke-docker\"\n \"gci-metrics-enabled\"\n \"gci-update-strategy\"\n \"instance-template\"\n \"kube-env\"\n \"startup-script\"\n \"user-data\"\n \"disable-address-manager\"\n \"windows-startup-script-ps1\"\n \"common-psm1\"\n \"k8s-node-setup-psm1\"\n \"install-ssh-psm1\"\n \"user-profile-psm1\"\n \"serial-port-logging-enable\"\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.", + "description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the reserved keys:\n - \"cluster-location\"\n - \"cluster-name\"\n - \"cluster-uid\"\n - \"configure-sh\"\n - \"containerd-configure-sh\"\n - \"enable-oslogin\"\n - \"gci-ensure-gke-docker\"\n - \"gci-metrics-enabled\"\n - \"gci-update-strategy\"\n - \"instance-template\"\n - \"kube-env\"\n - \"startup-script\"\n - \"user-data\"\n - \"disable-address-manager\"\n - \"windows-startup-script-ps1\"\n - \"common-psm1\"\n - \"k8s-node-setup-psm1\"\n - \"install-ssh-psm1\"\n - \"user-profile-psm1\"\n - \"serial-port-logging-enable\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.", "type": "object" }, "minCpuPlatform": { - "description": "Minimum CPU platform to be used by this instance. The instance may be\nscheduled on the specified or newer CPU platform. Applicable values are the\nfriendly names of CPU platforms, such as\nminCpuPlatform: "Intel Haswell" or\nminCpuPlatform: "Intel Sandy Bridge". For more\ninformation, read [how to specify min CPU\nplatform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)", + "description": "Minimum CPU platform to be used by this instance. The instance may be\nscheduled on the specified or newer CPU platform. Applicable values are the\nfriendly names of CPU platforms, such as\n`minCpuPlatform: \"Intel Haswell\"` or\n`minCpuPlatform: \"Intel Sandy Bridge\"`. For more\ninformation, read [how to specify min CPU\nplatform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)", "type": "string" }, "nodeGroup": { @@ -4466,7 +4466,7 @@ "id": "RecurringTimeWindow", "properties": { "recurrence": { - "description": "An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how\nthis window reccurs. They go on for the span of time between the start and\nend time.\n\nFor example, to have something repeat every weekday, you'd use:\n FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\nTo repeat some window daily (equivalent to the DailyMaintenanceWindow):\n FREQ=DAILY\nFor the first weekend of every month:\n FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU\nThis specifies how frequently the window starts. Eg, if you wanted to have\na 9-5 UTC-4 window every weekday, you'd use something like:\n\n start time = 2019-01-01T09:00:00-0400\n end time = 2019-01-01T17:00:00-0400\n recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\n\nWindows can span multiple days. Eg, to make the window encompass every\nweekend from midnight Saturday till the last minute of Sunday UTC:\n\n start time = 2019-01-05T00:00:00Z\n end time = 2019-01-07T23:59:00Z\n recurrence = FREQ=WEEKLY;BYDAY=SA\n\nNote the start and end time's specific dates are largely arbitrary except\nto specify duration of the window and when it first starts.\nThe FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.", + "description": "An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how\nthis window reccurs. They go on for the span of time between the start and\nend time.\n\nFor example, to have something repeat every weekday, you'd use:\n`FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR`\n\nTo repeat some window daily (equivalent to the DailyMaintenanceWindow):\n`FREQ=DAILY`\n\nFor the first weekend of every month:\n`FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU`\n\nThis specifies how frequently the window starts. Eg, if you wanted to have\na 9-5 UTC-4 window every weekday, you'd use something like:\n```\nstart time = 2019-01-01T09:00:00-0400\nend time = 2019-01-01T17:00:00-0400\nrecurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\n```\n\nWindows can span multiple days. Eg, to make the window encompass every\nweekend from midnight Saturday till the last minute of Sunday UTC:\n```\nstart time = 2019-01-05T00:00:00Z\nend time = 2019-01-07T23:59:00Z\nrecurrence = FREQ=WEEKLY;BYDAY=SA\n```\n\nNote the start and end time's specific dates are largely arbitrary except\nto specify duration of the window and when it first starts.\nThe FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.", "type": "string" }, "window": { @@ -4743,7 +4743,7 @@ "type": "string" }, "labelFingerprint": { - "description": "Required. The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nKubernetes Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a get() request to the\nresource to get the latest fingerprint.", + "description": "Required. The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nKubernetes Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a `get()` request to the\nresource to get the latest fingerprint.", "type": "string" }, "name": { diff --git a/discovery/displayvideo-v1.json b/discovery/displayvideo-v1.json index 2245874645..65af2a287b 100644 --- a/discovery/displayvideo-v1.json +++ b/discovery/displayvideo-v1.json @@ -117,7 +117,7 @@ "advertisers": { "methods": { "audit": { - "description": "Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their [respective resource limit]: (https://support.google.com/displayvideo/answer/6071450?hl=en)", + "description": "Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.", "flatPath": "v1/advertisers/{advertisersId}:audit", "httpMethod": "GET", "id": "displayvideo.advertisers.audit", @@ -3517,7 +3517,7 @@ ], "parameters": { "advertiserId": { - "description": "The ID of the DV3 partner that has access to the custom bidding algorithm.", + "description": "The ID of the DV360 partner that has access to the custom bidding algorithm.", "format": "int64", "location": "query", "type": "string" @@ -3531,7 +3531,7 @@ "type": "string" }, "partnerId": { - "description": "The ID of the DV3 partner that has access to the custom bidding algorithm.", + "description": "The ID of the DV360 partner that has access to the custom bidding algorithm.", "format": "int64", "location": "query", "type": "string" @@ -3553,7 +3553,7 @@ "parameterOrder": [], "parameters": { "advertiserId": { - "description": "The ID of the DV3 advertiser that has access to the custom bidding algorithm.", + "description": "The ID of the DV360 advertiser that has access to the custom bidding algorithm.", "format": "int64", "location": "query", "type": "string" @@ -3580,7 +3580,7 @@ "type": "string" }, "partnerId": { - "description": "The ID of the DV3 partner that has access to the custom bidding algorithm.", + "description": "The ID of the DV360 partner that has access to the custom bidding algorithm.", "format": "int64", "location": "query", "type": "string" @@ -4440,7 +4440,7 @@ "partners": { "methods": { "bulkEditPartnerAssignedTargetingOptions": { - "description": "Bulk edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.create_requests .", + "description": "Bulk edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests .", "flatPath": "v1/partners/{partnersId}:bulkEditPartnerAssignedTargetingOptions", "httpMethod": "POST", "id": "displayvideo.partners.bulkEditPartnerAssignedTargetingOptions", @@ -5733,7 +5733,7 @@ "users": { "methods": { "bulkEditAssignedUserRoles": { - "description": "Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deleted_assigned_user_roles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.created_assigned_user_roles.", + "description": "Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.createdAssignedUserRoles.", "flatPath": "v1/users/{usersId}:bulkEditAssignedUserRoles", "httpMethod": "POST", "id": "displayvideo.users.bulkEditAssignedUserRoles", @@ -5906,7 +5906,7 @@ } } }, - "revision": "20200804", + "revision": "20200806", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -6854,17 +6854,17 @@ "id": "AuditAdvertiserResponse", "properties": { "usedCampaignsCount": { - "description": "The number of ACTIVE and PAUSED campaigns under this advertiser. These campaigns count towards the limit of 9,999 campaigns per advertiser.", + "description": "The number of ACTIVE and PAUSED campaigns under this advertiser. These campaigns count towards the limit of 9999 campaigns per advertiser.", "format": "int64", "type": "string" }, "usedInsertionOrdersCount": { - "description": "The number of ACTIVE, PAUSED and DRAFT insertion orders under this advertiser. These insertion orders count towards the limit of 9,999 insertion orders per advertiser.", + "description": "The number of ACTIVE, PAUSED and DRAFT insertion orders under this advertiser. These insertion orders count towards the limit of 9999 insertion orders per advertiser.", "format": "int64", "type": "string" }, "usedLineItemsCount": { - "description": "The number of ACTIVE, PAUSED, and DRAFT line items under this advertiser. These line items count towards the limit of 9,999 line items per advertiser.", + "description": "The number of ACTIVE, PAUSED, and DRAFT line items under this advertiser. These line items count towards the limit of 9999 line items per advertiser.", "format": "int64", "type": "string" } @@ -7108,7 +7108,6 @@ "type": "object" }, "BulkEditAssignedUserRolesResponse": { - "description": "Response message for BulkEditAssignedUserRoles.", "id": "BulkEditAssignedUserRolesResponse", "properties": { "createdAssignedUserRoles": { @@ -11691,7 +11690,6 @@ "type": "object" }, "ListCustomBiddingAlgorithmsResponse": { - "description": "Response message for CustomBiddingAlgorithmService.ListCustomBiddingAlgorithms.", "id": "ListCustomBiddingAlgorithmsResponse", "properties": { "customBiddingAlgorithms": { @@ -11900,7 +11898,6 @@ "type": "object" }, "ListPartnerAssignedTargetingOptionsResponse": { - "description": "Response message for ListPartnerAssignedTargetingOptions.", "id": "ListPartnerAssignedTargetingOptionsResponse", "properties": { "assignedTargetingOptions": { @@ -11918,7 +11915,6 @@ "type": "object" }, "ListPartnersResponse": { - "description": "Response message for ListPartners.", "id": "ListPartnersResponse", "properties": { "nextPageToken": { @@ -11972,7 +11968,6 @@ "type": "object" }, "ListUsersResponse": { - "description": "Response message for ListUsers.", "id": "ListUsersResponse", "properties": { "nextPageToken": { diff --git a/discovery/dlp-v2.json b/discovery/dlp-v2.json index bd0127ae50..ff5602b0ef 100644 --- a/discovery/dlp-v2.json +++ b/discovery/dlp-v2.json @@ -108,19 +108,19 @@ "infoTypes": { "methods": { "list": { - "description": "Returns a list of the sensitive information types that the DLP API\nsupports. See https://cloud.google.com/dlp/docs/infotypes-reference to\nlearn more.", + "description": "Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/dlp/docs/infotypes-reference to learn more.", "flatPath": "v2/infoTypes", "httpMethod": "GET", "id": "dlp.infoTypes.list", "parameterOrder": [], "parameters": { "filter": { - "description": "filter to only return infoTypes supported by certain parts of the\nAPI. Defaults to supported_by=INSPECT.", + "description": "filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.", "location": "query", "type": "string" }, "languageCode": { - "description": "BCP-47 language code for localized infoType friendly\nnames. If omitted, or if localized strings are not available,\nen-US strings will be returned.", + "description": "BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.", "location": "query", "type": "string" }, @@ -130,7 +130,7 @@ "type": "string" }, "parent": { - "description": "The parent resource name.\n- Format:locations/[LOCATION-ID]", + "description": "The parent resource name. - Format:locations/[LOCATION-ID]", "location": "query", "type": "string" } @@ -150,7 +150,7 @@ "infoTypes": { "methods": { "list": { - "description": "Returns a list of the sensitive information types that the DLP API\nsupports. See https://cloud.google.com/dlp/docs/infotypes-reference to\nlearn more.", + "description": "Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/dlp/docs/infotypes-reference to learn more.", "flatPath": "v2/locations/{locationsId}/infoTypes", "httpMethod": "GET", "id": "dlp.locations.infoTypes.list", @@ -159,12 +159,12 @@ ], "parameters": { "filter": { - "description": "filter to only return infoTypes supported by certain parts of the\nAPI. Defaults to supported_by=INSPECT.", + "description": "filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.", "location": "query", "type": "string" }, "languageCode": { - "description": "BCP-47 language code for localized infoType friendly\nnames. If omitted, or if localized strings are not available,\nen-US strings will be returned.", + "description": "BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.", "location": "query", "type": "string" }, @@ -174,7 +174,7 @@ "type": "string" }, "parent": { - "description": "The parent resource name.\n- Format:locations/[LOCATION-ID]", + "description": "The parent resource name. - Format:locations/[LOCATION-ID]", "location": "path", "pattern": "^locations/[^/]+$", "required": true, @@ -198,7 +198,7 @@ "deidentifyTemplates": { "methods": { "create": { - "description": "Creates a DeidentifyTemplate for re-using frequently used configuration\nfor de-identifying content, images, and storage.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Creates a DeidentifyTemplate for re-using frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates", "httpMethod": "POST", "id": "dlp.organizations.deidentifyTemplates.create", @@ -207,7 +207,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -226,7 +226,7 @@ ] }, "delete": { - "description": "Deletes a DeidentifyTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "DELETE", "id": "dlp.organizations.deidentifyTemplates.delete", @@ -235,7 +235,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.", + "description": "Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.", "location": "path", "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$", "required": true, @@ -251,7 +251,7 @@ ] }, "get": { - "description": "Gets a DeidentifyTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "GET", "id": "dlp.organizations.deidentifyTemplates.get", @@ -260,7 +260,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.", + "description": "Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.", "location": "path", "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$", "required": true, @@ -276,7 +276,7 @@ ] }, "list": { - "description": "Lists DeidentifyTemplates.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates", "httpMethod": "GET", "id": "dlp.organizations.deidentifyTemplates.list", @@ -290,23 +290,23 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case-insensitive,\ndefault sorting order is ascending, redundant space characters are\ninsignificant.\n\nExample: `name asc,update_time, create_time desc`\n\nSupported fields are:\n\n- `create_time`: corresponds to time the template was created.\n- `update_time`: corresponds to time the template was last updated.\n- `name`: corresponds to template's name.\n- `display_name`: corresponds to template's display name.", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name.", "location": "query", "type": "string" }, "pageSize": { - "description": "Size of the page, can be limited by server. If zero server returns\na page of max size 100.", + "description": "Size of the page, can be limited by server. If zero server returns a page of max size 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Page token to continue retrieval. Comes from previous call\nto `ListDeidentifyTemplates`.", + "description": "Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -322,7 +322,7 @@ ] }, "patch": { - "description": "Updates the DeidentifyTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "PATCH", "id": "dlp.organizations.deidentifyTemplates.patch", @@ -331,7 +331,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.", + "description": "Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.", "location": "path", "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$", "required": true, @@ -354,7 +354,7 @@ "inspectTemplates": { "methods": { "create": { - "description": "Creates an InspectTemplate for re-using frequently used configuration\nfor inspecting content, images, and storage.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Creates an InspectTemplate for re-using frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/inspectTemplates", "httpMethod": "POST", "id": "dlp.organizations.inspectTemplates.create", @@ -363,7 +363,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -382,7 +382,7 @@ ] }, "delete": { - "description": "Deletes an InspectTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "DELETE", "id": "dlp.organizations.inspectTemplates.delete", @@ -391,7 +391,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.", + "description": "Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.", "location": "path", "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$", "required": true, @@ -407,7 +407,7 @@ ] }, "get": { - "description": "Gets an InspectTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "GET", "id": "dlp.organizations.inspectTemplates.get", @@ -416,7 +416,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.", + "description": "Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.", "location": "path", "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$", "required": true, @@ -432,7 +432,7 @@ ] }, "list": { - "description": "Lists InspectTemplates.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/inspectTemplates", "httpMethod": "GET", "id": "dlp.organizations.inspectTemplates.list", @@ -446,23 +446,23 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case-insensitive,\ndefault sorting order is ascending, redundant space characters are\ninsignificant.\n\nExample: `name asc,update_time, create_time desc`\n\nSupported fields are:\n\n- `create_time`: corresponds to time the template was created.\n- `update_time`: corresponds to time the template was last updated.\n- `name`: corresponds to template's name.\n- `display_name`: corresponds to template's display name.", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name.", "location": "query", "type": "string" }, "pageSize": { - "description": "Size of the page, can be limited by server. If zero server returns\na page of max size 100.", + "description": "Size of the page, can be limited by server. If zero server returns a page of max size 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Page token to continue retrieval. Comes from previous call\nto `ListInspectTemplates`.", + "description": "Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -478,7 +478,7 @@ ] }, "patch": { - "description": "Updates the InspectTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "PATCH", "id": "dlp.organizations.inspectTemplates.patch", @@ -487,7 +487,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.", + "description": "Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.", "location": "path", "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$", "required": true, @@ -512,7 +512,7 @@ "deidentifyTemplates": { "methods": { "create": { - "description": "Creates a DeidentifyTemplate for re-using frequently used configuration\nfor de-identifying content, images, and storage.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Creates a DeidentifyTemplate for re-using frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates", "httpMethod": "POST", "id": "dlp.organizations.locations.deidentifyTemplates.create", @@ -521,7 +521,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -540,7 +540,7 @@ ] }, "delete": { - "description": "Deletes a DeidentifyTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "DELETE", "id": "dlp.organizations.locations.deidentifyTemplates.delete", @@ -549,7 +549,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.", + "description": "Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/deidentifyTemplates/[^/]+$", "required": true, @@ -565,7 +565,7 @@ ] }, "get": { - "description": "Gets a DeidentifyTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "GET", "id": "dlp.organizations.locations.deidentifyTemplates.get", @@ -574,7 +574,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.", + "description": "Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/deidentifyTemplates/[^/]+$", "required": true, @@ -590,7 +590,7 @@ ] }, "list": { - "description": "Lists DeidentifyTemplates.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates", "httpMethod": "GET", "id": "dlp.organizations.locations.deidentifyTemplates.list", @@ -604,23 +604,23 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case-insensitive,\ndefault sorting order is ascending, redundant space characters are\ninsignificant.\n\nExample: `name asc,update_time, create_time desc`\n\nSupported fields are:\n\n- `create_time`: corresponds to time the template was created.\n- `update_time`: corresponds to time the template was last updated.\n- `name`: corresponds to template's name.\n- `display_name`: corresponds to template's display name.", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name.", "location": "query", "type": "string" }, "pageSize": { - "description": "Size of the page, can be limited by server. If zero server returns\na page of max size 100.", + "description": "Size of the page, can be limited by server. If zero server returns a page of max size 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Page token to continue retrieval. Comes from previous call\nto `ListDeidentifyTemplates`.", + "description": "Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -636,7 +636,7 @@ ] }, "patch": { - "description": "Updates the DeidentifyTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "PATCH", "id": "dlp.organizations.locations.deidentifyTemplates.patch", @@ -645,7 +645,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.", + "description": "Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/deidentifyTemplates/[^/]+$", "required": true, @@ -668,7 +668,7 @@ "inspectTemplates": { "methods": { "create": { - "description": "Creates an InspectTemplate for re-using frequently used configuration\nfor inspecting content, images, and storage.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Creates an InspectTemplate for re-using frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates", "httpMethod": "POST", "id": "dlp.organizations.locations.inspectTemplates.create", @@ -677,7 +677,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -696,7 +696,7 @@ ] }, "delete": { - "description": "Deletes an InspectTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "DELETE", "id": "dlp.organizations.locations.inspectTemplates.delete", @@ -705,7 +705,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.", + "description": "Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/inspectTemplates/[^/]+$", "required": true, @@ -721,7 +721,7 @@ ] }, "get": { - "description": "Gets an InspectTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "GET", "id": "dlp.organizations.locations.inspectTemplates.get", @@ -730,7 +730,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.", + "description": "Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/inspectTemplates/[^/]+$", "required": true, @@ -746,7 +746,7 @@ ] }, "list": { - "description": "Lists InspectTemplates.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates", "httpMethod": "GET", "id": "dlp.organizations.locations.inspectTemplates.list", @@ -760,23 +760,23 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case-insensitive,\ndefault sorting order is ascending, redundant space characters are\ninsignificant.\n\nExample: `name asc,update_time, create_time desc`\n\nSupported fields are:\n\n- `create_time`: corresponds to time the template was created.\n- `update_time`: corresponds to time the template was last updated.\n- `name`: corresponds to template's name.\n- `display_name`: corresponds to template's display name.", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name.", "location": "query", "type": "string" }, "pageSize": { - "description": "Size of the page, can be limited by server. If zero server returns\na page of max size 100.", + "description": "Size of the page, can be limited by server. If zero server returns a page of max size 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Page token to continue retrieval. Comes from previous call\nto `ListInspectTemplates`.", + "description": "Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -792,7 +792,7 @@ ] }, "patch": { - "description": "Updates the InspectTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "PATCH", "id": "dlp.organizations.locations.inspectTemplates.patch", @@ -801,7 +801,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.", + "description": "Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/inspectTemplates/[^/]+$", "required": true, @@ -824,7 +824,7 @@ "storedInfoTypes": { "methods": { "create": { - "description": "Creates a pre-built stored infoType to be used for inspection.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes", "httpMethod": "POST", "id": "dlp.organizations.locations.storedInfoTypes.create", @@ -833,7 +833,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -852,7 +852,7 @@ ] }, "delete": { - "description": "Deletes a stored infoType.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "DELETE", "id": "dlp.organizations.locations.storedInfoTypes.delete", @@ -861,7 +861,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and storedInfoType to be deleted, for\nexample `organizations/433245324/storedInfoTypes/432452342` or\nprojects/project-id/storedInfoTypes/432452342.", + "description": "Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/storedInfoTypes/[^/]+$", "required": true, @@ -877,7 +877,7 @@ ] }, "get": { - "description": "Gets a stored infoType.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "GET", "id": "dlp.organizations.locations.storedInfoTypes.get", @@ -886,7 +886,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and storedInfoType to be read, for\nexample `organizations/433245324/storedInfoTypes/432452342` or\nprojects/project-id/storedInfoTypes/432452342.", + "description": "Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/storedInfoTypes/[^/]+$", "required": true, @@ -902,7 +902,7 @@ ] }, "list": { - "description": "Lists stored infoTypes.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes", "httpMethod": "GET", "id": "dlp.organizations.locations.storedInfoTypes.list", @@ -916,23 +916,23 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case-insensitive,\ndefault sorting order is ascending, redundant space characters are\ninsignificant.\n\nExample: `name asc, display_name, create_time desc`\n\nSupported fields are:\n\n- `create_time`: corresponds to time the most recent version of the\nresource was created.\n- `state`: corresponds to the state of the resource.\n- `name`: corresponds to resource name.\n- `display_name`: corresponds to info type's display name.", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", "location": "query", "type": "string" }, "pageSize": { - "description": "Size of the page, can be limited by server. If zero server returns\na page of max size 100.", + "description": "Size of the page, can be limited by server. If zero server returns a page of max size 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Page token to continue retrieval. Comes from previous call\nto `ListStoredInfoTypes`.", + "description": "Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -948,7 +948,7 @@ ] }, "patch": { - "description": "Updates the stored infoType by creating a new version. The existing version\nwill continue to be used until the new version is ready.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "PATCH", "id": "dlp.organizations.locations.storedInfoTypes.patch", @@ -957,7 +957,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of organization and storedInfoType to be updated, for\nexample `organizations/433245324/storedInfoTypes/432452342` or\nprojects/project-id/storedInfoTypes/432452342.", + "description": "Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/storedInfoTypes/[^/]+$", "required": true, @@ -982,7 +982,7 @@ "storedInfoTypes": { "methods": { "create": { - "description": "Creates a pre-built stored infoType to be used for inspection.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/storedInfoTypes", "httpMethod": "POST", "id": "dlp.organizations.storedInfoTypes.create", @@ -991,7 +991,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -1010,7 +1010,7 @@ ] }, "delete": { - "description": "Deletes a stored infoType.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "DELETE", "id": "dlp.organizations.storedInfoTypes.delete", @@ -1019,7 +1019,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and storedInfoType to be deleted, for\nexample `organizations/433245324/storedInfoTypes/432452342` or\nprojects/project-id/storedInfoTypes/432452342.", + "description": "Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.", "location": "path", "pattern": "^organizations/[^/]+/storedInfoTypes/[^/]+$", "required": true, @@ -1035,7 +1035,7 @@ ] }, "get": { - "description": "Gets a stored infoType.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "GET", "id": "dlp.organizations.storedInfoTypes.get", @@ -1044,7 +1044,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and storedInfoType to be read, for\nexample `organizations/433245324/storedInfoTypes/432452342` or\nprojects/project-id/storedInfoTypes/432452342.", + "description": "Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.", "location": "path", "pattern": "^organizations/[^/]+/storedInfoTypes/[^/]+$", "required": true, @@ -1060,7 +1060,7 @@ ] }, "list": { - "description": "Lists stored infoTypes.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/storedInfoTypes", "httpMethod": "GET", "id": "dlp.organizations.storedInfoTypes.list", @@ -1074,23 +1074,23 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case-insensitive,\ndefault sorting order is ascending, redundant space characters are\ninsignificant.\n\nExample: `name asc, display_name, create_time desc`\n\nSupported fields are:\n\n- `create_time`: corresponds to time the most recent version of the\nresource was created.\n- `state`: corresponds to the state of the resource.\n- `name`: corresponds to resource name.\n- `display_name`: corresponds to info type's display name.", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", "location": "query", "type": "string" }, "pageSize": { - "description": "Size of the page, can be limited by server. If zero server returns\na page of max size 100.", + "description": "Size of the page, can be limited by server. If zero server returns a page of max size 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Page token to continue retrieval. Comes from previous call\nto `ListStoredInfoTypes`.", + "description": "Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -1106,7 +1106,7 @@ ] }, "patch": { - "description": "Updates the stored infoType by creating a new version. The existing version\nwill continue to be used until the new version is ready.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "PATCH", "id": "dlp.organizations.storedInfoTypes.patch", @@ -1115,7 +1115,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of organization and storedInfoType to be updated, for\nexample `organizations/433245324/storedInfoTypes/432452342` or\nprojects/project-id/storedInfoTypes/432452342.", + "description": "Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.", "location": "path", "pattern": "^organizations/[^/]+/storedInfoTypes/[^/]+$", "required": true, @@ -1142,7 +1142,7 @@ "content": { "methods": { "deidentify": { - "description": "De-identifies potentially sensitive info from a ContentItem.\nThis method has limits on input size and output size.\nSee https://cloud.google.com/dlp/docs/deidentify-sensitive-data to\nlearn more.\n\nWhen no InfoTypes or CustomInfoTypes are specified in this request, the\nsystem will automatically choose what detectors to run. By default this may\nbe all types, but may change over time as detectors are updated.", + "description": "De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", "flatPath": "v2/projects/{projectsId}/content:deidentify", "httpMethod": "POST", "id": "dlp.projects.content.deidentify", @@ -1151,7 +1151,7 @@ ], "parameters": { "parent": { - "description": "Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", + "description": "Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1170,7 +1170,7 @@ ] }, "inspect": { - "description": "Finds potentially sensitive info in content.\nThis method has limits on input size, processing time, and output size.\n\nWhen no InfoTypes or CustomInfoTypes are specified in this request, the\nsystem will automatically choose what detectors to run. By default this may\nbe all types, but may change over time as detectors are updated.\n\nFor how to guides, see https://cloud.google.com/dlp/docs/inspecting-images\nand https://cloud.google.com/dlp/docs/inspecting-text,", + "description": "Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text,", "flatPath": "v2/projects/{projectsId}/content:inspect", "httpMethod": "POST", "id": "dlp.projects.content.inspect", @@ -1179,7 +1179,7 @@ ], "parameters": { "parent": { - "description": "Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", + "description": "Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1198,7 +1198,7 @@ ] }, "reidentify": { - "description": "Re-identifies content that has been de-identified.\nSee\nhttps://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example\nto learn more.", + "description": "Re-identifies content that has been de-identified. See https://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.", "flatPath": "v2/projects/{projectsId}/content:reidentify", "httpMethod": "POST", "id": "dlp.projects.content.reidentify", @@ -1207,7 +1207,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", + "description": "Required. The parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1230,7 +1230,7 @@ "deidentifyTemplates": { "methods": { "create": { - "description": "Creates a DeidentifyTemplate for re-using frequently used configuration\nfor de-identifying content, images, and storage.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Creates a DeidentifyTemplate for re-using frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/deidentifyTemplates", "httpMethod": "POST", "id": "dlp.projects.deidentifyTemplates.create", @@ -1239,7 +1239,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1258,7 +1258,7 @@ ] }, "delete": { - "description": "Deletes a DeidentifyTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "DELETE", "id": "dlp.projects.deidentifyTemplates.delete", @@ -1267,7 +1267,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.", + "description": "Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.", "location": "path", "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$", "required": true, @@ -1283,7 +1283,7 @@ ] }, "get": { - "description": "Gets a DeidentifyTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "GET", "id": "dlp.projects.deidentifyTemplates.get", @@ -1292,7 +1292,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.", + "description": "Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.", "location": "path", "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$", "required": true, @@ -1308,7 +1308,7 @@ ] }, "list": { - "description": "Lists DeidentifyTemplates.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/deidentifyTemplates", "httpMethod": "GET", "id": "dlp.projects.deidentifyTemplates.list", @@ -1322,23 +1322,23 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case-insensitive,\ndefault sorting order is ascending, redundant space characters are\ninsignificant.\n\nExample: `name asc,update_time, create_time desc`\n\nSupported fields are:\n\n- `create_time`: corresponds to time the template was created.\n- `update_time`: corresponds to time the template was last updated.\n- `name`: corresponds to template's name.\n- `display_name`: corresponds to template's display name.", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name.", "location": "query", "type": "string" }, "pageSize": { - "description": "Size of the page, can be limited by server. If zero server returns\na page of max size 100.", + "description": "Size of the page, can be limited by server. If zero server returns a page of max size 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Page token to continue retrieval. Comes from previous call\nto `ListDeidentifyTemplates`.", + "description": "Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1354,7 +1354,7 @@ ] }, "patch": { - "description": "Updates the DeidentifyTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "PATCH", "id": "dlp.projects.deidentifyTemplates.patch", @@ -1363,7 +1363,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.", + "description": "Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.", "location": "path", "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$", "required": true, @@ -1386,7 +1386,7 @@ "dlpJobs": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running DlpJob. The server\nmakes a best effort to cancel the DlpJob, but success is not\nguaranteed.\nSee https://cloud.google.com/dlp/docs/inspecting-storage and\nhttps://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel", "httpMethod": "POST", "id": "dlp.projects.dlpJobs.cancel", @@ -1414,7 +1414,7 @@ ] }, "create": { - "description": "Creates a new job to inspect storage or calculate risk metrics.\nSee https://cloud.google.com/dlp/docs/inspecting-storage and\nhttps://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.\n\nWhen no InfoTypes or CustomInfoTypes are specified in inspect jobs, the\nsystem will automatically choose what detectors to run. By default this may\nbe all types, but may change over time as detectors are updated.", + "description": "Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", "flatPath": "v2/projects/{projectsId}/dlpJobs", "httpMethod": "POST", "id": "dlp.projects.dlpJobs.create", @@ -1423,7 +1423,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1442,7 +1442,7 @@ ] }, "delete": { - "description": "Deletes a long-running DlpJob. This method indicates that the client is\nno longer interested in the DlpJob result. The job will be cancelled if\npossible.\nSee https://cloud.google.com/dlp/docs/inspecting-storage and\nhttps://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be cancelled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/dlpJobs/{dlpJobsId}", "httpMethod": "DELETE", "id": "dlp.projects.dlpJobs.delete", @@ -1467,7 +1467,7 @@ ] }, "get": { - "description": "Gets the latest state of a long-running DlpJob.\nSee https://cloud.google.com/dlp/docs/inspecting-storage and\nhttps://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Gets the latest state of a long-running DlpJob. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/dlpJobs/{dlpJobsId}", "httpMethod": "GET", "id": "dlp.projects.dlpJobs.get", @@ -1492,7 +1492,7 @@ ] }, "list": { - "description": "Lists DlpJobs that match the specified filter in the request.\nSee https://cloud.google.com/dlp/docs/inspecting-storage and\nhttps://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/dlpJobs", "httpMethod": "GET", "id": "dlp.projects.dlpJobs.list", @@ -1501,7 +1501,7 @@ ], "parameters": { "filter": { - "description": "Allows filtering.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by `AND` or `OR` logical operators. A\nsequence of restrictions implicitly uses `AND`.\n* A restriction has the form of `{field} {operator} {value}`.\n* Supported fields/values for inspect jobs:\n - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED\n - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY\n - `trigger_name` - The resource name of the trigger that created job.\n - 'end_time` - Corresponds to time the job finished.\n - 'start_time` - Corresponds to time the job finished.\n* Supported fields for risk analysis jobs:\n - `state` - RUNNING|CANCELED|FINISHED|FAILED\n - 'end_time` - Corresponds to time the job finished.\n - 'start_time` - Corresponds to time the job finished.\n* The operator must be `=` or `!=`.\n\nExamples:\n\n* inspected_storage = cloud_storage AND state = done\n* inspected_storage = cloud_storage OR inspected_storage = bigquery\n* inspected_storage = cloud_storage AND (state = done OR state = canceled)\n* end_time > \\\"2017-12-12T00:00:00+00:00\\\"\n\nThe length of this field should be no more than 500 characters.", + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -1511,7 +1511,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case-insensitive,\ndefault sorting order is ascending, redundant space characters are\ninsignificant.\n\nExample: `name asc, end_time asc, create_time desc`\n\nSupported fields are:\n\n- `create_time`: corresponds to time the job was created.\n- `end_time`: corresponds to time the job ended.\n- `name`: corresponds to job's name.\n- `state`: corresponds to `state`", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state`", "location": "query", "type": "string" }, @@ -1527,7 +1527,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1540,6 +1540,11 @@ "INSPECT_JOB", "RISK_ANALYSIS_JOB" ], + "enumDescriptions": [ + "Unused", + "The job inspected Google Cloud for sensitive data.", + "The job executed a Risk Analysis computation." + ], "location": "query", "type": "string" } @@ -1557,7 +1562,7 @@ "image": { "methods": { "redact": { - "description": "Redacts potentially sensitive info from an image.\nThis method has limits on input size, processing time, and output size.\nSee https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to\nlearn more.\n\nWhen no InfoTypes or CustomInfoTypes are specified in this request, the\nsystem will automatically choose what detectors to run. By default this may\nbe all types, but may change over time as detectors are updated.", + "description": "Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", "flatPath": "v2/projects/{projectsId}/image:redact", "httpMethod": "POST", "id": "dlp.projects.image.redact", @@ -1566,7 +1571,7 @@ ], "parameters": { "parent": { - "description": "The parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", + "description": "The parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1589,7 +1594,7 @@ "inspectTemplates": { "methods": { "create": { - "description": "Creates an InspectTemplate for re-using frequently used configuration\nfor inspecting content, images, and storage.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Creates an InspectTemplate for re-using frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/inspectTemplates", "httpMethod": "POST", "id": "dlp.projects.inspectTemplates.create", @@ -1598,7 +1603,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1617,7 +1622,7 @@ ] }, "delete": { - "description": "Deletes an InspectTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "DELETE", "id": "dlp.projects.inspectTemplates.delete", @@ -1626,7 +1631,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.", + "description": "Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.", "location": "path", "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$", "required": true, @@ -1642,7 +1647,7 @@ ] }, "get": { - "description": "Gets an InspectTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "GET", "id": "dlp.projects.inspectTemplates.get", @@ -1651,7 +1656,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.", + "description": "Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.", "location": "path", "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$", "required": true, @@ -1667,7 +1672,7 @@ ] }, "list": { - "description": "Lists InspectTemplates.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/inspectTemplates", "httpMethod": "GET", "id": "dlp.projects.inspectTemplates.list", @@ -1681,23 +1686,23 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case-insensitive,\ndefault sorting order is ascending, redundant space characters are\ninsignificant.\n\nExample: `name asc,update_time, create_time desc`\n\nSupported fields are:\n\n- `create_time`: corresponds to time the template was created.\n- `update_time`: corresponds to time the template was last updated.\n- `name`: corresponds to template's name.\n- `display_name`: corresponds to template's display name.", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name.", "location": "query", "type": "string" }, "pageSize": { - "description": "Size of the page, can be limited by server. If zero server returns\na page of max size 100.", + "description": "Size of the page, can be limited by server. If zero server returns a page of max size 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Page token to continue retrieval. Comes from previous call\nto `ListInspectTemplates`.", + "description": "Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1713,7 +1718,7 @@ ] }, "patch": { - "description": "Updates the InspectTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "PATCH", "id": "dlp.projects.inspectTemplates.patch", @@ -1722,7 +1727,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.", + "description": "Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.", "location": "path", "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$", "required": true, @@ -1745,7 +1750,7 @@ "jobTriggers": { "methods": { "activate": { - "description": "Activate a job trigger. Causes the immediate execute of a trigger\ninstead of waiting on the trigger event to occur.", + "description": "Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.", "flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}:activate", "httpMethod": "POST", "id": "dlp.projects.jobTriggers.activate", @@ -1754,7 +1759,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the trigger to activate, for example\n`projects/dlp-test-project/jobTriggers/53234423`.", + "description": "Required. Resource name of the trigger to activate, for example `projects/dlp-test-project/jobTriggers/53234423`.", "location": "path", "pattern": "^projects/[^/]+/jobTriggers/[^/]+$", "required": true, @@ -1773,7 +1778,7 @@ ] }, "create": { - "description": "Creates a job trigger to run DLP actions such as scanning storage for\nsensitive information on a set schedule.\nSee https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/jobTriggers", "httpMethod": "POST", "id": "dlp.projects.jobTriggers.create", @@ -1782,7 +1787,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1801,7 +1806,7 @@ ] }, "delete": { - "description": "Deletes a job trigger.\nSee https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}", "httpMethod": "DELETE", "id": "dlp.projects.jobTriggers.delete", @@ -1810,7 +1815,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the project and the triggeredJob, for example\n`projects/dlp-test-project/jobTriggers/53234423`.", + "description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.", "location": "path", "pattern": "^projects/[^/]+/jobTriggers/[^/]+$", "required": true, @@ -1826,7 +1831,7 @@ ] }, "get": { - "description": "Gets a job trigger.\nSee https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}", "httpMethod": "GET", "id": "dlp.projects.jobTriggers.get", @@ -1835,7 +1840,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the project and the triggeredJob, for example\n`projects/dlp-test-project/jobTriggers/53234423`.", + "description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.", "location": "path", "pattern": "^projects/[^/]+/jobTriggers/[^/]+$", "required": true, @@ -1851,7 +1856,7 @@ ] }, "list": { - "description": "Lists job triggers.\nSee https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/jobTriggers", "httpMethod": "GET", "id": "dlp.projects.jobTriggers.list", @@ -1860,7 +1865,7 @@ ], "parameters": { "filter": { - "description": "Allows filtering.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by `AND` or `OR` logical operators. A\nsequence of restrictions implicitly uses `AND`.\n* A restriction has the form of `{field} {operator} {value}`.\n* Supported fields/values for inspect jobs:\n - `status` - HEALTHY|PAUSED|CANCELLED\n - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY\n - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by\n quotation marks. Nanoseconds are ignored.\n - 'error_count' - Number of errors that have occurred while running.\n* The operator must be `=` or `!=` for status and inspected_storage.\n\nExamples:\n\n* inspected_storage = cloud_storage AND status = HEALTHY\n* inspected_storage = cloud_storage OR inspected_storage = bigquery\n* inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY)\n* last_run_time > \\\"2017-12-12T00:00:00+00:00\\\"\n\nThe length of this field should be no more than 500 characters.", + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -1870,7 +1875,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of triggeredJob fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case-insensitive,\ndefault sorting order is ascending, redundant space characters are\ninsignificant.\n\nExample: `name asc,update_time, create_time desc`\n\nSupported fields are:\n\n- `create_time`: corresponds to time the JobTrigger was created.\n- `update_time`: corresponds to time the JobTrigger was last updated.\n- `last_run_time`: corresponds to the last time the JobTrigger ran.\n- `name`: corresponds to JobTrigger's name.\n- `display_name`: corresponds to JobTrigger's display name.\n- `status`: corresponds to JobTrigger's status.", + "description": "Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status.", "location": "query", "type": "string" }, @@ -1881,12 +1886,12 @@ "type": "integer" }, "pageToken": { - "description": "Page token to continue retrieval. Comes from previous call\nto ListJobTriggers. `order_by` field must not\nchange for subsequent calls.", + "description": "Page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1902,7 +1907,7 @@ ] }, "patch": { - "description": "Updates a job trigger.\nSee https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}", "httpMethod": "PATCH", "id": "dlp.projects.jobTriggers.patch", @@ -1911,7 +1916,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the project and the triggeredJob, for example\n`projects/dlp-test-project/jobTriggers/53234423`.", + "description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.", "location": "path", "pattern": "^projects/[^/]+/jobTriggers/[^/]+$", "required": true, @@ -1936,7 +1941,7 @@ "content": { "methods": { "deidentify": { - "description": "De-identifies potentially sensitive info from a ContentItem.\nThis method has limits on input size and output size.\nSee https://cloud.google.com/dlp/docs/deidentify-sensitive-data to\nlearn more.\n\nWhen no InfoTypes or CustomInfoTypes are specified in this request, the\nsystem will automatically choose what detectors to run. By default this may\nbe all types, but may change over time as detectors are updated.", + "description": "De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/content:deidentify", "httpMethod": "POST", "id": "dlp.projects.locations.content.deidentify", @@ -1945,7 +1950,7 @@ ], "parameters": { "parent": { - "description": "Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", + "description": "Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1964,7 +1969,7 @@ ] }, "inspect": { - "description": "Finds potentially sensitive info in content.\nThis method has limits on input size, processing time, and output size.\n\nWhen no InfoTypes or CustomInfoTypes are specified in this request, the\nsystem will automatically choose what detectors to run. By default this may\nbe all types, but may change over time as detectors are updated.\n\nFor how to guides, see https://cloud.google.com/dlp/docs/inspecting-images\nand https://cloud.google.com/dlp/docs/inspecting-text,", + "description": "Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text,", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/content:inspect", "httpMethod": "POST", "id": "dlp.projects.locations.content.inspect", @@ -1973,7 +1978,7 @@ ], "parameters": { "parent": { - "description": "Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", + "description": "Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1992,7 +1997,7 @@ ] }, "reidentify": { - "description": "Re-identifies content that has been de-identified.\nSee\nhttps://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example\nto learn more.", + "description": "Re-identifies content that has been de-identified. See https://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/content:reidentify", "httpMethod": "POST", "id": "dlp.projects.locations.content.reidentify", @@ -2001,7 +2006,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", + "description": "Required. The parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2024,7 +2029,7 @@ "deidentifyTemplates": { "methods": { "create": { - "description": "Creates a DeidentifyTemplate for re-using frequently used configuration\nfor de-identifying content, images, and storage.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Creates a DeidentifyTemplate for re-using frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates", "httpMethod": "POST", "id": "dlp.projects.locations.deidentifyTemplates.create", @@ -2033,7 +2038,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2052,7 +2057,7 @@ ] }, "delete": { - "description": "Deletes a DeidentifyTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "DELETE", "id": "dlp.projects.locations.deidentifyTemplates.delete", @@ -2061,7 +2066,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.", + "description": "Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deidentifyTemplates/[^/]+$", "required": true, @@ -2077,7 +2082,7 @@ ] }, "get": { - "description": "Gets a DeidentifyTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "GET", "id": "dlp.projects.locations.deidentifyTemplates.get", @@ -2086,7 +2091,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.", + "description": "Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deidentifyTemplates/[^/]+$", "required": true, @@ -2102,7 +2107,7 @@ ] }, "list": { - "description": "Lists DeidentifyTemplates.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates", "httpMethod": "GET", "id": "dlp.projects.locations.deidentifyTemplates.list", @@ -2116,23 +2121,23 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case-insensitive,\ndefault sorting order is ascending, redundant space characters are\ninsignificant.\n\nExample: `name asc,update_time, create_time desc`\n\nSupported fields are:\n\n- `create_time`: corresponds to time the template was created.\n- `update_time`: corresponds to time the template was last updated.\n- `name`: corresponds to template's name.\n- `display_name`: corresponds to template's display name.", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name.", "location": "query", "type": "string" }, "pageSize": { - "description": "Size of the page, can be limited by server. If zero server returns\na page of max size 100.", + "description": "Size of the page, can be limited by server. If zero server returns a page of max size 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Page token to continue retrieval. Comes from previous call\nto `ListDeidentifyTemplates`.", + "description": "Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2148,7 +2153,7 @@ ] }, "patch": { - "description": "Updates the DeidentifyTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates-deid to learn\nmore.", + "description": "Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "PATCH", "id": "dlp.projects.locations.deidentifyTemplates.patch", @@ -2157,7 +2162,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/project-id/deidentifyTemplates/432452342.", + "description": "Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deidentifyTemplates/[^/]+$", "required": true, @@ -2180,7 +2185,7 @@ "dlpJobs": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running DlpJob. The server\nmakes a best effort to cancel the DlpJob, but success is not\nguaranteed.\nSee https://cloud.google.com/dlp/docs/inspecting-storage and\nhttps://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:cancel", "httpMethod": "POST", "id": "dlp.projects.locations.dlpJobs.cancel", @@ -2208,7 +2213,7 @@ ] }, "create": { - "description": "Creates a new job to inspect storage or calculate risk metrics.\nSee https://cloud.google.com/dlp/docs/inspecting-storage and\nhttps://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.\n\nWhen no InfoTypes or CustomInfoTypes are specified in inspect jobs, the\nsystem will automatically choose what detectors to run. By default this may\nbe all types, but may change over time as detectors are updated.", + "description": "Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs", "httpMethod": "POST", "id": "dlp.projects.locations.dlpJobs.create", @@ -2217,7 +2222,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2236,7 +2241,7 @@ ] }, "delete": { - "description": "Deletes a long-running DlpJob. This method indicates that the client is\nno longer interested in the DlpJob result. The job will be cancelled if\npossible.\nSee https://cloud.google.com/dlp/docs/inspecting-storage and\nhttps://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be cancelled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}", "httpMethod": "DELETE", "id": "dlp.projects.locations.dlpJobs.delete", @@ -2261,7 +2266,7 @@ ] }, "finish": { - "description": "Finish a running hybrid DlpJob. Triggers the finalization steps and running\nof any enabled actions that have not yet run.\nEarly access feature is in a pre-release state and might change or have\nlimited support. For more information, see\nhttps://cloud.google.com/products#product-launch-stages.", + "description": "Finish a running hybrid DlpJob. Triggers the finalization steps and running of any enabled actions that have not yet run. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:finish", "httpMethod": "POST", "id": "dlp.projects.locations.dlpJobs.finish", @@ -2289,7 +2294,7 @@ ] }, "get": { - "description": "Gets the latest state of a long-running DlpJob.\nSee https://cloud.google.com/dlp/docs/inspecting-storage and\nhttps://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Gets the latest state of a long-running DlpJob. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}", "httpMethod": "GET", "id": "dlp.projects.locations.dlpJobs.get", @@ -2314,7 +2319,7 @@ ] }, "hybridInspect": { - "description": "Inspect hybrid content and store findings to a job.\nTo review the findings inspect the job. Inspection will occur\nasynchronously.\nEarly access feature is in a pre-release state and might change or have\nlimited support. For more information, see\nhttps://cloud.google.com/products#product-launch-stages.", + "description": "Inspect hybrid content and store findings to a job. To review the findings inspect the job. Inspection will occur asynchronously. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:hybridInspect", "httpMethod": "POST", "id": "dlp.projects.locations.dlpJobs.hybridInspect", @@ -2323,7 +2328,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the job to execute a hybrid inspect on, for example\n`projects/dlp-test-project/dlpJob/53234423`.", + "description": "Required. Resource name of the job to execute a hybrid inspect on, for example `projects/dlp-test-project/dlpJob/53234423`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dlpJobs/[^/]+$", "required": true, @@ -2342,7 +2347,7 @@ ] }, "list": { - "description": "Lists DlpJobs that match the specified filter in the request.\nSee https://cloud.google.com/dlp/docs/inspecting-storage and\nhttps://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "description": "Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs", "httpMethod": "GET", "id": "dlp.projects.locations.dlpJobs.list", @@ -2351,7 +2356,7 @@ ], "parameters": { "filter": { - "description": "Allows filtering.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by `AND` or `OR` logical operators. A\nsequence of restrictions implicitly uses `AND`.\n* A restriction has the form of `{field} {operator} {value}`.\n* Supported fields/values for inspect jobs:\n - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED\n - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY\n - `trigger_name` - The resource name of the trigger that created job.\n - 'end_time` - Corresponds to time the job finished.\n - 'start_time` - Corresponds to time the job finished.\n* Supported fields for risk analysis jobs:\n - `state` - RUNNING|CANCELED|FINISHED|FAILED\n - 'end_time` - Corresponds to time the job finished.\n - 'start_time` - Corresponds to time the job finished.\n* The operator must be `=` or `!=`.\n\nExamples:\n\n* inspected_storage = cloud_storage AND state = done\n* inspected_storage = cloud_storage OR inspected_storage = bigquery\n* inspected_storage = cloud_storage AND (state = done OR state = canceled)\n* end_time > \\\"2017-12-12T00:00:00+00:00\\\"\n\nThe length of this field should be no more than 500 characters.", + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -2361,7 +2366,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case-insensitive,\ndefault sorting order is ascending, redundant space characters are\ninsignificant.\n\nExample: `name asc, end_time asc, create_time desc`\n\nSupported fields are:\n\n- `create_time`: corresponds to time the job was created.\n- `end_time`: corresponds to time the job ended.\n- `name`: corresponds to job's name.\n- `state`: corresponds to `state`", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state`", "location": "query", "type": "string" }, @@ -2377,7 +2382,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2390,6 +2395,11 @@ "INSPECT_JOB", "RISK_ANALYSIS_JOB" ], + "enumDescriptions": [ + "Unused", + "The job inspected Google Cloud for sensitive data.", + "The job executed a Risk Analysis computation." + ], "location": "query", "type": "string" } @@ -2407,7 +2417,7 @@ "image": { "methods": { "redact": { - "description": "Redacts potentially sensitive info from an image.\nThis method has limits on input size, processing time, and output size.\nSee https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to\nlearn more.\n\nWhen no InfoTypes or CustomInfoTypes are specified in this request, the\nsystem will automatically choose what detectors to run. By default this may\nbe all types, but may change over time as detectors are updated.", + "description": "Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/image:redact", "httpMethod": "POST", "id": "dlp.projects.locations.image.redact", @@ -2416,7 +2426,7 @@ ], "parameters": { "parent": { - "description": "The parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", + "description": "The parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2439,7 +2449,7 @@ "inspectTemplates": { "methods": { "create": { - "description": "Creates an InspectTemplate for re-using frequently used configuration\nfor inspecting content, images, and storage.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Creates an InspectTemplate for re-using frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates", "httpMethod": "POST", "id": "dlp.projects.locations.inspectTemplates.create", @@ -2448,7 +2458,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2467,7 +2477,7 @@ ] }, "delete": { - "description": "Deletes an InspectTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "DELETE", "id": "dlp.projects.locations.inspectTemplates.delete", @@ -2476,7 +2486,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.", + "description": "Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/inspectTemplates/[^/]+$", "required": true, @@ -2492,7 +2502,7 @@ ] }, "get": { - "description": "Gets an InspectTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "GET", "id": "dlp.projects.locations.inspectTemplates.get", @@ -2501,7 +2511,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.", + "description": "Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/inspectTemplates/[^/]+$", "required": true, @@ -2517,7 +2527,7 @@ ] }, "list": { - "description": "Lists InspectTemplates.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates", "httpMethod": "GET", "id": "dlp.projects.locations.inspectTemplates.list", @@ -2531,23 +2541,23 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case-insensitive,\ndefault sorting order is ascending, redundant space characters are\ninsignificant.\n\nExample: `name asc,update_time, create_time desc`\n\nSupported fields are:\n\n- `create_time`: corresponds to time the template was created.\n- `update_time`: corresponds to time the template was last updated.\n- `name`: corresponds to template's name.\n- `display_name`: corresponds to template's display name.", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name.", "location": "query", "type": "string" }, "pageSize": { - "description": "Size of the page, can be limited by server. If zero server returns\na page of max size 100.", + "description": "Size of the page, can be limited by server. If zero server returns a page of max size 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Page token to continue retrieval. Comes from previous call\nto `ListInspectTemplates`.", + "description": "Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2563,7 +2573,7 @@ ] }, "patch": { - "description": "Updates the InspectTemplate.\nSee https://cloud.google.com/dlp/docs/creating-templates to learn more.", + "description": "Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "PATCH", "id": "dlp.projects.locations.inspectTemplates.patch", @@ -2572,7 +2582,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/project-id/inspectTemplates/432452342.", + "description": "Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/inspectTemplates/[^/]+$", "required": true, @@ -2595,7 +2605,7 @@ "jobTriggers": { "methods": { "activate": { - "description": "Activate a job trigger. Causes the immediate execute of a trigger\ninstead of waiting on the trigger event to occur.", + "description": "Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:activate", "httpMethod": "POST", "id": "dlp.projects.locations.jobTriggers.activate", @@ -2604,7 +2614,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the trigger to activate, for example\n`projects/dlp-test-project/jobTriggers/53234423`.", + "description": "Required. Resource name of the trigger to activate, for example `projects/dlp-test-project/jobTriggers/53234423`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/jobTriggers/[^/]+$", "required": true, @@ -2623,7 +2633,7 @@ ] }, "create": { - "description": "Creates a job trigger to run DLP actions such as scanning storage for\nsensitive information on a set schedule.\nSee https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers", "httpMethod": "POST", "id": "dlp.projects.locations.jobTriggers.create", @@ -2632,7 +2642,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2651,7 +2661,7 @@ ] }, "delete": { - "description": "Deletes a job trigger.\nSee https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}", "httpMethod": "DELETE", "id": "dlp.projects.locations.jobTriggers.delete", @@ -2660,7 +2670,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the project and the triggeredJob, for example\n`projects/dlp-test-project/jobTriggers/53234423`.", + "description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/jobTriggers/[^/]+$", "required": true, @@ -2676,7 +2686,7 @@ ] }, "get": { - "description": "Gets a job trigger.\nSee https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}", "httpMethod": "GET", "id": "dlp.projects.locations.jobTriggers.get", @@ -2685,7 +2695,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the project and the triggeredJob, for example\n`projects/dlp-test-project/jobTriggers/53234423`.", + "description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/jobTriggers/[^/]+$", "required": true, @@ -2701,7 +2711,7 @@ ] }, "hybridInspect": { - "description": "Inspect hybrid content and store findings to a trigger. The inspection\nwill be processed asynchronously. To review the findings monitor the\njobs within the trigger.\nEarly access feature is in a pre-release state and might change or have\nlimited support. For more information, see\nhttps://cloud.google.com/products#product-launch-stages.", + "description": "Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:hybridInspect", "httpMethod": "POST", "id": "dlp.projects.locations.jobTriggers.hybridInspect", @@ -2710,7 +2720,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the trigger to execute a hybrid inspect on, for example\n`projects/dlp-test-project/jobTriggers/53234423`.", + "description": "Required. Resource name of the trigger to execute a hybrid inspect on, for example `projects/dlp-test-project/jobTriggers/53234423`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/jobTriggers/[^/]+$", "required": true, @@ -2729,7 +2739,7 @@ ] }, "list": { - "description": "Lists job triggers.\nSee https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers", "httpMethod": "GET", "id": "dlp.projects.locations.jobTriggers.list", @@ -2738,7 +2748,7 @@ ], "parameters": { "filter": { - "description": "Allows filtering.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by `AND` or `OR` logical operators. A\nsequence of restrictions implicitly uses `AND`.\n* A restriction has the form of `{field} {operator} {value}`.\n* Supported fields/values for inspect jobs:\n - `status` - HEALTHY|PAUSED|CANCELLED\n - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY\n - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by\n quotation marks. Nanoseconds are ignored.\n - 'error_count' - Number of errors that have occurred while running.\n* The operator must be `=` or `!=` for status and inspected_storage.\n\nExamples:\n\n* inspected_storage = cloud_storage AND status = HEALTHY\n* inspected_storage = cloud_storage OR inspected_storage = bigquery\n* inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY)\n* last_run_time > \\\"2017-12-12T00:00:00+00:00\\\"\n\nThe length of this field should be no more than 500 characters.", + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -2748,7 +2758,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of triggeredJob fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case-insensitive,\ndefault sorting order is ascending, redundant space characters are\ninsignificant.\n\nExample: `name asc,update_time, create_time desc`\n\nSupported fields are:\n\n- `create_time`: corresponds to time the JobTrigger was created.\n- `update_time`: corresponds to time the JobTrigger was last updated.\n- `last_run_time`: corresponds to the last time the JobTrigger ran.\n- `name`: corresponds to JobTrigger's name.\n- `display_name`: corresponds to JobTrigger's display name.\n- `status`: corresponds to JobTrigger's status.", + "description": "Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status.", "location": "query", "type": "string" }, @@ -2759,12 +2769,12 @@ "type": "integer" }, "pageToken": { - "description": "Page token to continue retrieval. Comes from previous call\nto ListJobTriggers. `order_by` field must not\nchange for subsequent calls.", + "description": "Page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2780,7 +2790,7 @@ ] }, "patch": { - "description": "Updates a job trigger.\nSee https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "description": "Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}", "httpMethod": "PATCH", "id": "dlp.projects.locations.jobTriggers.patch", @@ -2789,7 +2799,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the project and the triggeredJob, for example\n`projects/dlp-test-project/jobTriggers/53234423`.", + "description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/jobTriggers/[^/]+$", "required": true, @@ -2812,7 +2822,7 @@ "storedInfoTypes": { "methods": { "create": { - "description": "Creates a pre-built stored infoType to be used for inspection.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes", "httpMethod": "POST", "id": "dlp.projects.locations.storedInfoTypes.create", @@ -2821,7 +2831,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2840,7 +2850,7 @@ ] }, "delete": { - "description": "Deletes a stored infoType.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "DELETE", "id": "dlp.projects.locations.storedInfoTypes.delete", @@ -2849,7 +2859,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and storedInfoType to be deleted, for\nexample `organizations/433245324/storedInfoTypes/432452342` or\nprojects/project-id/storedInfoTypes/432452342.", + "description": "Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storedInfoTypes/[^/]+$", "required": true, @@ -2865,7 +2875,7 @@ ] }, "get": { - "description": "Gets a stored infoType.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "GET", "id": "dlp.projects.locations.storedInfoTypes.get", @@ -2874,7 +2884,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and storedInfoType to be read, for\nexample `organizations/433245324/storedInfoTypes/432452342` or\nprojects/project-id/storedInfoTypes/432452342.", + "description": "Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storedInfoTypes/[^/]+$", "required": true, @@ -2890,7 +2900,7 @@ ] }, "list": { - "description": "Lists stored infoTypes.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes", "httpMethod": "GET", "id": "dlp.projects.locations.storedInfoTypes.list", @@ -2904,23 +2914,23 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case-insensitive,\ndefault sorting order is ascending, redundant space characters are\ninsignificant.\n\nExample: `name asc, display_name, create_time desc`\n\nSupported fields are:\n\n- `create_time`: corresponds to time the most recent version of the\nresource was created.\n- `state`: corresponds to the state of the resource.\n- `name`: corresponds to resource name.\n- `display_name`: corresponds to info type's display name.", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", "location": "query", "type": "string" }, "pageSize": { - "description": "Size of the page, can be limited by server. If zero server returns\na page of max size 100.", + "description": "Size of the page, can be limited by server. If zero server returns a page of max size 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Page token to continue retrieval. Comes from previous call\nto `ListStoredInfoTypes`.", + "description": "Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2936,7 +2946,7 @@ ] }, "patch": { - "description": "Updates the stored infoType by creating a new version. The existing version\nwill continue to be used until the new version is ready.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "PATCH", "id": "dlp.projects.locations.storedInfoTypes.patch", @@ -2945,7 +2955,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of organization and storedInfoType to be updated, for\nexample `organizations/433245324/storedInfoTypes/432452342` or\nprojects/project-id/storedInfoTypes/432452342.", + "description": "Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storedInfoTypes/[^/]+$", "required": true, @@ -2970,7 +2980,7 @@ "storedInfoTypes": { "methods": { "create": { - "description": "Creates a pre-built stored infoType to be used for inspection.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/storedInfoTypes", "httpMethod": "POST", "id": "dlp.projects.storedInfoTypes.create", @@ -2979,7 +2989,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2998,7 +3008,7 @@ ] }, "delete": { - "description": "Deletes a stored infoType.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "DELETE", "id": "dlp.projects.storedInfoTypes.delete", @@ -3007,7 +3017,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and storedInfoType to be deleted, for\nexample `organizations/433245324/storedInfoTypes/432452342` or\nprojects/project-id/storedInfoTypes/432452342.", + "description": "Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.", "location": "path", "pattern": "^projects/[^/]+/storedInfoTypes/[^/]+$", "required": true, @@ -3023,7 +3033,7 @@ ] }, "get": { - "description": "Gets a stored infoType.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "GET", "id": "dlp.projects.storedInfoTypes.get", @@ -3032,7 +3042,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the organization and storedInfoType to be read, for\nexample `organizations/433245324/storedInfoTypes/432452342` or\nprojects/project-id/storedInfoTypes/432452342.", + "description": "Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.", "location": "path", "pattern": "^projects/[^/]+/storedInfoTypes/[^/]+$", "required": true, @@ -3048,7 +3058,7 @@ ] }, "list": { - "description": "Lists stored infoTypes.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/storedInfoTypes", "httpMethod": "GET", "id": "dlp.projects.storedInfoTypes.list", @@ -3062,23 +3072,23 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case-insensitive,\ndefault sorting order is ascending, redundant space characters are\ninsignificant.\n\nExample: `name asc, display_name, create_time desc`\n\nSupported fields are:\n\n- `create_time`: corresponds to time the most recent version of the\nresource was created.\n- `state`: corresponds to the state of the resource.\n- `name`: corresponds to resource name.\n- `display_name`: corresponds to info type's display name.", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", "location": "query", "type": "string" }, "pageSize": { - "description": "Size of the page, can be limited by server. If zero server returns\na page of max size 100.", + "description": "Size of the page, can be limited by server. If zero server returns a page of max size 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Page token to continue retrieval. Comes from previous call\nto `ListStoredInfoTypes`.", + "description": "Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent resource name.\n- Format:projects/[PROJECT-ID]\n- Format:organizations/[ORGANIZATION-ID]\n- Format:projects/[PROJECT-ID]/locations/[LOCATION-ID]\n- Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", + "description": "Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID]", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -3094,7 +3104,7 @@ ] }, "patch": { - "description": "Updates the stored infoType by creating a new version. The existing version\nwill continue to be used until the new version is ready.\nSee https://cloud.google.com/dlp/docs/creating-stored-infotypes to\nlearn more.", + "description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "PATCH", "id": "dlp.projects.storedInfoTypes.patch", @@ -3103,7 +3113,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of organization and storedInfoType to be updated, for\nexample `organizations/433245324/storedInfoTypes/432452342` or\nprojects/project-id/storedInfoTypes/432452342.", + "description": "Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.", "location": "path", "pattern": "^projects/[^/]+/storedInfoTypes/[^/]+$", "required": true, @@ -3126,16 +3136,16 @@ } } }, - "revision": "20200726", + "revision": "20200805", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { - "description": "A task to execute on the completion of a job.\nSee https://cloud.google.com/dlp/docs/concepts-actions to learn more.", + "description": "A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more.", "id": "GooglePrivacyDlpV2Action", "properties": { "jobNotificationEmails": { "$ref": "GooglePrivacyDlpV2JobNotificationEmails", - "description": "Enable email notification for project owners and editors on job's\ncompletion/failure." + "description": "Enable email notification for project owners and editors on job's completion/failure." }, "pubSub": { "$ref": "GooglePrivacyDlpV2PublishToPubSub", @@ -3206,7 +3216,7 @@ "type": "object" }, "GooglePrivacyDlpV2AuxiliaryTable": { - "description": "An auxiliary table contains statistical information on the relative\nfrequency of different quasi-identifiers values. It has one or several\nquasi-identifiers columns, and one column that indicates the relative\nfrequency of each quasi-identifier tuple.\nIf a tuple is present in the data but not in the auxiliary table, the\ncorresponding relative frequency is assumed to be zero (and thus, the\ntuple is highly reidentifiable).", + "description": "An auxiliary table contains statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple. If a tuple is present in the data but not in the auxiliary table, the corresponding relative frequency is assumed to be zero (and thus, the tuple is highly reidentifiable).", "id": "GooglePrivacyDlpV2AuxiliaryTable", "properties": { "quasiIds": { @@ -3218,7 +3228,7 @@ }, "relativeFrequency": { "$ref": "GooglePrivacyDlpV2FieldId", - "description": "Required. The relative frequency column must contain a floating-point number\nbetween 0 and 1 (inclusive). Null values are assumed to be zero." + "description": "Required. The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero." }, "table": { "$ref": "GooglePrivacyDlpV2BigQueryTable", @@ -3247,7 +3257,7 @@ "id": "GooglePrivacyDlpV2BigQueryKey", "properties": { "rowNumber": { - "description": "Row number inferred at the time the table was scanned. This value is\nnondeterministic, cannot be queried, and may be null for inspection\njobs. To locate findings within a table, specify\n`inspect_job.storage_config.big_query_options.identifying_fields` in\n`CreateDlpJobRequest`.", + "description": "Row number inferred at the time the table was scanned. This value is nondeterministic, cannot be queried, and may be null for inspection jobs. To locate findings within a table, specify `inspect_job.storage_config.big_query_options.identifying_fields` in `CreateDlpJobRequest`.", "format": "int64", "type": "string" }, @@ -3263,26 +3273,26 @@ "id": "GooglePrivacyDlpV2BigQueryOptions", "properties": { "excludedFields": { - "description": "References to fields excluded from scanning. This allows you to skip\ninspection of entire columns which you know have no findings.", + "description": "References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings.", "items": { "$ref": "GooglePrivacyDlpV2FieldId" }, "type": "array" }, "identifyingFields": { - "description": "Table fields that may uniquely identify a row within the table. When\n`actions.saveFindings.outputConfig.table` is specified, the values of\ncolumns specified here are available in the output table under\n`location.content_locations.record_location.record_key.id_values`. Nested\nfields such as `person.birthdate.year` are allowed.", + "description": "Table fields that may uniquely identify a row within the table. When `actions.saveFindings.outputConfig.table` is specified, the values of columns specified here are available in the output table under `location.content_locations.record_location.record_key.id_values`. Nested fields such as `person.birthdate.year` are allowed.", "items": { "$ref": "GooglePrivacyDlpV2FieldId" }, "type": "array" }, "rowsLimit": { - "description": "Max number of rows to scan. If the table has more rows than this value, the\nrest of the rows are omitted. If not set, or if set to 0, all rows will be\nscanned. Only one of rows_limit and rows_limit_percent can be specified.\nCannot be used in conjunction with TimespanConfig.", + "description": "Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.", "format": "int64", "type": "string" }, "rowsLimitPercent": { - "description": "Max percentage of rows to scan. The rest are omitted. The number of rows\nscanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and\n100 means no limit. Defaults to 0. Only one of rows_limit and\nrows_limit_percent can be specified. Cannot be used in conjunction with\nTimespanConfig.", + "description": "Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.", "format": "int32", "type": "integer" }, @@ -3307,7 +3317,7 @@ "type": "object" }, "GooglePrivacyDlpV2BigQueryTable": { - "description": "Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`:.` or\n`..`.", + "description": "Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`.", "id": "GooglePrivacyDlpV2BigQueryTable", "properties": { "datasetId": { @@ -3315,7 +3325,7 @@ "type": "string" }, "projectId": { - "description": "The Google Cloud Platform project ID of the project containing the table.\nIf omitted, project ID is inferred from the API call.", + "description": "The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.", "type": "string" }, "tableId": { @@ -3362,7 +3372,7 @@ }, "min": { "$ref": "GooglePrivacyDlpV2Value", - "description": "Lower bound of the range, inclusive. Type should be the same as max if\nused." + "description": "Lower bound of the range, inclusive. Type should be the same as max if used." }, "replacementValue": { "$ref": "GooglePrivacyDlpV2Value", @@ -3372,7 +3382,7 @@ "type": "object" }, "GooglePrivacyDlpV2BucketingConfig": { - "description": "Generalization function that buckets values based on ranges. The ranges and\nreplacement values are dynamically provided by the user for custom behavior,\nsuch as 1-30 -> LOW 31-65 -> MEDIUM 66-100 -> HIGH\nThis can be used on\ndata of type: number, long, string, timestamp.\nIf the bound `Value` type differs from the type of data being transformed, we\nwill first attempt converting the type of the data to be transformed to match\nthe type of the bound before comparing.\nSee https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.", + "description": "Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW 31-65 -> MEDIUM 66-100 -> HIGH This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.", "id": "GooglePrivacyDlpV2BucketingConfig", "properties": { "buckets": { @@ -3436,12 +3446,12 @@ "type": "object" }, "GooglePrivacyDlpV2CategoricalStatsConfig": { - "description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.", + "description": "Compute numerical stats over an individual column, including number of distinct values and value count distribution.", "id": "GooglePrivacyDlpV2CategoricalStatsConfig", "properties": { "field": { "$ref": "GooglePrivacyDlpV2FieldId", - "description": "Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data." + "description": "Field to compute categorical stats on. All column types are supported except for arrays and structs. However, it may be more informative to use NumericalStats when the field type is supported, depending on the data." } }, "type": "object" @@ -3461,7 +3471,7 @@ "type": "string" }, "bucketValues": { - "description": "Sample of value frequencies in this bucket. The total number of\nvalues returned per bucket is capped at 20.", + "description": "Sample of value frequencies in this bucket. The total number of values returned per bucket is capped at 20.", "items": { "$ref": "GooglePrivacyDlpV2ValueFrequency" }, @@ -3495,34 +3505,34 @@ "type": "object" }, "GooglePrivacyDlpV2CharacterMaskConfig": { - "description": "Partially mask a string by replacing a given number of characters with a\nfixed character. Masking can start from the beginning or end of the string.\nThis can be used on data of any type (numbers, longs, and so on) and when\nde-identifying structured data we'll attempt to preserve the original data's\ntype. (This allows you to take a long like 123 and modify it to a string like\n**3.", + "description": "Partially mask a string by replacing a given number of characters with a fixed character. Masking can start from the beginning or end of the string. This can be used on data of any type (numbers, longs, and so on) and when de-identifying structured data we'll attempt to preserve the original data's type. (This allows you to take a long like 123 and modify it to a string like **3.", "id": "GooglePrivacyDlpV2CharacterMaskConfig", "properties": { "charactersToIgnore": { - "description": "When masking a string, items in this list will be skipped when replacing\ncharacters. For example, if the input string is `555-555-5555` and you\ninstruct Cloud DLP to skip `-` and mask 5 characters with `*`, Cloud DLP\nreturns `***-**5-5555`.", + "description": "When masking a string, items in this list will be skipped when replacing characters. For example, if the input string is `555-555-5555` and you instruct Cloud DLP to skip `-` and mask 5 characters with `*`, Cloud DLP returns `***-**5-5555`.", "items": { "$ref": "GooglePrivacyDlpV2CharsToIgnore" }, "type": "array" }, "maskingCharacter": { - "description": "Character to use to mask the sensitive values—for example, `*` for an\nalphabetic string such as a name, or `0` for a numeric string such as ZIP\ncode or credit card number. This string must have a length of 1. If not\nsupplied, this value defaults to `*` for strings, and `0` for digits.", + "description": "Character to use to mask the sensitive values—for example, `*` for an alphabetic string such as a name, or `0` for a numeric string such as ZIP code or credit card number. This string must have a length of 1. If not supplied, this value defaults to `*` for strings, and `0` for digits.", "type": "string" }, "numberToMask": { - "description": "Number of characters to mask. If not set, all matching chars will be\nmasked. Skipped characters do not count towards this tally.", + "description": "Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally.", "format": "int32", "type": "integer" }, "reverseOrder": { - "description": "Mask characters in reverse order. For example, if `masking_character` is\n`0`, `number_to_mask` is `14`, and `reverse_order` is `false`, then the\ninput string `1234-5678-9012-3456` is masked as `00000000000000-3456`.\nIf `masking_character` is `*`, `number_to_mask` is `3`, and `reverse_order`\nis `true`, then the string `12345` is masked as `12***`.", + "description": "Mask characters in reverse order. For example, if `masking_character` is `0`, `number_to_mask` is `14`, and `reverse_order` is `false`, then the input string `1234-5678-9012-3456` is masked as `00000000000000-3456`. If `masking_character` is `*`, `number_to_mask` is `3`, and `reverse_order` is `true`, then the string `12345` is masked as `12***`.", "type": "boolean" } }, "type": "object" }, "GooglePrivacyDlpV2CharsToIgnore": { - "description": "Characters to skip when doing deidentification of a value. These will be left\nalone and skipped.", + "description": "Characters to skip when doing deidentification of a value. These will be left alone and skipped.", "id": "GooglePrivacyDlpV2CharsToIgnore", "properties": { "charactersToSkip": { @@ -3530,7 +3540,7 @@ "type": "string" }, "commonCharactersToIgnore": { - "description": "Common characters to not transform when masking. Useful to avoid removing\npunctuation.", + "description": "Common characters to not transform when masking. Useful to avoid removing punctuation.", "enum": [ "COMMON_CHARS_TO_IGNORE_UNSPECIFIED", "NUMERIC", @@ -3557,23 +3567,23 @@ "id": "GooglePrivacyDlpV2CloudStorageFileSet", "properties": { "url": { - "description": "The url, in the format `gs:///`. Trailing wildcard in the\npath is allowed.", + "description": "The url, in the format `gs:///`. Trailing wildcard in the path is allowed.", "type": "string" } }, "type": "object" }, "GooglePrivacyDlpV2CloudStorageOptions": { - "description": "Options defining a file or a set of files within a Google Cloud Storage\nbucket.", + "description": "Options defining a file or a set of files within a Google Cloud Storage bucket.", "id": "GooglePrivacyDlpV2CloudStorageOptions", "properties": { "bytesLimitPerFile": { - "description": "Max number of bytes to scan from a file. If a scanned file's size is bigger\nthan this value then the rest of the bytes are omitted. Only one\nof bytes_limit_per_file and bytes_limit_per_file_percent can be specified.", + "description": "Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.", "format": "int64", "type": "string" }, "bytesLimitPerFilePercent": { - "description": "Max percentage of bytes to scan from a file. The rest are omitted. The\nnumber of bytes scanned is rounded down. Must be between 0 and 100,\ninclusively. Both 0 and 100 means no limit. Defaults to 0. Only one\nof bytes_limit_per_file and bytes_limit_per_file_percent can be specified.", + "description": "Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.", "format": "int32", "type": "integer" }, @@ -3582,17 +3592,17 @@ "description": "The set of one or more files to scan." }, "fileTypes": { - "description": "List of file type groups to include in the scan.\nIf empty, all files are scanned and available data format processors\nare applied. In addition, the binary content of the selected files\nis always scanned as well.\nImages are scanned only as binary if the specified region\ndoes not support image inspection and no file_types were specified.\nImage inspection is restricted to 'global', 'us', 'asia', and 'europe'.", + "description": "List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no file_types were specified. Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.", "enumDescriptions": [ "Includes all files.", - "Includes all file extensions not covered by another entry. Binary\nscanning attempts to convert the content of the file to utf_8 to scan\nthe file.\nIf you wish to avoid this fall back, specify one or more of the other\nFileType's in your storage scan.", - "Included file extensions:\n asc, brf, c, cc, cpp, csv, cxx, c++, cs, css, dart, eml, go, h, hh, hpp,\n hxx, h++, hs, html, htm, shtml, shtm, xhtml, lhs, ini, java, js, json,\n ocaml, md, mkd, markdown, m, ml, mli, pl, pm, php, phtml, pht, py, pyw,\n rb, rbw, rs, rc, scala, sh, sql, tex, txt, text, tsv, vcard, vcs, wml,\n xml, xsl, xsd, yml, yaml.", - "Included file extensions:\n bmp, gif, jpg, jpeg, jpe, png.\nbytes_limit_per_file has no effect on image files.\nImage inspection is restricted to 'global', 'us', 'asia', and 'europe'.", - "Word files >30 MB will be scanned as binary files.\nIncluded file extensions:\n docx, dotx, docm, dotm", - "PDF files >30 MB will be scanned as binary files.\nIncluded file extensions:\n pdf", - "Included file extensions:\n avro", - "Included file extensions:\n csv", - "Included file extensions:\n tsv" + "Includes all file extensions not covered by another entry. Binary scanning attempts to convert the content of the file to utf_8 to scan the file. If you wish to avoid this fall back, specify one or more of the other FileType's in your storage scan.", + "Included file extensions: asc, brf, c, cc, cpp, csv, cxx, c++, cs, css, dart, eml, go, h, hh, hpp, hxx, h++, hs, html, htm, shtml, shtm, xhtml, lhs, ini, java, js, json, ocaml, md, mkd, markdown, m, ml, mli, pl, pm, php, phtml, pht, py, pyw, rb, rbw, rs, rc, scala, sh, sql, tex, txt, text, tsv, vcard, vcs, wml, xml, xsl, xsd, yml, yaml.", + "Included file extensions: bmp, gif, jpg, jpeg, jpe, png. bytes_limit_per_file has no effect on image files. Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.", + "Word files >30 MB will be scanned as binary files. Included file extensions: docx, dotx, docm, dotm", + "PDF files >30 MB will be scanned as binary files. Included file extensions: pdf", + "Included file extensions: avro", + "Included file extensions: csv", + "Included file extensions: tsv" ], "items": { "enum": [ @@ -3606,12 +3616,23 @@ "CSV", "TSV" ], + "enumDescriptions": [ + "Includes all files.", + "Includes all file extensions not covered by another entry. Binary scanning attempts to convert the content of the file to utf_8 to scan the file. If you wish to avoid this fall back, specify one or more of the other FileType's in your storage scan.", + "Included file extensions: asc, brf, c, cc, cpp, csv, cxx, c++, cs, css, dart, eml, go, h, hh, hpp, hxx, h++, hs, html, htm, shtml, shtm, xhtml, lhs, ini, java, js, json, ocaml, md, mkd, markdown, m, ml, mli, pl, pm, php, phtml, pht, py, pyw, rb, rbw, rs, rc, scala, sh, sql, tex, txt, text, tsv, vcard, vcs, wml, xml, xsl, xsd, yml, yaml.", + "Included file extensions: bmp, gif, jpg, jpeg, jpe, png. bytes_limit_per_file has no effect on image files. Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.", + "Word files >30 MB will be scanned as binary files. Included file extensions: docx, dotx, docm, dotm", + "PDF files >30 MB will be scanned as binary files. Included file extensions: pdf", + "Included file extensions: avro", + "Included file extensions: csv", + "Included file extensions: tsv" + ], "type": "string" }, "type": "array" }, "filesLimitPercent": { - "description": "Limits the number of files to scan to this percentage of the input FileSet.\nNumber of files scanned is rounded down. Must be between 0 and 100,\ninclusively. Both 0 and 100 means no limit. Defaults to 0.", + "description": "Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0.", "format": "int32", "type": "integer" }, @@ -3624,7 +3645,7 @@ "enumDescriptions": [ "", "Scan from the top (default).", - "For each file larger than bytes_limit_per_file, randomly pick the offset\nto start scanning. The scanned bytes are contiguous." + "For each file larger than bytes_limit_per_file, randomly pick the offset to start scanning. The scanned bytes are contiguous." ], "type": "string" } @@ -3636,14 +3657,14 @@ "id": "GooglePrivacyDlpV2CloudStoragePath", "properties": { "path": { - "description": "A url representing a file or path (no wildcards) in Cloud Storage.\nExample: gs://[BUCKET_NAME]/dictionary.txt", + "description": "A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt", "type": "string" } }, "type": "object" }, "GooglePrivacyDlpV2CloudStorageRegexFileSet": { - "description": "Message representing a set of files in a Cloud Storage bucket. Regular\nexpressions are used to allow fine-grained control over which files in the\nbucket to include.\n\nIncluded files are those that match at least one item in `include_regex` and\ndo not match any items in `exclude_regex`. Note that a file that matches\nitems from both lists will _not_ be included. For a match to occur, the\nentire file path (i.e., everything in the url after the bucket name) must\nmatch the regular expression.\n\nFor example, given the input `{bucket_name: \"mybucket\", include_regex:\n[\"directory1/.*\"], exclude_regex:\n[\"directory1/excluded.*\"]}`:\n\n* `gs://mybucket/directory1/myfile` will be included\n* `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches\nacross `/`)\n* `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the\nfull path doesn't match any items in `include_regex`)\n* `gs://mybucket/directory1/excludedfile` will _not_ be included (the path\nmatches an item in `exclude_regex`)\n\nIf `include_regex` is left empty, it will match all files by default\n(this is equivalent to setting `include_regex: [\".*\"]`).\n\nSome other common use cases:\n\n* `{bucket_name: \"mybucket\", exclude_regex: [\".*\\.pdf\"]}` will include all\nfiles in `mybucket` except for .pdf files\n* `{bucket_name: \"mybucket\", include_regex: [\"directory/[^/]+\"]}` will\ninclude all files directly under `gs://mybucket/directory/`, without matching\nacross `/`", + "description": "Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: \"mybucket\", include_regex: [\"directory1/.*\"], exclude_regex: [\"directory1/excluded.*\"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [\".*\"]`). Some other common use cases: * `{bucket_name: \"mybucket\", exclude_regex: [\".*\\.pdf\"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: \"mybucket\", include_regex: [\"directory/[^/]+\"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/`", "id": "GooglePrivacyDlpV2CloudStorageRegexFileSet", "properties": { "bucketName": { @@ -3651,14 +3672,14 @@ "type": "string" }, "excludeRegex": { - "description": "A list of regular expressions matching file paths to exclude. All files in\nthe bucket that match at least one of these regular expressions will be\nexcluded from the scan.\n\nRegular expressions use RE2\n[syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found\nunder the google/re2 repository on GitHub.", + "description": "A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.", "items": { "type": "string" }, "type": "array" }, "includeRegex": { - "description": "A list of regular expressions matching file paths to include. All files in\nthe bucket that match at least one of these regular expressions will be\nincluded in the set of files, except for those that also match an item in\n`exclude_regex`. Leaving this field empty will match all files by default\n(this is equivalent to including `.*` in the list).\n\nRegular expressions use RE2\n[syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found\nunder the google/re2 repository on GitHub.", + "description": "A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in `exclude_regex`. Leaving this field empty will match all files by default (this is equivalent to including `.*` in the list). Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.", "items": { "type": "string" }, @@ -3690,7 +3711,7 @@ "type": "object" }, "GooglePrivacyDlpV2Condition": { - "description": "The field type of `value` and `field` do not need to match to be\nconsidered equal, but not all comparisons are possible.\nEQUAL_TO and NOT_EQUAL_TO attempt to compare even with incompatible types,\nbut all other comparisons are invalid with incompatible types.\nA `value` of type:\n\n- `string` can be compared against all other types\n- `boolean` can only be compared against other booleans\n- `integer` can be compared against doubles or a string if the string value\ncan be parsed as an integer.\n- `double` can be compared against integers or a string if the string can\nbe parsed as a double.\n- `Timestamp` can be compared against strings in RFC 3339 date string\nformat.\n- `TimeOfDay` can be compared against timestamps and strings in the format\nof 'HH:mm:ss'.\n\nIf we fail to compare do to type mismatch, a warning will be given and\nthe condition will evaluate to false.", + "description": "The field type of `value` and `field` do not need to match to be considered equal, but not all comparisons are possible. EQUAL_TO and NOT_EQUAL_TO attempt to compare even with incompatible types, but all other comparisons are invalid with incompatible types. A `value` of type: - `string` can be compared against all other types - `boolean` can only be compared against other booleans - `integer` can be compared against doubles or a string if the string value can be parsed as an integer. - `double` can be compared against integers or a string if the string can be parsed as a double. - `Timestamp` can be compared against strings in RFC 3339 date string format. - `TimeOfDay` can be compared against timestamps and strings in the format of 'HH:mm:ss'. If we fail to compare do to type mismatch, a warning will be given and the condition will evaluate to false.", "id": "GooglePrivacyDlpV2Condition", "properties": { "field": { @@ -3743,23 +3764,23 @@ "type": "object" }, "GooglePrivacyDlpV2Container": { - "description": "Represents a container that may contain DLP findings.\nExamples of a container include a file, table, or database record.", + "description": "Represents a container that may contain DLP findings. Examples of a container include a file, table, or database record.", "id": "GooglePrivacyDlpV2Container", "properties": { "fullPath": { - "description": "A string representation of the full container name.\nExamples:\n- BigQuery: 'Project:DataSetId.TableId'\n- Google Cloud Storage: 'gs://Bucket/folders/filename.txt'", + "description": "A string representation of the full container name. Examples: - BigQuery: 'Project:DataSetId.TableId' - Google Cloud Storage: 'gs://Bucket/folders/filename.txt'", "type": "string" }, "projectId": { - "description": "Project where the finding was found.\nCan be different from the project that owns the finding.", + "description": "Project where the finding was found. Can be different from the project that owns the finding.", "type": "string" }, "relativePath": { - "description": "The rest of the path after the root.\nExamples:\n- For BigQuery table `project_id:dataset_id.table_id`, the relative path is\n `table_id`\n- Google Cloud Storage file `gs://bucket/folder/filename.txt`, the relative\n path is `folder/filename.txt`", + "description": "The rest of the path after the root. Examples: - For BigQuery table `project_id:dataset_id.table_id`, the relative path is `table_id` - Google Cloud Storage file `gs://bucket/folder/filename.txt`, the relative path is `folder/filename.txt`", "type": "string" }, "rootPath": { - "description": "The root of the container.\nExamples:\n- For BigQuery table `project_id:dataset_id.table_id`, the root is\n `dataset_id`\n- For Google Cloud Storage file `gs://bucket/folder/filename.txt`, the root\n is `gs://bucket`", + "description": "The root of the container. Examples: - For BigQuery table `project_id:dataset_id.table_id`, the root is `dataset_id` - For Google Cloud Storage file `gs://bucket/folder/filename.txt`, the root is `gs://bucket`", "type": "string" }, "type": { @@ -3767,12 +3788,12 @@ "type": "string" }, "updateTime": { - "description": "Findings container modification timestamp, if applicable.\nFor Google Cloud Storage contains last file modification timestamp.\nFor BigQuery table contains last_modified_time property.\nFor Datastore - not populated.", + "description": "Findings container modification timestamp, if applicable. For Google Cloud Storage contains last file modification timestamp. For BigQuery table contains last_modified_time property. For Datastore - not populated.", "format": "google-datetime", "type": "string" }, "version": { - "description": "Findings container version, if available\n(\"generation\" for Google Cloud Storage).", + "description": "Findings container version, if available (\"generation\" for Google Cloud Storage).", "type": "string" } }, @@ -3788,7 +3809,7 @@ }, "table": { "$ref": "GooglePrivacyDlpV2Table", - "description": "Structured content for inspection. See\nhttps://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to\nlearn more." + "description": "Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more." }, "value": { "description": "String data to inspect or redact.", @@ -3798,20 +3819,20 @@ "type": "object" }, "GooglePrivacyDlpV2ContentLocation": { - "description": "Precise location of the finding within a document, record, image, or metadata\ncontainer.", + "description": "Precise location of the finding within a document, record, image, or metadata container.", "id": "GooglePrivacyDlpV2ContentLocation", "properties": { "containerName": { - "description": "Name of the container where the finding is located.\nThe top level name is the source file name or table name. Names of some\ncommon storage containers are formatted as follows:\n\n* BigQuery tables: `{project_id}:{dataset_id}.{table_id}`\n* Cloud Storage files: `gs://{bucket}/{path}`\n* Datastore namespace: {namespace}\n\nNested names could be absent if the embedded object has no string\nidentifier (for an example an image contained within a document).", + "description": "Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for an example an image contained within a document).", "type": "string" }, "containerTimestamp": { - "description": "Findings container modification timestamp, if applicable.\nFor Google Cloud Storage contains last file modification timestamp.\nFor BigQuery table contains last_modified_time property.\nFor Datastore - not populated.", + "description": "Findings container modification timestamp, if applicable. For Google Cloud Storage contains last file modification timestamp. For BigQuery table contains last_modified_time property. For Datastore - not populated.", "format": "google-datetime", "type": "string" }, "containerVersion": { - "description": "Findings container version, if available\n(\"generation\" for Google Cloud Storage).", + "description": "Findings container version, if available (\"generation\" for Google Cloud Storage).", "type": "string" }, "documentLocation": { @@ -3846,14 +3867,14 @@ "type": "string" }, "templateId": { - "description": "The template id can contain uppercase and lowercase letters,\nnumbers, and hyphens; that is, it must match the regular\nexpression: `[a-zA-Z\\\\d-_]+`. The maximum length is 100\ncharacters. Can be empty to allow the system to generate one.", + "description": "The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.", "type": "string" } }, "type": "object" }, "GooglePrivacyDlpV2CreateDlpJobRequest": { - "description": "Request message for CreateDlpJobRequest. Used to initiate long running\njobs such as calculating risk metrics or inspecting Google Cloud\nStorage.", + "description": "Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage.", "id": "GooglePrivacyDlpV2CreateDlpJobRequest", "properties": { "inspectJob": { @@ -3861,7 +3882,7 @@ "description": "Set to control what and how to inspect." }, "jobId": { - "description": "The job id can contain uppercase and lowercase letters,\nnumbers, and hyphens; that is, it must match the regular\nexpression: `[a-zA-Z\\\\d-_]+`. The maximum length is 100\ncharacters. Can be empty to allow the system to generate one.", + "description": "The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.", "type": "string" }, "locationId": { @@ -3888,7 +3909,7 @@ "type": "string" }, "templateId": { - "description": "The template id can contain uppercase and lowercase letters,\nnumbers, and hyphens; that is, it must match the regular\nexpression: `[a-zA-Z\\\\d-_]+`. The maximum length is 100\ncharacters. Can be empty to allow the system to generate one.", + "description": "The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.", "type": "string" } }, @@ -3907,7 +3928,7 @@ "type": "string" }, "triggerId": { - "description": "The trigger id can contain uppercase and lowercase letters,\nnumbers, and hyphens; that is, it must match the regular\nexpression: `[a-zA-Z\\\\d-_]+`. The maximum length is 100\ncharacters. Can be empty to allow the system to generate one.", + "description": "The trigger id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.", "type": "string" } }, @@ -3926,19 +3947,19 @@ "type": "string" }, "storedInfoTypeId": { - "description": "The storedInfoType ID can contain uppercase and lowercase letters,\nnumbers, and hyphens; that is, it must match the regular\nexpression: `[a-zA-Z\\\\d-_]+`. The maximum length is 100\ncharacters. Can be empty to allow the system to generate one.", + "description": "The storedInfoType ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.", "type": "string" } }, "type": "object" }, "GooglePrivacyDlpV2CryptoDeterministicConfig": { - "description": "Pseudonymization method that generates deterministic encryption for the given\ninput. Outputs a base64 encoded representation of the encrypted output.\nUses AES-SIV based on the RFC https://tools.ietf.org/html/rfc5297.", + "description": "Pseudonymization method that generates deterministic encryption for the given input. Outputs a base64 encoded representation of the encrypted output. Uses AES-SIV based on the RFC https://tools.ietf.org/html/rfc5297.", "id": "GooglePrivacyDlpV2CryptoDeterministicConfig", "properties": { "context": { "$ref": "GooglePrivacyDlpV2FieldId", - "description": "A context may be used for higher security and maintaining\nreferential integrity such that the same identifier in two different\ncontexts will be given a distinct surrogate. The context is appended to\nplaintext value being encrypted. On decryption the provided context is\nvalidated against the value used during encryption. If a context was\nprovided during encryption, same context must be provided during decryption\nas well.\n\nIf the context is not set, plaintext would be used as is for encryption.\nIf the context is set but:\n\n1. there is no record present when transforming a given value or\n2. the field is not present when transforming a given value,\n\nplaintext would be used as is for encryption.\n\nNote that case (1) is expected when an `InfoTypeTransformation` is\napplied to both structured and non-structured `ContentItem`s." + "description": "A context may be used for higher security and maintaining referential integrity such that the same identifier in two different contexts will be given a distinct surrogate. The context is appended to plaintext value being encrypted. On decryption the provided context is validated against the value used during encryption. If a context was provided during encryption, same context must be provided during decryption as well. If the context is not set, plaintext would be used as is for encryption. If the context is set but: 1. there is no record present when transforming a given value or 2. the field is not present when transforming a given value, plaintext would be used as is for encryption. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and non-structured `ContentItem`s." }, "cryptoKey": { "$ref": "GooglePrivacyDlpV2CryptoKey", @@ -3946,13 +3967,13 @@ }, "surrogateInfoType": { "$ref": "GooglePrivacyDlpV2InfoType", - "description": "The custom info type to annotate the surrogate with.\nThis annotation will be applied to the surrogate by prefixing it with\nthe name of the custom info type followed by the number of\ncharacters comprising the surrogate. The following scheme defines the\nformat: {info type name}({surrogate character count}):{surrogate}\n\nFor example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and\nthe surrogate is 'abc', the full replacement value\nwill be: 'MY_TOKEN_INFO_TYPE(3):abc'\n\nThis annotation identifies the surrogate when inspecting content using the\ncustom info type 'Surrogate'. This facilitates reversal of the\nsurrogate when it occurs in free text.\n\nNote: For record transformations where the entire cell in a table is being\ntransformed, surrogates are not mandatory. Surrogates are used to denote\nthe location of the token and are necessary for re-identification in free\nform text.\n\nIn order for inspection to work properly, the name of this info type must\nnot occur naturally anywhere in your data; otherwise, inspection may either\n\n- reverse a surrogate that does not correspond to an actual identifier\n- be unable to parse the surrogate and result in an error\n\nTherefore, choose your custom info type name carefully after considering\nwhat your data looks like. One way to select a name that has a high chance\nof yielding reliable detection is to include one or more unicode characters\nthat are highly improbable to exist in your data.\nFor example, assuming your data is entered from a regular ASCII keyboard,\nthe symbol with the hex code point 29DD might be used like so:\n⧝MY_TOKEN_TYPE." + "description": "The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE." } }, "type": "object" }, "GooglePrivacyDlpV2CryptoHashConfig": { - "description": "Pseudonymization method that generates surrogates via cryptographic hashing.\nUses SHA-256.\nThe key size must be either 32 or 64 bytes.\nOutputs a base64 encoded representation of the hashed output\n(for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=).\nCurrently, only string and integer values can be hashed.\nSee https://cloud.google.com/dlp/docs/pseudonymization to learn more.", + "description": "Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/dlp/docs/pseudonymization to learn more.", "id": "GooglePrivacyDlpV2CryptoHashConfig", "properties": { "cryptoKey": { @@ -3963,7 +3984,7 @@ "type": "object" }, "GooglePrivacyDlpV2CryptoKey": { - "description": "This is a data encryption key (DEK) (as opposed to\na key encryption key (KEK) stored by KMS).\nWhen using KMS to wrap/unwrap DEKs, be sure to set an appropriate\nIAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot\nunwrap the data crypto key.", + "description": "This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by KMS). When using KMS to wrap/unwrap DEKs, be sure to set an appropriate IAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot unwrap the data crypto key.", "id": "GooglePrivacyDlpV2CryptoKey", "properties": { "kmsWrapped": { @@ -3982,7 +4003,7 @@ "type": "object" }, "GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig": { - "description": "Replaces an identifier with a surrogate using Format Preserving Encryption\n(FPE) with the FFX mode of operation; however when used in the\n`ReidentifyContent` API method, it serves the opposite function by reversing\nthe surrogate back into the original identifier. The identifier must be\nencoded as ASCII. For a given crypto key and context, the same identifier\nwill be replaced with the same surrogate. Identifiers must be at least two\ncharacters long. In the case that the identifier is the empty string, it will\nbe skipped. See https://cloud.google.com/dlp/docs/pseudonymization to learn\nmore.\n\nNote: We recommend using CryptoDeterministicConfig for all use cases which\ndo not require preserving the input alphabet space and size, plus warrant\nreferential integrity.", + "description": "Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/dlp/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity.", "id": "GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig", "properties": { "commonAlphabet": { @@ -4005,14 +4026,14 @@ }, "context": { "$ref": "GooglePrivacyDlpV2FieldId", - "description": "The 'tweak', a context may be used for higher security since the same\nidentifier in two different contexts won't be given the same surrogate. If\nthe context is not set, a default tweak will be used.\n\nIf the context is set but:\n\n1. there is no record present when transforming a given value or\n1. the field is not present when transforming a given value,\n\na default tweak will be used.\n\nNote that case (1) is expected when an `InfoTypeTransformation` is\napplied to both structured and non-structured `ContentItem`s.\nCurrently, the referenced field may be of value type integer or string.\n\nThe tweak is constructed as a sequence of bytes in big endian byte order\nsuch that:\n\n- a 64 bit integer is encoded followed by a single byte of value 1\n- a string is encoded in UTF-8 format followed by a single byte of value 2" + "description": "The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and non-structured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2" }, "cryptoKey": { "$ref": "GooglePrivacyDlpV2CryptoKey", "description": "Required. The key used by the encryption algorithm." }, "customAlphabet": { - "description": "This is supported by mapping these to the alphanumeric characters\nthat the FFX mode natively supports. This happens before/after\nencryption/decryption.\nEach character listed must appear only once.\nNumber of characters must be in the range [2, 95].\nThis must be encoded as ASCII.\nThe order of characters does not matter.\nThe full list of allowed characters is:\n0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\n~`!@#$%^&*()_-+={[}]|\\:;\"'<,>.?/", + "description": "This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\\:;\"'<,>.?/", "type": "string" }, "radix": { @@ -4022,17 +4043,17 @@ }, "surrogateInfoType": { "$ref": "GooglePrivacyDlpV2InfoType", - "description": "The custom infoType to annotate the surrogate with.\nThis annotation will be applied to the surrogate by prefixing it with\nthe name of the custom infoType followed by the number of\ncharacters comprising the surrogate. The following scheme defines the\nformat: info_type_name(surrogate_character_count):surrogate\n\nFor example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and\nthe surrogate is 'abc', the full replacement value\nwill be: 'MY_TOKEN_INFO_TYPE(3):abc'\n\nThis annotation identifies the surrogate when inspecting content using the\ncustom infoType\n[`SurrogateType`](https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#surrogatetype).\nThis facilitates reversal of the surrogate when it occurs in free text.\n\nIn order for inspection to work properly, the name of this infoType must\nnot occur naturally anywhere in your data; otherwise, inspection may\nfind a surrogate that does not correspond to an actual identifier.\nTherefore, choose your custom infoType name carefully after considering\nwhat your data looks like. One way to select a name that has a high chance\nof yielding reliable detection is to include one or more unicode characters\nthat are highly improbable to exist in your data.\nFor example, assuming your data is entered from a regular ASCII keyboard,\nthe symbol with the hex code point 29DD might be used like so:\n⧝MY_TOKEN_TYPE" + "description": "The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE" } }, "type": "object" }, "GooglePrivacyDlpV2CustomInfoType": { - "description": "Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question.", + "description": "Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.", "id": "GooglePrivacyDlpV2CustomInfoType", "properties": { "detectionRules": { - "description": "Set of detection rules to apply to all findings of this CustomInfoType.\nRules are applied in order that they are specified. Not supported for the\n`surrogate_type` CustomInfoType.", + "description": "Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type` CustomInfoType.", "items": { "$ref": "GooglePrivacyDlpV2DetectionRule" }, @@ -4043,23 +4064,23 @@ "description": "A list of phrases to detect as a CustomInfoType." }, "exclusionType": { - "description": "If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding\nto be returned. It still can be used for rules matching.", + "description": "If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.", "enum": [ "EXCLUSION_TYPE_UNSPECIFIED", "EXCLUSION_TYPE_EXCLUDE" ], "enumDescriptions": [ "A finding of this custom info type will not be excluded from results.", - "A finding of this custom info type will be excluded from final results,\nbut can still affect rule execution." + "A finding of this custom info type will be excluded from final results, but can still affect rule execution." ], "type": "string" }, "infoType": { "$ref": "GooglePrivacyDlpV2InfoType", - "description": "CustomInfoType can either be a new infoType, or an extension of built-in\ninfoType, when the name matches one of existing infoTypes and that infoType\nis specified in `InspectContent.info_types` field. Specifying the latter\nadds findings to the one detected by the system. If built-in info type is\nnot specified in `InspectContent.info_types` list then the name is treated\nas a custom info type." + "description": "CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type." }, "likelihood": { - "description": "Likelihood to return for this CustomInfoType. This base value can be\naltered by a detection rule if the finding meets the criteria specified by\nthe rule. Defaults to `VERY_LIKELY` if not specified.", + "description": "Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified.", "enum": [ "LIKELIHOOD_UNSPECIFIED", "VERY_UNLIKELY", @@ -4084,11 +4105,11 @@ }, "storedType": { "$ref": "GooglePrivacyDlpV2StoredType", - "description": "Load an existing `StoredInfoType` resource for use in\n`InspectDataSource`. Not currently supported in `InspectContent`." + "description": "Load an existing `StoredInfoType` resource for use in `InspectDataSource`. Not currently supported in `InspectContent`." }, "surrogateType": { "$ref": "GooglePrivacyDlpV2SurrogateType", - "description": "Message for detecting output from deidentification transformations that\nsupport reversing." + "description": "Message for detecting output from deidentification transformations that support reversing." } }, "type": "object" @@ -4114,22 +4135,22 @@ }, "partitionId": { "$ref": "GooglePrivacyDlpV2PartitionId", - "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty." + "description": "A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty." } }, "type": "object" }, "GooglePrivacyDlpV2DateShiftConfig": { - "description": "Shifts dates by random number of days, with option to be consistent for the\nsame context. See https://cloud.google.com/dlp/docs/concepts-date-shifting\nto learn more.", + "description": "Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/dlp/docs/concepts-date-shifting to learn more.", "id": "GooglePrivacyDlpV2DateShiftConfig", "properties": { "context": { "$ref": "GooglePrivacyDlpV2FieldId", - "description": "Points to the field that contains the context, for example, an entity id.\nIf set, must also set cryptoKey. If set, shift will be consistent for the\ngiven context." + "description": "Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context." }, "cryptoKey": { "$ref": "GooglePrivacyDlpV2CryptoKey", - "description": "Causes the shift to be computed based on this key and the context. This\nresults in the same shift for the same context and crypto_key. If\nset, must also set context. Can only be applied to table items." + "description": "Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items." }, "lowerBoundDays": { "description": "Required. For example, -5 means shift date to at most 5 days back in the past.", @@ -4137,7 +4158,7 @@ "type": "integer" }, "upperBoundDays": { - "description": "Required. Range of shift in days. Actual shift will be selected at random within this\nrange (inclusive ends). Negative means shift to earlier in time. Must not\nbe more than 365250 days (1000 years) each direction.\n\nFor example, 3 means shift date to at most 3 days into the future.", + "description": "Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future.", "format": "int32", "type": "integer" } @@ -4145,12 +4166,12 @@ "type": "object" }, "GooglePrivacyDlpV2DateTime": { - "description": "Message for a date time object.\ne.g. 2018-01-01, 5th August.", + "description": "Message for a date time object. e.g. 2018-01-01, 5th August.", "id": "GooglePrivacyDlpV2DateTime", "properties": { "date": { "$ref": "GoogleTypeDate", - "description": "One or more of the following must be set.\nMust be a valid date or time value." + "description": "One or more of the following must be set. Must be a valid date or time value." }, "dayOfWeek": { "description": "Day of week", @@ -4193,15 +4214,15 @@ "properties": { "infoTypeTransformations": { "$ref": "GooglePrivacyDlpV2InfoTypeTransformations", - "description": "Treat the dataset as free-form text and apply the same free text\ntransformation everywhere." + "description": "Treat the dataset as free-form text and apply the same free text transformation everywhere." }, "recordTransformations": { "$ref": "GooglePrivacyDlpV2RecordTransformations", - "description": "Treat the dataset as structured. Transformations can be applied to\nspecific locations within structured datasets, such as transforming\na column within a table." + "description": "Treat the dataset as structured. Transformations can be applied to specific locations within structured datasets, such as transforming a column within a table." }, "transformationErrorHandling": { "$ref": "GooglePrivacyDlpV2TransformationErrorHandling", - "description": "Mode for handling transformation errors. If left unspecified, the default\nmode is `TransformationErrorHandling.ThrowError`." + "description": "Mode for handling transformation errors. If left unspecified, the default mode is `TransformationErrorHandling.ThrowError`." } }, "type": "object" @@ -4212,18 +4233,18 @@ "properties": { "deidentifyConfig": { "$ref": "GooglePrivacyDlpV2DeidentifyConfig", - "description": "Configuration for the de-identification of the content item.\nItems specified here will override the template referenced by the\ndeidentify_template_name argument." + "description": "Configuration for the de-identification of the content item. Items specified here will override the template referenced by the deidentify_template_name argument." }, "deidentifyTemplateName": { - "description": "Template to use. Any configuration directly specified in\ndeidentify_config will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.", + "description": "Template to use. Any configuration directly specified in deidentify_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.", "type": "string" }, "inspectConfig": { "$ref": "GooglePrivacyDlpV2InspectConfig", - "description": "Configuration for the inspector.\nItems specified here will override the template referenced by the\ninspect_template_name argument." + "description": "Configuration for the inspector. Items specified here will override the template referenced by the inspect_template_name argument." }, "inspectTemplateName": { - "description": "Template to use. Any configuration directly specified in\ninspect_config will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.", + "description": "Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.", "type": "string" }, "item": { @@ -4253,17 +4274,18 @@ "type": "object" }, "GooglePrivacyDlpV2DeidentifyTemplate": { - "description": "DeidentifyTemplates contains instructions on how to de-identify content.\nSee https://cloud.google.com/dlp/docs/concepts-templates to learn more.", + "description": "DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/dlp/docs/concepts-templates to learn more.", "id": "GooglePrivacyDlpV2DeidentifyTemplate", "properties": { "createTime": { "description": "Output only. The creation timestamp of an inspectTemplate.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "deidentifyConfig": { "$ref": "GooglePrivacyDlpV2DeidentifyConfig", - "description": "///////////// // The core content of the template // ///////////////" + "description": "///////////// // The core content of the template // ///////////////" }, "description": { "description": "Short description (max 256 chars).", @@ -4274,44 +4296,46 @@ "type": "string" }, "name": { - "description": "Output only. The template name.\n\nThe template will have one of the following formats:\n`projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR\n`organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID`", + "description": "Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID`", + "readOnly": true, "type": "string" }, "updateTime": { "description": "Output only. The last update timestamp of an inspectTemplate.", "format": "google-datetime", + "readOnly": true, "type": "string" } }, "type": "object" }, "GooglePrivacyDlpV2DeltaPresenceEstimationConfig": { - "description": "δ-presence metric, used to estimate how likely it is for an attacker to\nfigure out that one given individual appears in a de-identified dataset.\nSimilarly to the k-map metric, we cannot compute δ-presence exactly without\nknowing the attack dataset, so we use a statistical model instead.", + "description": "δ-presence metric, used to estimate how likely it is for an attacker to figure out that one given individual appears in a de-identified dataset. Similarly to the k-map metric, we cannot compute δ-presence exactly without knowing the attack dataset, so we use a statistical model instead.", "id": "GooglePrivacyDlpV2DeltaPresenceEstimationConfig", "properties": { "auxiliaryTables": { - "description": "Several auxiliary tables can be used in the analysis. Each custom_tag\nused to tag a quasi-identifiers field must appear in exactly one\nfield of one auxiliary table.", + "description": "Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers field must appear in exactly one field of one auxiliary table.", "items": { "$ref": "GooglePrivacyDlpV2StatisticalTable" }, "type": "array" }, "quasiIds": { - "description": "Required. Fields considered to be quasi-identifiers. No two fields can have the\nsame tag.", + "description": "Required. Fields considered to be quasi-identifiers. No two fields can have the same tag.", "items": { "$ref": "GooglePrivacyDlpV2QuasiId" }, "type": "array" }, "regionCode": { - "description": "ISO 3166-1 alpha-2 region code to use in the statistical modeling.\nSet if no column is tagged with a region-specific InfoType (like\nUS_ZIP_5) or a region code.", + "description": "ISO 3166-1 alpha-2 region code to use in the statistical modeling. Set if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code.", "type": "string" } }, "type": "object" }, "GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket": { - "description": "A DeltaPresenceEstimationHistogramBucket message with the following\nvalues:\n min_probability: 0.1\n max_probability: 0.2\n frequency: 42\nmeans that there are 42 records for which δ is in [0.1, 0.2). An\nimportant particular case is when min_probability = max_probability = 1:\nthen, every individual who shares this quasi-identifier combination is in\nthe dataset.", + "description": "A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset.", "id": "GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket", "properties": { "bucketSize": { @@ -4325,7 +4349,7 @@ "type": "string" }, "bucketValues": { - "description": "Sample of quasi-identifier tuple values in this bucket. The total\nnumber of classes returned per bucket is capped at 20.", + "description": "Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20.", "items": { "$ref": "GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues" }, @@ -4349,7 +4373,7 @@ "id": "GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues", "properties": { "estimatedProbability": { - "description": "The estimated probability that a given individual sharing these\nquasi-identifier values is in the dataset. This value, typically called\nδ, is the ratio between the number of records in the dataset with these\nquasi-identifier values, and the total number of individuals (inside\n*and* outside the dataset) with these quasi-identifier values.\nFor example, if there are 15 individuals in the dataset who share the\nsame quasi-identifier values, and an estimated 100 people in the entire\npopulation with these values, then δ is 0.15.", + "description": "The estimated probability that a given individual sharing these quasi-identifier values is in the dataset. This value, typically called δ, is the ratio between the number of records in the dataset with these quasi-identifier values, and the total number of individuals (inside *and* outside the dataset) with these quasi-identifier values. For example, if there are 15 individuals in the dataset who share the same quasi-identifier values, and an estimated 100 people in the entire population with these values, then δ is 0.15.", "format": "double", "type": "number" }, @@ -4364,11 +4388,11 @@ "type": "object" }, "GooglePrivacyDlpV2DeltaPresenceEstimationResult": { - "description": "Result of the δ-presence computation. Note that these results are an\nestimation, not exact values.", + "description": "Result of the δ-presence computation. Note that these results are an estimation, not exact values.", "id": "GooglePrivacyDlpV2DeltaPresenceEstimationResult", "properties": { "deltaPresenceEstimationHistogram": { - "description": "The intervals [min_probability, max_probability) do not overlap. If a\nvalue doesn't correspond to any such interval, the associated frequency\nis zero. For example, the following records:\n {min_probability: 0, max_probability: 0.1, frequency: 17}\n {min_probability: 0.2, max_probability: 0.3, frequency: 42}\n {min_probability: 0.3, max_probability: 0.4, frequency: 99}\nmean that there are no record with an estimated probability in [0.1, 0.2)\nnor larger or equal to 0.4.", + "description": "The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4.", "items": { "$ref": "GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket" }, @@ -4378,7 +4402,7 @@ "type": "object" }, "GooglePrivacyDlpV2DetectionRule": { - "description": "Deprecated; use `InspectionRuleSet` instead. Rule for modifying a\n`CustomInfoType` to alter behavior under certain circumstances, depending\non the specific details of the rule. Not supported for the `surrogate_type`\ncustom infoType.", + "description": "Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType.", "id": "GooglePrivacyDlpV2DetectionRule", "properties": { "hotwordRule": { @@ -4389,12 +4413,12 @@ "type": "object" }, "GooglePrivacyDlpV2Dictionary": { - "description": "Custom information type based on a dictionary of words or phrases. This can\nbe used to match sensitive information specific to the data, such as a list\nof employee IDs or job titles.\n\nDictionary words are case-insensitive and all characters other than letters\nand digits in the unicode [Basic Multilingual\nPlane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)\nwill be replaced with whitespace when scanning for matches, so the\ndictionary phrase \"Sam Johnson\" will match all three phrases \"sam johnson\",\n\"Sam, Johnson\", and \"Sam (Johnson)\". Additionally, the characters\nsurrounding any match must be of a different type than the adjacent\ncharacters within the word, so letters must be next to non-letters and\ndigits next to non-digits. For example, the dictionary word \"jen\" will\nmatch the first three letters of the text \"jen123\" but will return no\nmatches for \"jennifer\".\n\nDictionary words containing a large number of characters that are not\nletters or digits may result in unexpected findings because such characters\nare treated as whitespace. The\n[limits](https://cloud.google.com/dlp/limits) page contains details about\nthe size limits of dictionaries. For dictionaries that do not fit within\nthese constraints, consider using `LargeCustomDictionaryConfig` in the\n`StoredInfoType` API.", + "description": "Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase \"Sam Johnson\" will match all three phrases \"sam johnson\", \"Sam, Johnson\", and \"Sam (Johnson)\". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word \"jen\" will match the first three letters of the text \"jen123\" but will return no matches for \"jennifer\". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API.", "id": "GooglePrivacyDlpV2Dictionary", "properties": { "cloudStoragePath": { "$ref": "GooglePrivacyDlpV2CloudStoragePath", - "description": "Newline-delimited file of words in Cloud Storage. Only a single file\nis accepted." + "description": "Newline-delimited file of words in Cloud Storage. Only a single file is accepted." }, "wordList": { "$ref": "GooglePrivacyDlpV2WordList", @@ -4429,7 +4453,7 @@ "description": "Results from inspecting a data source." }, "jobTriggerName": { - "description": "If created by a job trigger, the resource name of the trigger that\ninstantiated the job.", + "description": "If created by a job trigger, the resource name of the trigger that instantiated the job.", "type": "string" }, "name": { @@ -4459,11 +4483,11 @@ "enumDescriptions": [ "Unused.", "The job has not yet started.", - "The job is currently running. Once a job has finished it will transition\nto FAILED or DONE.", + "The job is currently running. Once a job has finished it will transition to FAILED or DONE.", "The job is no longer running.", "The job was canceled before it could complete.", "The job had an error and did not complete.", - "The job is currently accepting findings via hybridInspect.\nA hybrid job in ACTIVE state may continue to have findings added to it\nthrough calling of hybridInspect. After the job has finished no more\ncalls to hybridInspect may be made. ACTIVE jobs can transition to DONE." + "The job is currently accepting findings via hybridInspect. A hybrid job in ACTIVE state may continue to have findings added to it through calling of hybridInspect. After the job has finished no more calls to hybridInspect may be made. ACTIVE jobs can transition to DONE." ], "type": "string" }, @@ -4489,7 +4513,7 @@ "id": "GooglePrivacyDlpV2DocumentLocation", "properties": { "fileOffset": { - "description": "Offset of the line, from the beginning of the file, where the finding\nis located.", + "description": "Offset of the line, from the beginning of the file, where the finding is located.", "format": "int64", "type": "string" } @@ -4497,7 +4521,7 @@ "type": "object" }, "GooglePrivacyDlpV2EntityId": { - "description": "An entity in a dataset is a field or set of fields that correspond to a\nsingle person. For example, in medical records the `EntityId` might be a\npatient identifier, or for financial records it might be an account\nidentifier. This message is used when generalizations or analysis must take\ninto account that multiple rows correspond to the same entity.", + "description": "An entity in a dataset is a field or set of fields that correspond to a single person. For example, in medical records the `EntityId` might be a patient identifier, or for financial records it might be an account identifier. This message is used when generalizations or analysis must take into account that multiple rows correspond to the same entity.", "id": "GooglePrivacyDlpV2EntityId", "properties": { "field": { @@ -4508,7 +4532,7 @@ "type": "object" }, "GooglePrivacyDlpV2Error": { - "description": "Details information about an error encountered during job execution or\nthe results of an unsuccessful activation of the JobTrigger.", + "description": "Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.", "id": "GooglePrivacyDlpV2Error", "properties": { "details": { @@ -4531,7 +4555,7 @@ "id": "GooglePrivacyDlpV2ExcludeInfoTypes", "properties": { "infoTypes": { - "description": "InfoType list in ExclusionRule rule drops a finding when it overlaps or\ncontained within with a finding of an infoType from this list. For\nexample, for `InspectionRuleSet.info_types` containing \"PHONE_NUMBER\"` and\n`exclusion_rule` containing `exclude_info_types.info_types` with\n\"EMAIL_ADDRESS\" the phone number findings are dropped if they overlap\nwith EMAIL_ADDRESS finding.\nThat leads to \"555-222-2222@example.org\" to generate only a single\nfinding, namely email address.", + "description": "InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing \"PHONE_NUMBER\"` and `exclusion_rule` containing `exclude_info_types.info_types` with \"EMAIL_ADDRESS\" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to \"555-222-2222@example.org\" to generate only a single finding, namely email address.", "items": { "$ref": "GooglePrivacyDlpV2InfoType" }, @@ -4541,7 +4565,7 @@ "type": "object" }, "GooglePrivacyDlpV2ExclusionRule": { - "description": "The rule that specifies conditions when findings of infoTypes specified in\n`InspectionRuleSet` are removed from results.", + "description": "The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results.", "id": "GooglePrivacyDlpV2ExclusionRule", "properties": { "dictionary": { @@ -4562,9 +4586,9 @@ ], "enumDescriptions": [ "Invalid.", - "Full match.\n\n- Dictionary: join of Dictionary results matched complete finding quote\n- Regex: all regex matches fill a finding quote start to end\n- Exclude info type: completely inside affecting info types findings", - "Partial match.\n\n- Dictionary: at least one of the tokens in the finding matches\n- Regex: substring of the finding matches\n- Exclude info type: intersects with affecting info types findings", - "Inverse match.\n\n- Dictionary: no tokens in the finding match the dictionary\n- Regex: finding doesn't match the regex\n- Exclude info type: no intersection with affecting info types findings" + "Full match. - Dictionary: join of Dictionary results matched complete finding quote - Regex: all regex matches fill a finding quote start to end - Exclude info type: completely inside affecting info types findings", + "Partial match. - Dictionary: at least one of the tokens in the finding matches - Regex: substring of the finding matches - Exclude info type: intersects with affecting info types findings", + "Inverse match. - Dictionary: no tokens in the finding match the dictionary - Regex: finding doesn't match the regex - Exclude info type: no intersection with affecting info types findings" ], "type": "string" }, @@ -4584,7 +4608,7 @@ "description": "Conditions to apply to the expression." }, "logicalOperator": { - "description": "The operator to apply to the result of conditions. Default and currently\nonly supported value is `AND`.", + "description": "The operator to apply to the result of conditions. Default and currently only supported value is `AND`.", "enum": [ "LOGICAL_OPERATOR_UNSPECIFIED", "AND" @@ -4615,7 +4639,7 @@ "properties": { "condition": { "$ref": "GooglePrivacyDlpV2RecordCondition", - "description": "Only apply the transformation if the condition evaluates to true for the\ngiven `RecordCondition`. The conditions are allowed to reference fields\nthat are not used in the actual transformation.\n\nExample Use Cases:\n\n- Apply a different bucket transformation to an age column if the zip code\ncolumn for the same record is within a specific range.\n- Redact a field if the date of birth field is greater than 85." + "description": "Only apply the transformation if the condition evaluates to true for the given `RecordCondition`. The conditions are allowed to reference fields that are not used in the actual transformation. Example Use Cases: - Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range. - Redact a field if the date of birth field is greater than 85." }, "fields": { "description": "Required. Input field(s) to apply the transformation to.", @@ -4626,7 +4650,7 @@ }, "infoTypeTransformations": { "$ref": "GooglePrivacyDlpV2InfoTypeTransformations", - "description": "Treat the contents of the field as free text, and selectively\ntransform content that matches an `InfoType`." + "description": "Treat the contents of the field as free text, and selectively transform content that matches an `InfoType`." }, "primitiveTransformation": { "$ref": "GooglePrivacyDlpV2PrimitiveTransformation", @@ -4641,10 +4665,10 @@ "properties": { "regexFileSet": { "$ref": "GooglePrivacyDlpV2CloudStorageRegexFileSet", - "description": "The regex-filtered set of files to scan. Exactly one of `url` or\n`regex_file_set` must be set." + "description": "The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set." }, "url": { - "description": "The Cloud Storage url of the file(s) to scan, in the format\n`gs:///`. Trailing wildcard in the path is allowed.\n\nIf the url ends in a trailing slash, the bucket or directory represented\nby the url will be scanned non-recursively (content in sub-directories\nwill not be scanned). This means that `gs://mybucket/` is equivalent to\n`gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to\n`gs://mybucket/directory/*`.\n\nExactly one of `url` or `regex_file_set` must be set.", + "description": "The Cloud Storage url of the file(s) to scan, in the format `gs:///`. Trailing wildcard in the path is allowed. If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that `gs://mybucket/` is equivalent to `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to `gs://mybucket/directory/*`. Exactly one of `url` or `regex_file_set` must be set.", "type": "string" } }, @@ -4661,7 +4685,7 @@ }, "infoType": { "$ref": "GooglePrivacyDlpV2InfoType", - "description": "The type of content that might have been found.\nProvided if `excluded_types` is false." + "description": "The type of content that might have been found. Provided if `excluded_types` is false." }, "jobCreateTime": { "description": "Time the job started that produced this finding.", @@ -4676,7 +4700,7 @@ "additionalProperties": { "type": "string" }, - "description": "The labels associated with this `Finding`.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.\n\nNo more than 10 labels can be associated with a given finding.\n\nExamples:\n* `\"environment\" : \"production\"`\n* `\"pipeline\" : \"etl\"`", + "description": "The labels associated with this `Finding`. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `\"environment\" : \"production\"` * `\"pipeline\" : \"etl\"`", "type": "object" }, "likelihood": { @@ -4704,16 +4728,16 @@ "description": "Where the content was found." }, "name": { - "description": "Resource name in format\nprojects/{project}/locations/{location}/findings/{finding} Populated only\nwhen viewing persisted findings.", + "description": "Resource name in format projects/{project}/locations/{location}/findings/{finding} Populated only when viewing persisted findings.", "type": "string" }, "quote": { - "description": "The content that was found. Even if the content is not textual, it\nmay be converted to a textual representation here.\nProvided if `include_quote` is true and the finding is\nless than or equal to 4096 bytes long. If the finding exceeds 4096 bytes\nin length, the quote may be omitted.", + "description": "The content that was found. Even if the content is not textual, it may be converted to a textual representation here. Provided if `include_quote` is true and the finding is less than or equal to 4096 bytes long. If the finding exceeds 4096 bytes in length, the quote may be omitted.", "type": "string" }, "quoteInfo": { "$ref": "GooglePrivacyDlpV2QuoteInfo", - "description": "Contains data parsed from quotes. Only populated if include_quote was set\nto true and a supported infoType was requested. Currently supported\ninfoTypes: DATE, DATE_OF_BIRTH and TIME." + "description": "Contains data parsed from quotes. Only populated if include_quote was set to true and a supported infoType was requested. Currently supported infoTypes: DATE, DATE_OF_BIRTH and TIME." }, "resourceName": { "description": "The job that stored the finding.", @@ -4738,12 +4762,12 @@ "type": "array" }, "maxFindingsPerItem": { - "description": "Max number of findings that will be returned for each item scanned.\nWhen set within `InspectJobConfig`,\nthe maximum returned is 2000 regardless if this is set higher.\nWhen set within `InspectContentRequest`, this field is ignored.", + "description": "Max number of findings that will be returned for each item scanned. When set within `InspectJobConfig`, the maximum returned is 2000 regardless if this is set higher. When set within `InspectContentRequest`, this field is ignored.", "format": "int32", "type": "integer" }, "maxFindingsPerRequest": { - "description": "Max number of findings that will be returned per request/job.\nWhen set within `InspectContentRequest`, the maximum returned is 2000\nregardless if this is set higher.", + "description": "Max number of findings that will be returned per request/job. When set within `InspectContentRequest`, the maximum returned is 2000 regardless if this is set higher.", "format": "int32", "type": "integer" } @@ -4757,27 +4781,27 @@ "type": "object" }, "GooglePrivacyDlpV2FixedSizeBucketingConfig": { - "description": "Buckets values based on fixed size ranges. The\nBucketing transformation can provide all of this functionality,\nbut requires more configuration. This message is provided as a convenience to\nthe user for simple bucketing strategies.\n\nThe transformed value will be a hyphenated string of\n{lower_bound}-{upper_bound}, i.e if lower_bound = 10 and upper_bound = 20\nall values that are within this bucket will be replaced with \"10-20\".\n\nThis can be used on data of type: double, long.\n\nIf the bound Value type differs from the type of data\nbeing transformed, we will first attempt converting the type of the data to\nbe transformed to match the type of the bound before comparing.\n\nSee https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.", + "description": "Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}, i.e if lower_bound = 10 and upper_bound = 20 all values that are within this bucket will be replaced with \"10-20\". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.", "id": "GooglePrivacyDlpV2FixedSizeBucketingConfig", "properties": { "bucketSize": { - "description": "Required. Size of each bucket (except for minimum and maximum buckets). So if\n`lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the\nfollowing buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60,\n60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works.", + "description": "Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works.", "format": "double", "type": "number" }, "lowerBound": { "$ref": "GooglePrivacyDlpV2Value", - "description": "Required. Lower bound value of buckets. All values less than `lower_bound` are\ngrouped together into a single bucket; for example if `lower_bound` = 10,\nthen all values less than 10 are replaced with the value \"-10\"." + "description": "Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value \"-10\"." }, "upperBound": { "$ref": "GooglePrivacyDlpV2Value", - "description": "Required. Upper bound value of buckets. All values greater than upper_bound are\ngrouped together into a single bucket; for example if `upper_bound` = 89,\nthen all values greater than 89 are replaced with the value \"89+\"." + "description": "Required. Upper bound value of buckets. All values greater than upper_bound are grouped together into a single bucket; for example if `upper_bound` = 89, then all values greater than 89 are replaced with the value \"89+\"." } }, "type": "object" }, "GooglePrivacyDlpV2HotwordRule": { - "description": "The rule that adjusts the likelihood of findings within a certain\nproximity of hotwords.", + "description": "The rule that adjusts the likelihood of findings within a certain proximity of hotwords.", "id": "GooglePrivacyDlpV2HotwordRule", "properties": { "hotwordRegex": { @@ -4790,13 +4814,13 @@ }, "proximity": { "$ref": "GooglePrivacyDlpV2Proximity", - "description": "Proximity of the finding within which the entire hotword must reside.\nThe total length of the window cannot exceed 1000 characters. Note that\nthe finding itself will be included in the window, so that hotwords may\nbe used to match substrings of the finding itself. For example, the\ncertainty of a phone number regex \"\\(\\d{3}\\) \\d{3}-\\d{4}\" could be\nadjusted upwards if the area code is known to be the local area code of\na company office using the hotword regex \"\\(xxx\\)\", where \"xxx\"\nis the area code in question." + "description": "Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex \"\\(\\d{3}\\) \\d{3}-\\d{4}\" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex \"\\(xxx\\)\", where \"xxx\" is the area code in question." } }, "type": "object" }, "GooglePrivacyDlpV2HybridContentItem": { - "description": "An individual hybrid item to inspect. Will be stored temporarily during\nprocessing.", + "description": "An individual hybrid item to inspect. Will be stored temporarily during processing.", "id": "GooglePrivacyDlpV2HybridContentItem", "properties": { "findingDetails": { @@ -4819,7 +4843,7 @@ "description": "Details about the container where the content being inspected is from." }, "fileOffset": { - "description": "Offset in bytes of the line, from the beginning of the file, where the\nfinding is located. Populate if the item being scanned is only part of a\nbigger item, such as a shard of a file and you want to track the absolute\nposition of the finding.", + "description": "Offset in bytes of the line, from the beginning of the file, where the finding is located. Populate if the item being scanned is only part of a bigger item, such as a shard of a file and you want to track the absolute position of the finding.", "format": "int64", "type": "string" }, @@ -4827,17 +4851,17 @@ "additionalProperties": { "type": "string" }, - "description": "Labels to represent user provided metadata about the data being inspected.\nIf configured by the job, some key values may be required.\nThe labels associated with `Finding`'s produced by hybrid\ninspection.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.\n\nNo more than 10 labels can be associated with a given finding.\n\nExamples:\n* `\"environment\" : \"production\"`\n* `\"pipeline\" : \"etl\"`", + "description": "Labels to represent user provided metadata about the data being inspected. If configured by the job, some key values may be required. The labels associated with `Finding`'s produced by hybrid inspection. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `\"environment\" : \"production\"` * `\"pipeline\" : \"etl\"`", "type": "object" }, "rowOffset": { - "description": "Offset of the row for tables. Populate if the row(s) being scanned are\npart of a bigger dataset and you want to keep track of their absolute\nposition.", + "description": "Offset of the row for tables. Populate if the row(s) being scanned are part of a bigger dataset and you want to keep track of their absolute position.", "format": "int64", "type": "string" }, "tableOptions": { "$ref": "GooglePrivacyDlpV2TableOptions", - "description": "If the container is a table, additional information to make findings\nmeaningful such as the columns that are primary keys. If not known ahead\nof time, can also be set within each inspect hybrid call and the two\nwill be merged. Note that identifying_fields will only be stored to\nBigQuery, and only if the BigQuery action has been included." + "description": "If the container is a table, additional information to make findings meaningful such as the columns that are primary keys. If not known ahead of time, can also be set within each inspect hybrid call and the two will be merged. Note that identifying_fields will only be stored to BigQuery, and only if the BigQuery action has been included." } }, "type": "object" @@ -4875,12 +4899,12 @@ "id": "GooglePrivacyDlpV2HybridInspectStatistics", "properties": { "abortedCount": { - "description": "The number of hybrid inspection requests aborted because the job ran\nout of quota or was ended before they could be processed.", + "description": "The number of hybrid inspection requests aborted because the job ran out of quota or was ended before they could be processed.", "format": "int64", "type": "string" }, "pendingCount": { - "description": "The number of hybrid requests currently being processed. Only populated\nwhen called via method `getDlpJob`.\nA burst of traffic may cause hybrid inspect requests to be enqueued.\nProcessing will take place as quickly as possible, but resource limitations\nmay impact how long a request is enqueued for.", + "description": "The number of hybrid requests currently being processed. Only populated when called via method `getDlpJob`. A burst of traffic may cause hybrid inspect requests to be enqueued. Processing will take place as quickly as possible, but resource limitations may impact how long a request is enqueued for.", "format": "int64", "type": "string" }, @@ -4893,22 +4917,22 @@ "type": "object" }, "GooglePrivacyDlpV2HybridOptions": { - "description": "Configuration to control jobs where the content being inspected is outside\nof Google Cloud Platform.", + "description": "Configuration to control jobs where the content being inspected is outside of Google Cloud Platform.", "id": "GooglePrivacyDlpV2HybridOptions", "properties": { "description": { - "description": "A short description of where the data is coming from. Will be stored once\nin the job. 256 max length.", + "description": "A short description of where the data is coming from. Will be stored once in the job. 256 max length.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "To organize findings, these labels will be added to each finding.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.\n\nNo more than 10 labels can be associated with a given finding.\n\nExamples:\n* `\"environment\" : \"production\"`\n* `\"pipeline\" : \"etl\"`", + "description": "To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `\"environment\" : \"production\"` * `\"pipeline\" : \"etl\"`", "type": "object" }, "requiredFindingLabelKeys": { - "description": "These are labels that each inspection request must include within their\n'finding_labels' map. Request may contain others, but any missing one of\nthese will be rejected.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n\nNo more than 10 keys can be required.", + "description": "These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can be required.", "items": { "type": "string" }, @@ -4916,7 +4940,7 @@ }, "tableOptions": { "$ref": "GooglePrivacyDlpV2TableOptions", - "description": "If the container is a table, additional information to make findings\nmeaningful such as the columns that are primary keys." + "description": "If the container is a table, additional information to make findings meaningful such as the columns that are primary keys." } }, "type": "object" @@ -4941,15 +4965,15 @@ "properties": { "infoType": { "$ref": "GooglePrivacyDlpV2InfoType", - "description": "Only one per info_type should be provided per request. If not\nspecified, and redact_all_text is false, the DLP API will redact all\ntext that it matches against all info_types that are found, but not\nspecified in another ImageRedactionConfig." + "description": "Only one per info_type should be provided per request. If not specified, and redact_all_text is false, the DLP API will redact all text that it matches against all info_types that are found, but not specified in another ImageRedactionConfig." }, "redactAllText": { - "description": "If true, all text found in the image, regardless whether it matches an\ninfo_type, is redacted. Only one should be provided.", + "description": "If true, all text found in the image, regardless whether it matches an info_type, is redacted. Only one should be provided.", "type": "boolean" }, "redactionColor": { "$ref": "GooglePrivacyDlpV2Color", - "description": "The color to use when redacting content from an image. If not specified,\nthe default is black." + "description": "The color to use when redacting content from an image. If not specified, the default is black." } }, "type": "object" @@ -4959,7 +4983,7 @@ "id": "GooglePrivacyDlpV2InfoType", "properties": { "name": { - "description": "Name of the information type. Either a name of your choosing when\ncreating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying\na built-in type. When sending Cloud DLP results to Data Catalog, infoType\nnames should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.", + "description": "Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.", "type": "string" } }, @@ -4970,7 +4994,7 @@ "id": "GooglePrivacyDlpV2InfoTypeDescription", "properties": { "description": { - "description": "Description of the infotype. Translated when language is provided in the\nrequest.", + "description": "Description of the infotype. Translated when language is provided in the request.", "type": "string" }, "displayName": { @@ -4994,6 +5018,11 @@ "INSPECT", "RISK_ANALYSIS" ], + "enumDescriptions": [ + "Unused.", + "Supported by the inspect operations.", + "Supported by the risk analysis operations." + ], "type": "string" }, "type": "array" @@ -5002,12 +5031,12 @@ "type": "object" }, "GooglePrivacyDlpV2InfoTypeLimit": { - "description": "Max findings configuration per infoType, per content item or long\nrunning DlpJob.", + "description": "Max findings configuration per infoType, per content item or long running DlpJob.", "id": "GooglePrivacyDlpV2InfoTypeLimit", "properties": { "infoType": { "$ref": "GooglePrivacyDlpV2InfoType", - "description": "Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that\nare found but not specified in another InfoTypeLimit." + "description": "Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit." }, "maxFindings": { "description": "Max findings limit for the given infoType.", @@ -5034,11 +5063,11 @@ "type": "object" }, "GooglePrivacyDlpV2InfoTypeTransformation": { - "description": "A transformation to apply to text that is identified as a specific\ninfo_type.", + "description": "A transformation to apply to text that is identified as a specific info_type.", "id": "GooglePrivacyDlpV2InfoTypeTransformation", "properties": { "infoTypes": { - "description": "InfoTypes to apply the transformation to. An empty list will cause\nthis transformation to apply to all findings that correspond to\ninfoTypes that were requested in `InspectConfig`.", + "description": "InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`.", "items": { "$ref": "GooglePrivacyDlpV2InfoType" }, @@ -5052,11 +5081,11 @@ "type": "object" }, "GooglePrivacyDlpV2InfoTypeTransformations": { - "description": "A type of transformation that will scan unstructured text and\napply various `PrimitiveTransformation`s to each finding, where the\ntransformation is applied to only values that were identified as a specific\ninfo_type.", + "description": "A type of transformation that will scan unstructured text and apply various `PrimitiveTransformation`s to each finding, where the transformation is applied to only values that were identified as a specific info_type.", "id": "GooglePrivacyDlpV2InfoTypeTransformations", "properties": { "transformations": { - "description": "Required. Transformation for each infoType. Cannot specify more than one\nfor a given infoType.", + "description": "Required. Transformation for each infoType. Cannot specify more than one for a given infoType.", "items": { "$ref": "GooglePrivacyDlpV2InfoTypeTransformation" }, @@ -5066,11 +5095,11 @@ "type": "object" }, "GooglePrivacyDlpV2InspectConfig": { - "description": "Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.", + "description": "Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used.", "id": "GooglePrivacyDlpV2InspectConfig", "properties": { "contentOptions": { - "description": "List of options defining data content to scan.\nIf empty, text, images, and other content will be included.", + "description": "List of options defining data content to scan. If empty, text, images, and other content will be included.", "enumDescriptions": [ "Includes entire content of a file or a data stream.", "Text content within the data, excluding any metadata.", @@ -5082,12 +5111,17 @@ "CONTENT_TEXT", "CONTENT_IMAGE" ], + "enumDescriptions": [ + "Includes entire content of a file or a data stream.", + "Text content within the data, excluding any metadata.", + "Images found in the data." + ], "type": "string" }, "type": "array" }, "customInfoTypes": { - "description": "CustomInfoTypes provided by the user. See\nhttps://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.", + "description": "CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.", "items": { "$ref": "GooglePrivacyDlpV2CustomInfoType" }, @@ -5098,11 +5132,11 @@ "type": "boolean" }, "includeQuote": { - "description": "When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote.", + "description": "When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.", "type": "boolean" }, "infoTypes": { - "description": "Restricts what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or listed at\nhttps://cloud.google.com/dlp/docs/infotypes-reference.\n\nWhen no InfoTypes or CustomInfoTypes are specified in a request, the\nsystem may automatically choose what detectors to run. By default this may\nbe all types, but may change over time as detectors are updated.\n\nIf you need precise control and predictability as to what detectors are\nrun you should specify specific InfoTypes listed in the reference,\notherwise a default list will be used, which may change over time.", + "description": "Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.", "items": { "$ref": "GooglePrivacyDlpV2InfoType" }, @@ -5113,7 +5147,7 @@ "description": "Configuration to control the number of findings returned." }, "minLikelihood": { - "description": "Only returns findings equal or above this threshold. The default is\nPOSSIBLE.\nSee https://cloud.google.com/dlp/docs/likelihood to learn more.", + "description": "Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.", "enum": [ "LIKELIHOOD_UNSPECIFIED", "VERY_UNLIKELY", @@ -5133,7 +5167,7 @@ "type": "string" }, "ruleSet": { - "description": "Set of rules to apply to the findings for this InspectConfig.\nExclusion rules, contained in the set are executed in the end, other\nrules are executed in the order they are specified for each info type.", + "description": "Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.", "items": { "$ref": "GooglePrivacyDlpV2InspectionRuleSet" }, @@ -5148,10 +5182,10 @@ "properties": { "inspectConfig": { "$ref": "GooglePrivacyDlpV2InspectConfig", - "description": "Configuration for the inspector. What specified here will override\nthe template referenced by the inspect_template_name argument." + "description": "Configuration for the inspector. What specified here will override the template referenced by the inspect_template_name argument." }, "inspectTemplateName": { - "description": "Template to use. Any configuration directly specified in\ninspect_config will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.", + "description": "Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.", "type": "string" }, "item": { @@ -5207,7 +5241,7 @@ "description": "How and what to scan for." }, "inspectTemplateName": { - "description": "If provided, will be used as the default for all values in InspectConfig.\n`inspect_config` will be merged into the values persisted as part of the\ntemplate.", + "description": "If provided, will be used as the default for all values in InspectConfig. `inspect_config` will be merged into the values persisted as part of the template.", "type": "string" }, "storageConfig": { @@ -5229,19 +5263,20 @@ "type": "array" }, "findingsTruncated": { - "description": "If true, then this item might have more findings than were returned,\nand the findings returned are an arbitrary subset of all findings.\nThe findings list might be truncated because the input items were too\nlarge, or because the server reached the maximum amount of resources\nallowed for a single API call. For best results, divide the input into\nsmaller batches.", + "description": "If true, then this item might have more findings than were returned, and the findings returned are an arbitrary subset of all findings. The findings list might be truncated because the input items were too large, or because the server reached the maximum amount of resources allowed for a single API call. For best results, divide the input into smaller batches.", "type": "boolean" } }, "type": "object" }, "GooglePrivacyDlpV2InspectTemplate": { - "description": "The inspectTemplate contains a configuration (set of types of sensitive data\nto be detected) to be used anywhere you otherwise would normally specify\nInspectConfig. See https://cloud.google.com/dlp/docs/concepts-templates\nto learn more.", + "description": "The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/dlp/docs/concepts-templates to learn more.", "id": "GooglePrivacyDlpV2InspectTemplate", "properties": { "createTime": { "description": "Output only. The creation timestamp of an inspectTemplate.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "description": { @@ -5257,19 +5292,21 @@ "description": "The core content of the template. Configuration of the scanning process." }, "name": { - "description": "Output only. The template name.\n\nThe template will have one of the following formats:\n`projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR\n`organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`;", + "description": "Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`;", + "readOnly": true, "type": "string" }, "updateTime": { "description": "Output only. The last update timestamp of an inspectTemplate.", "format": "google-datetime", + "readOnly": true, "type": "string" } }, "type": "object" }, "GooglePrivacyDlpV2InspectionRule": { - "description": "A single inspection rule to be applied to infoTypes, specified in\n`InspectionRuleSet`.", + "description": "A single inspection rule to be applied to infoTypes, specified in `InspectionRuleSet`.", "id": "GooglePrivacyDlpV2InspectionRule", "properties": { "exclusionRule": { @@ -5284,7 +5321,7 @@ "type": "object" }, "GooglePrivacyDlpV2InspectionRuleSet": { - "description": "Rule set for modifying a set of infoTypes to alter behavior under certain\ncircumstances, depending on the specific details of the rules within the set.", + "description": "Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set.", "id": "GooglePrivacyDlpV2InspectionRuleSet", "properties": { "infoTypes": { @@ -5305,18 +5342,19 @@ "type": "object" }, "GooglePrivacyDlpV2JobNotificationEmails": { - "description": "Enable email notification to project owners and editors on jobs's\ncompletion/failure.", + "description": "Enable email notification to project owners and editors on jobs's completion/failure.", "id": "GooglePrivacyDlpV2JobNotificationEmails", "properties": {}, "type": "object" }, "GooglePrivacyDlpV2JobTrigger": { - "description": "Contains a configuration to make dlp api calls on a repeating basis.\nSee https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.", + "description": "Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.", "id": "GooglePrivacyDlpV2JobTrigger", "properties": { "createTime": { "description": "Output only. The creation timestamp of a triggeredJob.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "description": { @@ -5328,10 +5366,11 @@ "type": "string" }, "errors": { - "description": "Output only. A stream of errors encountered when the trigger was activated. Repeated\nerrors may result in the JobTrigger automatically being paused.\nWill return the last 100 errors. Whenever the JobTrigger is modified\nthis list will be cleared.", + "description": "Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.", "items": { "$ref": "GooglePrivacyDlpV2Error" }, + "readOnly": true, "type": "array" }, "inspectJob": { @@ -5341,10 +5380,11 @@ "lastRunTime": { "description": "Output only. The timestamp of the last time this trigger executed.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "name": { - "description": "Unique resource name for the triggeredJob, assigned by the service when the\ntriggeredJob is created, for example\n`projects/dlp-test-project/jobTriggers/53234423`.", + "description": "Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`.", "type": "string" }, "status": { @@ -5364,7 +5404,7 @@ "type": "string" }, "triggers": { - "description": "A list of triggers which will be OR'ed together. Only one in the list\nneeds to trigger for a job to be started. The list may contain only\na single Schedule trigger and must have at least one object.", + "description": "A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.", "items": { "$ref": "GooglePrivacyDlpV2Trigger" }, @@ -5373,6 +5413,7 @@ "updateTime": { "description": "Output only. The last update timestamp of a triggeredJob.", "format": "google-datetime", + "readOnly": true, "type": "string" } }, @@ -5384,10 +5425,10 @@ "properties": { "entityId": { "$ref": "GooglePrivacyDlpV2EntityId", - "description": "Message indicating that multiple rows might be associated to a\nsingle individual. If the same entity_id is associated to multiple\nquasi-identifier tuples over distinct rows, we consider the entire\ncollection of tuples as the composite quasi-identifier. This collection\nis a multiset: the order in which the different tuples appear in the\ndataset is ignored, but their frequency is taken into account.\n\nImportant note: a maximum of 1000 rows can be associated to a single\nentity ID. If more rows are associated with the same entity ID, some\nmight be ignored." + "description": "Message indicating that multiple rows might be associated to a single individual. If the same entity_id is associated to multiple quasi-identifier tuples over distinct rows, we consider the entire collection of tuples as the composite quasi-identifier. This collection is a multiset: the order in which the different tuples appear in the dataset is ignored, but their frequency is taken into account. Important note: a maximum of 1000 rows can be associated to a single entity ID. If more rows are associated with the same entity ID, some might be ignored." }, "quasiIds": { - "description": "Set of fields to compute k-anonymity over. When multiple fields are\nspecified, they are considered a single composite key. Structs and\nrepeated data types are not supported; however, nested fields are\nsupported so long as they are not structs themselves or nested within\na repeated field.", + "description": "Set of fields to compute k-anonymity over. When multiple fields are specified, they are considered a single composite key. Structs and repeated data types are not supported; however, nested fields are supported so long as they are not structs themselves or nested within a repeated field.", "items": { "$ref": "GooglePrivacyDlpV2FieldId" }, @@ -5401,12 +5442,12 @@ "id": "GooglePrivacyDlpV2KAnonymityEquivalenceClass", "properties": { "equivalenceClassSize": { - "description": "Size of the equivalence class, for example number of rows with the\nabove set of values.", + "description": "Size of the equivalence class, for example number of rows with the above set of values.", "format": "int64", "type": "string" }, "quasiIdsValues": { - "description": "Set of values defining the equivalence class. One value per\nquasi-identifier column in the original KAnonymity metric message.\nThe order is always the same as the original request.", + "description": "Set of values defining the equivalence class. One value per quasi-identifier column in the original KAnonymity metric message. The order is always the same as the original request.", "items": { "$ref": "GooglePrivacyDlpV2Value" }, @@ -5430,7 +5471,7 @@ "type": "string" }, "bucketValues": { - "description": "Sample of equivalence classes in this bucket. The total number of\nclasses returned per bucket is capped at 20.", + "description": "Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20.", "items": { "$ref": "GooglePrivacyDlpV2KAnonymityEquivalenceClass" }, @@ -5464,32 +5505,32 @@ "type": "object" }, "GooglePrivacyDlpV2KMapEstimationConfig": { - "description": "Reidentifiability metric. This corresponds to a risk model similar to what\nis called \"journalist risk\" in the literature, except the attack dataset is\nstatistically modeled instead of being perfectly known. This can be done\nusing publicly available data (like the US Census), or using a custom\nstatistical model (indicated as one or several BigQuery tables), or by\nextrapolating from the distribution of values in the input dataset.", + "description": "Reidentifiability metric. This corresponds to a risk model similar to what is called \"journalist risk\" in the literature, except the attack dataset is statistically modeled instead of being perfectly known. This can be done using publicly available data (like the US Census), or using a custom statistical model (indicated as one or several BigQuery tables), or by extrapolating from the distribution of values in the input dataset.", "id": "GooglePrivacyDlpV2KMapEstimationConfig", "properties": { "auxiliaryTables": { - "description": "Several auxiliary tables can be used in the analysis. Each custom_tag\nused to tag a quasi-identifiers column must appear in exactly one column\nof one auxiliary table.", + "description": "Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers column must appear in exactly one column of one auxiliary table.", "items": { "$ref": "GooglePrivacyDlpV2AuxiliaryTable" }, "type": "array" }, "quasiIds": { - "description": "Required. Fields considered to be quasi-identifiers. No two columns can have the\nsame tag.", + "description": "Required. Fields considered to be quasi-identifiers. No two columns can have the same tag.", "items": { "$ref": "GooglePrivacyDlpV2TaggedField" }, "type": "array" }, "regionCode": { - "description": "ISO 3166-1 alpha-2 region code to use in the statistical modeling.\nSet if no column is tagged with a region-specific InfoType (like\nUS_ZIP_5) or a region code.", + "description": "ISO 3166-1 alpha-2 region code to use in the statistical modeling. Set if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code.", "type": "string" } }, "type": "object" }, "GooglePrivacyDlpV2KMapEstimationHistogramBucket": { - "description": "A KMapEstimationHistogramBucket message with the following values:\n min_anonymity: 3\n max_anonymity: 5\n frequency: 42\nmeans that there are 42 records whose quasi-identifier values correspond\nto 3, 4 or 5 people in the overlying population. An important particular\ncase is when min_anonymity = max_anonymity = 1: the frequency field then\ncorresponds to the number of uniquely identifiable records.", + "description": "A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records.", "id": "GooglePrivacyDlpV2KMapEstimationHistogramBucket", "properties": { "bucketSize": { @@ -5503,7 +5544,7 @@ "type": "string" }, "bucketValues": { - "description": "Sample of quasi-identifier tuple values in this bucket. The total\nnumber of classes returned per bucket is capped at 20.", + "description": "Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20.", "items": { "$ref": "GooglePrivacyDlpV2KMapEstimationQuasiIdValues" }, @@ -5542,11 +5583,11 @@ "type": "object" }, "GooglePrivacyDlpV2KMapEstimationResult": { - "description": "Result of the reidentifiability analysis. Note that these results are an\nestimation, not exact values.", + "description": "Result of the reidentifiability analysis. Note that these results are an estimation, not exact values.", "id": "GooglePrivacyDlpV2KMapEstimationResult", "properties": { "kMapEstimationHistogram": { - "description": "The intervals [min_anonymity, max_anonymity] do not overlap. If a value\ndoesn't correspond to any such interval, the associated frequency is\nzero. For example, the following records:\n {min_anonymity: 1, max_anonymity: 1, frequency: 17}\n {min_anonymity: 2, max_anonymity: 3, frequency: 42}\n {min_anonymity: 5, max_anonymity: 10, frequency: 99}\nmean that there are no record with an estimated anonymity of 4, 5, or\nlarger than 10.", + "description": "The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10.", "items": { "$ref": "GooglePrivacyDlpV2KMapEstimationHistogramBucket" }, @@ -5556,15 +5597,15 @@ "type": "object" }, "GooglePrivacyDlpV2Key": { - "description": "A unique identifier for a Datastore entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.", + "description": "A unique identifier for a Datastore entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.", "id": "GooglePrivacyDlpV2Key", "properties": { "partitionId": { "$ref": "GooglePrivacyDlpV2PartitionId", - "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition." + "description": "Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition." }, "path": { - "description": "The entity path.\nAn entity path consists of one or more elements composed of a kind and a\nstring or numerical identifier, which identify entities. The first\nelement identifies a _root entity_, the second element identifies\na _child_ of the root entity, the third element identifies a child of the\nsecond entity, and so forth. The entities identified by all prefixes of\nthe path are called the element's _ancestors_.\n\nA path can never be empty, and a path can have at most 100 elements.", + "description": "The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. A path can never be empty, and a path can have at most 100 elements.", "items": { "$ref": "GooglePrivacyDlpV2PathElement" }, @@ -5585,7 +5626,7 @@ "type": "object" }, "GooglePrivacyDlpV2KmsWrappedCryptoKey": { - "description": "Include to use an existing data crypto key wrapped by KMS.\nThe wrapped key must be a 128/192/256 bit key.\nAuthorization requires the following IAM permissions when sending a request\nto perform a crypto transformation using a kms-wrapped crypto key:\ndlp.kms.encrypt", + "description": "Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128/192/256 bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a kms-wrapped crypto key: dlp.kms.encrypt", "id": "GooglePrivacyDlpV2KmsWrappedCryptoKey", "properties": { "cryptoKeyName": { @@ -5605,7 +5646,7 @@ "id": "GooglePrivacyDlpV2LDiversityConfig", "properties": { "quasiIds": { - "description": "Set of quasi-identifiers indicating how equivalence classes are\ndefined for the l-diversity computation. When multiple fields are\nspecified, they are considered a single composite key.", + "description": "Set of quasi-identifiers indicating how equivalence classes are defined for the l-diversity computation. When multiple fields are specified, they are considered a single composite key.", "items": { "$ref": "GooglePrivacyDlpV2FieldId" }, @@ -5633,7 +5674,7 @@ "type": "string" }, "quasiIdsValues": { - "description": "Quasi-identifier values defining the k-anonymity equivalence\nclass. The order is always the same as the original request.", + "description": "Quasi-identifier values defining the k-anonymity equivalence class. The order is always the same as the original request.", "items": { "$ref": "GooglePrivacyDlpV2Value" }, @@ -5664,19 +5705,19 @@ "type": "string" }, "bucketValues": { - "description": "Sample of equivalence classes in this bucket. The total number of\nclasses returned per bucket is capped at 20.", + "description": "Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20.", "items": { "$ref": "GooglePrivacyDlpV2LDiversityEquivalenceClass" }, "type": "array" }, "sensitiveValueFrequencyLowerBound": { - "description": "Lower bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.", + "description": "Lower bound on the sensitive value frequencies of the equivalence classes in this bucket.", "format": "int64", "type": "string" }, "sensitiveValueFrequencyUpperBound": { - "description": "Upper bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.", + "description": "Upper bound on the sensitive value frequencies of the equivalence classes in this bucket.", "format": "int64", "type": "string" } @@ -5698,7 +5739,7 @@ "type": "object" }, "GooglePrivacyDlpV2LargeCustomDictionaryConfig": { - "description": "Configuration for a custom dictionary created from a data source of any size\nup to the maximum size defined in the\n[limits](https://cloud.google.com/dlp/limits) page. The artifacts of\ndictionary creation are stored in the specified Google Cloud Storage\nlocation. Consider using `CustomInfoType.Dictionary` for smaller dictionaries\nthat satisfy the size requirements.", + "description": "Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/dlp/limits) page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements.", "id": "GooglePrivacyDlpV2LargeCustomDictionaryConfig", "properties": { "bigQueryField": { @@ -5711,7 +5752,7 @@ }, "outputPath": { "$ref": "GooglePrivacyDlpV2CloudStoragePath", - "description": "Location to store dictionary artifacts in Google Cloud Storage. These files\nwill only be accessible by project owners and the DLP API. If any of these\nartifacts are modified, the dictionary is considered invalid and can no\nlonger be used." + "description": "Location to store dictionary artifacts in Google Cloud Storage. These files will only be accessible by project owners and the DLP API. If any of these artifacts are modified, the dictionary is considered invalid and can no longer be used." } }, "type": "object" @@ -5729,13 +5770,13 @@ "type": "object" }, "GooglePrivacyDlpV2LeaveUntransformed": { - "description": "Skips the data without modifying it if the requested transformation would\ncause an error. For example, if a `DateShift` transformation were applied\nan an IP address, this mode would leave the IP address unchanged in the\nresponse.", + "description": "Skips the data without modifying it if the requested transformation would cause an error. For example, if a `DateShift` transformation were applied an an IP address, this mode would leave the IP address unchanged in the response.", "id": "GooglePrivacyDlpV2LeaveUntransformed", "properties": {}, "type": "object" }, "GooglePrivacyDlpV2LikelihoodAdjustment": { - "description": "Message for specifying an adjustment to the likelihood of a finding as\npart of a detection rule.", + "description": "Message for specifying an adjustment to the likelihood of a finding as part of a detection rule.", "id": "GooglePrivacyDlpV2LikelihoodAdjustment", "properties": { "fixedLikelihood": { @@ -5759,7 +5800,7 @@ "type": "string" }, "relativeLikelihood": { - "description": "Increase or decrease the likelihood by the specified number of\nlevels. For example, if a finding would be `POSSIBLE` without the\ndetection rule and `relative_likelihood` is 1, then it is upgraded to\n`LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.\nLikelihood may never drop below `VERY_UNLIKELY` or exceed\n`VERY_LIKELY`, so applying an adjustment of 1 followed by an\nadjustment of -1 when base likelihood is `VERY_LIKELY` will result in\na final likelihood of `LIKELY`.", + "description": "Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.", "format": "int32", "type": "integer" } @@ -5771,14 +5812,14 @@ "id": "GooglePrivacyDlpV2ListDeidentifyTemplatesResponse", "properties": { "deidentifyTemplates": { - "description": "List of deidentify templates, up to page_size in\nListDeidentifyTemplatesRequest.", + "description": "List of deidentify templates, up to page_size in ListDeidentifyTemplatesRequest.", "items": { "$ref": "GooglePrivacyDlpV2DeidentifyTemplate" }, "type": "array" }, "nextPageToken": { - "description": "If the next page is available then the next page token to be used\nin following ListDeidentifyTemplates request.", + "description": "If the next page is available then the next page token to be used in following ListDeidentifyTemplates request.", "type": "string" } }, @@ -5828,7 +5869,7 @@ "type": "array" }, "nextPageToken": { - "description": "If the next page is available then the next page token to be used\nin following ListInspectTemplates request.", + "description": "If the next page is available then the next page token to be used in following ListInspectTemplates request.", "type": "string" } }, @@ -5846,7 +5887,7 @@ "type": "array" }, "nextPageToken": { - "description": "If the next page is available then the next page token to be used\nin following ListJobTriggers request.", + "description": "If the next page is available then the next page token to be used in following ListJobTriggers request.", "type": "string" } }, @@ -5857,7 +5898,7 @@ "id": "GooglePrivacyDlpV2ListStoredInfoTypesResponse", "properties": { "nextPageToken": { - "description": "If the next page is available then the next page token to be used\nin following ListStoredInfoTypes request.", + "description": "If the next page is available then the next page token to be used in following ListStoredInfoTypes request.", "type": "string" }, "storedInfoTypes": { @@ -5876,18 +5917,18 @@ "properties": { "byteRange": { "$ref": "GooglePrivacyDlpV2Range", - "description": "Zero-based byte offsets delimiting the finding.\nThese are relative to the finding's containing element.\nNote that when the content is not textual, this references\nthe UTF-8 encoded textual representation of the content.\nOmitted if content is an image." + "description": "Zero-based byte offsets delimiting the finding. These are relative to the finding's containing element. Note that when the content is not textual, this references the UTF-8 encoded textual representation of the content. Omitted if content is an image." }, "codepointRange": { "$ref": "GooglePrivacyDlpV2Range", - "description": "Unicode character offsets delimiting the finding.\nThese are relative to the finding's containing element.\nProvided when the content is text." + "description": "Unicode character offsets delimiting the finding. These are relative to the finding's containing element. Provided when the content is text." }, "container": { "$ref": "GooglePrivacyDlpV2Container", "description": "Information about the container where this finding occurred, if available." }, "contentLocations": { - "description": "List of nested objects pointing to the precise location of the finding\nwithin the file or record.", + "description": "List of nested objects pointing to the precise location of the finding within the file or record.", "items": { "$ref": "GooglePrivacyDlpV2ContentLocation" }, @@ -5897,7 +5938,7 @@ "type": "object" }, "GooglePrivacyDlpV2Manual": { - "description": "Job trigger option for hybrid jobs. Jobs must be manually created\nand finished.", + "description": "Job trigger option for hybrid jobs. Jobs must be manually created and finished.", "id": "GooglePrivacyDlpV2Manual", "properties": {}, "type": "object" @@ -5926,12 +5967,12 @@ "type": "object" }, "GooglePrivacyDlpV2NumericalStatsConfig": { - "description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.", + "description": "Compute numerical stats over an individual column, including min, max, and quantiles.", "id": "GooglePrivacyDlpV2NumericalStatsConfig", "properties": { "field": { "$ref": "GooglePrivacyDlpV2FieldId", - "description": "Field to compute numerical stats on. Supported types are\ninteger, float, date, datetime, timestamp, time." + "description": "Field to compute numerical stats on. Supported types are integer, float, date, datetime, timestamp, time." } }, "type": "object" @@ -5949,7 +5990,7 @@ "description": "Minimum value appearing in the column." }, "quantileValues": { - "description": "List of 99 values that partition the set of field values into 100 equal\nsized buckets.", + "description": "List of 99 values that partition the set of field values into 100 equal sized buckets.", "items": { "$ref": "GooglePrivacyDlpV2Value" }, @@ -5963,7 +6004,7 @@ "id": "GooglePrivacyDlpV2OutputStorageConfig", "properties": { "outputSchema": { - "description": "Schema used for writing the findings for Inspect jobs. This field is only\nused for Inspect and must be unspecified for Risk jobs. Columns are derived\nfrom the `Finding` object. If appending to an existing table, any columns\nfrom the predefined schema that are missing will be added. No columns in\nthe existing table will be deleted.\n\nIf unspecified, then all available columns will be used for a new table or\nan (existing) table with no schema, and no changes will be made to an\nexisting table that has a schema.\nOnly for use with external storage.", + "description": "Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.", "enum": [ "OUTPUT_SCHEMA_UNSPECIFIED", "BASIC_COLUMNS", @@ -5974,7 +6015,7 @@ ], "enumDescriptions": [ "Unused.", - "Basic schema including only `info_type`, `quote`, `certainty`, and\n`timestamp`.", + "Basic schema including only `info_type`, `quote`, `certainty`, and `timestamp`.", "Schema tailored to findings from scanning Google Cloud Storage.", "Schema tailored to findings from scanning Google Datastore.", "Schema tailored to findings from scanning Google BigQuery.", @@ -5984,13 +6025,13 @@ }, "table": { "$ref": "GooglePrivacyDlpV2BigQueryTable", - "description": "Store findings in an existing table or a new table in an existing\ndataset. If table_id is not set a new one will be generated\nfor you with the following format:\ndlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for\ngenerating the date details.\n\nFor Inspect, each column in an existing output table must have the same\nname, type, and mode of a field in the `Finding` object.\n\nFor Risk, an existing output table should be the output of a previous\nRisk analysis job run on the same source table, with the same privacy\nmetric and quasi-identifiers. Risk jobs that analyze the same table but\ncompute a different privacy metric, or use different sets of\nquasi-identifiers, cannot store their results in the same table." + "description": "Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table." } }, "type": "object" }, "GooglePrivacyDlpV2PartitionId": { - "description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.", + "description": "Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID.", "id": "GooglePrivacyDlpV2PartitionId", "properties": { "namespaceId": { @@ -6005,20 +6046,20 @@ "type": "object" }, "GooglePrivacyDlpV2PathElement": { - "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.", + "description": "A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.", "id": "GooglePrivacyDlpV2PathElement", "properties": { "id": { - "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.", + "description": "The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.", "format": "int64", "type": "string" }, "kind": { - "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.", + "description": "The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `\"\"`.", "type": "string" }, "name": { - "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.", + "description": "The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `\"\"`.", "type": "string" } }, @@ -6107,7 +6148,7 @@ "type": "object" }, "GooglePrivacyDlpV2Proximity": { - "description": "Message for specifying a window around a finding to apply a detection\nrule.", + "description": "Message for specifying a window around a finding to apply a detection rule.", "id": "GooglePrivacyDlpV2Proximity", "properties": { "windowAfter": { @@ -6124,30 +6165,30 @@ "type": "object" }, "GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog": { - "description": "Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the\nresults of the DlpJob will be applied to the entry for the resource scanned\nin Cloud Data Catalog. Any labels previously written by another DlpJob will\nbe deleted. InfoType naming patterns are strictly enforced when using this\nfeature. Note that the findings will be persisted in Cloud Data Catalog\nstorage and are governed by Data Catalog service-specific policy, see\nhttps://cloud.google.com/terms/service-terms\nOnly a single instance of this action can be specified and only allowed if\nall resources being scanned are BigQuery tables.\nCompatible with: Inspect", + "description": "Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the results of the DlpJob will be applied to the entry for the resource scanned in Cloud Data Catalog. Any labels previously written by another DlpJob will be deleted. InfoType naming patterns are strictly enforced when using this feature. Note that the findings will be persisted in Cloud Data Catalog storage and are governed by Data Catalog service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified and only allowed if all resources being scanned are BigQuery tables. Compatible with: Inspect", "id": "GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog", "properties": {}, "type": "object" }, "GooglePrivacyDlpV2PublishSummaryToCscc": { - "description": "Publish the result summary of a DlpJob to the Cloud Security\nCommand Center (CSCC Alpha).\nThis action is only available for projects which are parts of\nan organization and whitelisted for the alpha Cloud Security Command\nCenter.\nThe action will publish count of finding instances and their info types.\nThe summary of findings will be persisted in CSCC and are governed by CSCC\nservice-specific policy, see https://cloud.google.com/terms/service-terms\nOnly a single instance of this action can be specified.\nCompatible with: Inspect", + "description": "Publish the result summary of a DlpJob to the Cloud Security Command Center (CSCC Alpha). This action is only available for projects which are parts of an organization and whitelisted for the alpha Cloud Security Command Center. The action will publish count of finding instances and their info types. The summary of findings will be persisted in CSCC and are governed by CSCC service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified. Compatible with: Inspect", "id": "GooglePrivacyDlpV2PublishSummaryToCscc", "properties": {}, "type": "object" }, "GooglePrivacyDlpV2PublishToPubSub": { - "description": "Publish a message into given Pub/Sub topic when DlpJob has completed. The\nmessage contains a single field, `DlpJobName`, which is equal to the\nfinished job's\n[`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob).\nCompatible with: Inspect, Risk", + "description": "Publish a message into given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk", "id": "GooglePrivacyDlpV2PublishToPubSub", "properties": { "topic": { - "description": "Cloud Pub/Sub topic to send notifications to. The topic must have given\npublishing access rights to the DLP API service account executing\nthe long running DlpJob sending the notifications.\nFormat is projects/{project}/topics/{topic}.", + "description": "Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}.", "type": "string" } }, "type": "object" }, "GooglePrivacyDlpV2PublishToStackdriver": { - "description": "Enable Stackdriver metric dlp.googleapis.com/finding_count. This\nwill publish a metric to stack driver on each infotype requested and\nhow many findings were found for it. CustomDetectors will be bucketed\nas 'Custom' under the Stackdriver label 'info_type'.", + "description": "Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'.", "id": "GooglePrivacyDlpV2PublishToStackdriver", "properties": {}, "type": "object" @@ -6157,7 +6198,7 @@ "id": "GooglePrivacyDlpV2QuasiId", "properties": { "customTag": { - "description": "A column can be tagged with a custom tag. In this case, the user must\nindicate an auxiliary table that contains statistical information on\nthe possible values of this column (below).", + "description": "A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below).", "type": "string" }, "field": { @@ -6166,17 +6207,17 @@ }, "inferred": { "$ref": "GoogleProtobufEmpty", - "description": "If no semantic tag is indicated, we infer the statistical model from\nthe distribution of values in the input data" + "description": "If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data" }, "infoType": { "$ref": "GooglePrivacyDlpV2InfoType", - "description": "A column can be tagged with a InfoType to use the relevant public\ndataset as a statistical model of population, if available. We\ncurrently support US ZIP codes, region codes, ages and genders.\nTo programmatically obtain the list of supported InfoTypes, use\nListInfoTypes with the supported_by=RISK_ANALYSIS filter." + "description": "A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter." } }, "type": "object" }, "GooglePrivacyDlpV2QuasiIdField": { - "description": "A quasi-identifier column has a custom_tag, used to know which column\nin the data corresponds to which column in the statistical model.", + "description": "A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.", "id": "GooglePrivacyDlpV2QuasiIdField", "properties": { "customTag": { @@ -6191,11 +6232,11 @@ "type": "object" }, "GooglePrivacyDlpV2QuasiIdentifierField": { - "description": "A quasi-identifier column has a custom_tag, used to know which column\nin the data corresponds to which column in the statistical model.", + "description": "A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.", "id": "GooglePrivacyDlpV2QuasiIdentifierField", "properties": { "customTag": { - "description": "A column can be tagged with a custom tag. In this case, the user must\nindicate an auxiliary table that contains statistical information on\nthe possible values of this column (below).", + "description": "A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below).", "type": "string" }, "field": { @@ -6234,7 +6275,7 @@ "type": "object" }, "GooglePrivacyDlpV2RecordCondition": { - "description": "A condition for determining whether a transformation should be applied to\na field.", + "description": "A condition for determining whether a transformation should be applied to a field.", "id": "GooglePrivacyDlpV2RecordCondition", "properties": { "expressions": { @@ -6255,7 +6296,7 @@ "$ref": "GooglePrivacyDlpV2DatastoreKey" }, "idValues": { - "description": "Values of identifying columns in the given row. Order of values matches\nthe order of `identifying_fields` specified in the scanning request.", + "description": "Values of identifying columns in the given row. Order of values matches the order of `identifying_fields` specified in the scanning request.", "items": { "type": "string" }, @@ -6284,18 +6325,18 @@ "type": "object" }, "GooglePrivacyDlpV2RecordSuppression": { - "description": "Configuration to suppress records whose suppression conditions evaluate to\ntrue.", + "description": "Configuration to suppress records whose suppression conditions evaluate to true.", "id": "GooglePrivacyDlpV2RecordSuppression", "properties": { "condition": { "$ref": "GooglePrivacyDlpV2RecordCondition", - "description": "A condition that when it evaluates to true will result in the record being\nevaluated to be suppressed from the transformed content." + "description": "A condition that when it evaluates to true will result in the record being evaluated to be suppressed from the transformed content." } }, "type": "object" }, "GooglePrivacyDlpV2RecordTransformations": { - "description": "A type of transformation that is applied over structured data such as a\ntable.", + "description": "A type of transformation that is applied over structured data such as a table.", "id": "GooglePrivacyDlpV2RecordTransformations", "properties": { "fieldTransformations": { @@ -6306,7 +6347,7 @@ "type": "array" }, "recordSuppressions": { - "description": "Configuration defining which records get suppressed entirely. Records that\nmatch any suppression rule are omitted from the output.", + "description": "Configuration defining which records get suppressed entirely. Records that match any suppression rule are omitted from the output.", "items": { "$ref": "GooglePrivacyDlpV2RecordSuppression" }, @@ -6316,13 +6357,13 @@ "type": "object" }, "GooglePrivacyDlpV2RedactConfig": { - "description": "Redact a given value. For example, if used with an `InfoTypeTransformation`\ntransforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the\noutput would be 'My phone number is '.", + "description": "Redact a given value. For example, if used with an `InfoTypeTransformation` transforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the output would be 'My phone number is '.", "id": "GooglePrivacyDlpV2RedactConfig", "properties": {}, "type": "object" }, "GooglePrivacyDlpV2RedactImageRequest": { - "description": "Request to search for potentially sensitive info in an image and redact it\nby covering it with a colored rectangle.", + "description": "Request to search for potentially sensitive info in an image and redact it by covering it with a colored rectangle.", "id": "GooglePrivacyDlpV2RedactImageRequest", "properties": { "byteItem": { @@ -6337,7 +6378,7 @@ "type": "array" }, "includeFindings": { - "description": "Whether the response should include findings along with the redacted\nimage.", + "description": "Whether the response should include findings along with the redacted image.", "type": "boolean" }, "inspectConfig": { @@ -6356,7 +6397,7 @@ "id": "GooglePrivacyDlpV2RedactImageResponse", "properties": { "extractedText": { - "description": "If an image was being inspected and the InspectConfig's include_quote was\nset to true, then this field will include all text, if any, that was found\nin the image.", + "description": "If an image was being inspected and the InspectConfig's include_quote was set to true, then this field will include all text, if any, that was found in the image.", "type": "string" }, "inspectResult": { @@ -6376,7 +6417,7 @@ "id": "GooglePrivacyDlpV2Regex", "properties": { "groupIndexes": { - "description": "The index of the submatch to extract as findings. When not\nspecified, the entire match is returned. No more than 3 may be included.", + "description": "The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.", "items": { "format": "int32", "type": "integer" @@ -6384,7 +6425,7 @@ "type": "array" }, "pattern": { - "description": "Pattern defining the regular expression. Its syntax\n(https://github.com/google/re2/wiki/Syntax) can be found under the\ngoogle/re2 repository on GitHub.", + "description": "Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.", "type": "string" } }, @@ -6399,7 +6440,7 @@ "description": "Configuration for the inspector." }, "inspectTemplateName": { - "description": "Template to use. Any configuration directly specified in\n`inspect_config` will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.", + "description": "Template to use. Any configuration directly specified in `inspect_config` will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.", "type": "string" }, "item": { @@ -6412,10 +6453,10 @@ }, "reidentifyConfig": { "$ref": "GooglePrivacyDlpV2DeidentifyConfig", - "description": "Configuration for the re-identification of the content item.\nThis field shares the same proto message type that is used for\nde-identification, however its usage here is for the reversal of the\nprevious de-identification. Re-identification is performed by examining\nthe transformations used to de-identify the items and executing the\nreverse. This requires that only reversible transformations\nbe provided here. The reversible transformations are:\n\n - `CryptoDeterministicConfig`\n - `CryptoReplaceFfxFpeConfig`" + "description": "Configuration for the re-identification of the content item. This field shares the same proto message type that is used for de-identification, however its usage here is for the reversal of the previous de-identification. Re-identification is performed by examining the transformations used to de-identify the items and executing the reverse. This requires that only reversible transformations be provided here. The reversible transformations are: - `CryptoDeterministicConfig` - `CryptoReplaceFfxFpeConfig`" }, "reidentifyTemplateName": { - "description": "Template to use. References an instance of `DeidentifyTemplate`.\nAny configuration directly specified in `reidentify_config` or\n`inspect_config` will override those set in the template. The\n`DeidentifyTemplate` used must include only reversible transformations.\nSingular fields that are set in this request will replace their\ncorresponding fields in the template. Repeated fields are appended.\nSingular sub-messages and groups are recursively merged.", + "description": "Template to use. References an instance of `DeidentifyTemplate`. Any configuration directly specified in `reidentify_config` or `inspect_config` will override those set in the template. The `DeidentifyTemplate` used must include only reversible transformations. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.", "type": "string" } }, @@ -6463,7 +6504,7 @@ }, "snapshotInspectTemplate": { "$ref": "GooglePrivacyDlpV2InspectTemplate", - "description": "If run with an InspectTemplate, a snapshot of its state at the time of\nthis run." + "description": "If run with an InspectTemplate, a snapshot of its state at the time of this run." } }, "type": "object" @@ -6474,10 +6515,10 @@ "properties": { "hybridStats": { "$ref": "GooglePrivacyDlpV2HybridInspectStatistics", - "description": "Statistics related to the processing of hybrid inspect.\nEarly access feature is in a pre-release state and might change or have\nlimited support. For more information, see\nhttps://cloud.google.com/products#product-launch-stages." + "description": "Statistics related to the processing of hybrid inspect. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages." }, "infoTypeStats": { - "description": "Statistics of how many instances of each info type were found during\ninspect job.", + "description": "Statistics of how many instances of each info type were found during inspect job.", "items": { "$ref": "GooglePrivacyDlpV2InfoTypeStats" }, @@ -6497,11 +6538,11 @@ "type": "object" }, "GooglePrivacyDlpV2RiskAnalysisJobConfig": { - "description": "Configuration for a risk analysis job. See\nhttps://cloud.google.com/dlp/docs/concepts-risk-analysis to learn more.", + "description": "Configuration for a risk analysis job. See https://cloud.google.com/dlp/docs/concepts-risk-analysis to learn more.", "id": "GooglePrivacyDlpV2RiskAnalysisJobConfig", "properties": { "actions": { - "description": "Actions to execute at the completion of the job. Are executed in the order\nprovided.", + "description": "Actions to execute at the completion of the job. Are executed in the order provided.", "items": { "$ref": "GooglePrivacyDlpV2Action" }, @@ -6533,7 +6574,7 @@ "type": "object" }, "GooglePrivacyDlpV2SaveFindings": { - "description": "If set, the detailed findings will be persisted to the specified\nOutputStorageConfig. Only a single instance of this action can be\nspecified.\nCompatible with: Inspect, Risk", + "description": "If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk", "id": "GooglePrivacyDlpV2SaveFindings", "properties": { "outputConfig": { @@ -6548,7 +6589,7 @@ "id": "GooglePrivacyDlpV2Schedule", "properties": { "recurrencePeriodDuration": { - "description": "With this option a job is started a regular periodic basis. For\nexample: every day (86400 seconds).\n\nA scheduled start time will be skipped if the previous\nexecution has not ended when its scheduled time occurs.\n\nThis value must be set to a time duration greater than or equal\nto 1 day and can be no longer than 60 days.", + "description": "With this option a job is started a regular periodic basis. For example: every day (86400 seconds). A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days.", "format": "google-duration", "type": "string" } @@ -6556,7 +6597,7 @@ "type": "object" }, "GooglePrivacyDlpV2StatisticalTable": { - "description": "An auxiliary table containing statistical information on the relative\nfrequency of different quasi-identifiers values. It has one or several\nquasi-identifiers columns, and one column that indicates the relative\nfrequency of each quasi-identifier tuple.\nIf a tuple is present in the data but not in the auxiliary table, the\ncorresponding relative frequency is assumed to be zero (and thus, the\ntuple is highly reidentifiable).", + "description": "An auxiliary table containing statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple. If a tuple is present in the data but not in the auxiliary table, the corresponding relative frequency is assumed to be zero (and thus, the tuple is highly reidentifiable).", "id": "GooglePrivacyDlpV2StatisticalTable", "properties": { "quasiIds": { @@ -6568,7 +6609,7 @@ }, "relativeFrequency": { "$ref": "GooglePrivacyDlpV2FieldId", - "description": "Required. The relative frequency column must contain a floating-point number\nbetween 0 and 1 (inclusive). Null values are assumed to be zero." + "description": "Required. The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero." }, "table": { "$ref": "GooglePrivacyDlpV2BigQueryTable", @@ -6595,7 +6636,7 @@ }, "hybridOptions": { "$ref": "GooglePrivacyDlpV2HybridOptions", - "description": "Hybrid inspection options.\nEarly access feature is in a pre-release state and might change or have\nlimited support. For more information, see\nhttps://cloud.google.com/products#product-launch-stages." + "description": "Hybrid inspection options. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages." }, "timespanConfig": { "$ref": "GooglePrivacyDlpV2TimespanConfig" @@ -6614,7 +6655,7 @@ "type": "object" }, "GooglePrivacyDlpV2StoredInfoType": { - "description": "StoredInfoType resource message that contains information about the current\nversion and any pending updates.", + "description": "StoredInfoType resource message that contains information about the current version and any pending updates.", "id": "GooglePrivacyDlpV2StoredInfoType", "properties": { "currentVersion": { @@ -6626,7 +6667,7 @@ "type": "string" }, "pendingVersions": { - "description": "Pending versions of the stored info type. Empty if no versions are\npending.", + "description": "Pending versions of the stored info type. Empty if no versions are pending.", "items": { "$ref": "GooglePrivacyDlpV2StoredInfoTypeVersion" }, @@ -6636,7 +6677,7 @@ "type": "object" }, "GooglePrivacyDlpV2StoredInfoTypeConfig": { - "description": "Configuration for stored infoTypes. All fields and subfield are provided\nby the user. For more information, see\nhttps://cloud.google.com/dlp/docs/creating-custom-infotypes.", + "description": "Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes.", "id": "GooglePrivacyDlpV2StoredInfoTypeConfig", "properties": { "description": { @@ -6674,7 +6715,7 @@ "type": "object" }, "GooglePrivacyDlpV2StoredInfoTypeVersion": { - "description": "Version of a StoredInfoType, including the configuration used to build it,\ncreate timestamp, and current state.", + "description": "Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state.", "id": "GooglePrivacyDlpV2StoredInfoTypeVersion", "properties": { "config": { @@ -6682,19 +6723,19 @@ "description": "StoredInfoType configuration." }, "createTime": { - "description": "Create timestamp of the version. Read-only, determined by the system\nwhen the version is created.", + "description": "Create timestamp of the version. Read-only, determined by the system when the version is created.", "format": "google-datetime", "type": "string" }, "errors": { - "description": "Errors that occurred when creating this storedInfoType version, or\nanomalies detected in the storedInfoType data that render it unusable. Only\nthe five most recent errors will be displayed, with the most recent error\nappearing first.\n\nFor example, some of the data for stored custom dictionaries is put in\nthe user's Google Cloud Storage bucket, and if this data is modified or\ndeleted by the user or another system, the dictionary becomes invalid.\n\nIf any errors occur, fix the problem indicated by the error message and\nuse the UpdateStoredInfoType API method to create another version of the\nstoredInfoType to continue using it, reusing the same `config` if it was\nnot the source of the error.", + "description": "Errors that occurred when creating this storedInfoType version, or anomalies detected in the storedInfoType data that render it unusable. Only the five most recent errors will be displayed, with the most recent error appearing first. For example, some of the data for stored custom dictionaries is put in the user's Google Cloud Storage bucket, and if this data is modified or deleted by the user or another system, the dictionary becomes invalid. If any errors occur, fix the problem indicated by the error message and use the UpdateStoredInfoType API method to create another version of the storedInfoType to continue using it, reusing the same `config` if it was not the source of the error.", "items": { "$ref": "GooglePrivacyDlpV2Error" }, "type": "array" }, "state": { - "description": "Stored info type version state. Read-only, updated by the system\nduring dictionary creation.", + "description": "Stored info type version state. Read-only, updated by the system during dictionary creation.", "enum": [ "STORED_INFO_TYPE_STATE_UNSPECIFIED", "PENDING", @@ -6706,8 +6747,8 @@ "Unused", "StoredInfoType version is being created.", "StoredInfoType version is ready for use.", - "StoredInfoType creation failed. All relevant error messages are returned in\nthe `StoredInfoTypeVersion` message.", - "StoredInfoType is no longer valid because artifacts stored in\nuser-controlled storage were modified. To fix an invalid StoredInfoType,\nuse the `UpdateStoredInfoType` method to create a new version." + "StoredInfoType creation failed. All relevant error messages are returned in the `StoredInfoTypeVersion` message.", + "StoredInfoType is no longer valid because artifacts stored in user-controlled storage were modified. To fix an invalid StoredInfoType, use the `UpdateStoredInfoType` method to create a new version." ], "type": "string" }, @@ -6723,19 +6764,19 @@ "id": "GooglePrivacyDlpV2StoredType", "properties": { "createTime": { - "description": "Timestamp indicating when the version of the `StoredInfoType` used for\ninspection was created. Output-only field, populated by the system.", + "description": "Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system.", "format": "google-datetime", "type": "string" }, "name": { - "description": "Resource name of the requested `StoredInfoType`, for example\n`organizations/433245324/storedInfoTypes/432452342` or\n`projects/project-id/storedInfoTypes/432452342`.", + "description": "Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`.", "type": "string" } }, "type": "object" }, "GooglePrivacyDlpV2SummaryResult": { - "description": "A collection that informs the user the number of times a particular\n`TransformationResultCode` and error details occurred.", + "description": "A collection that informs the user the number of times a particular `TransformationResultCode` and error details occurred.", "id": "GooglePrivacyDlpV2SummaryResult", "properties": { "code": { @@ -6758,20 +6799,20 @@ "type": "string" }, "details": { - "description": "A place for warnings or errors to show up if a transformation didn't\nwork as expected.", + "description": "A place for warnings or errors to show up if a transformation didn't work as expected.", "type": "string" } }, "type": "object" }, "GooglePrivacyDlpV2SurrogateType": { - "description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This CustomInfoType does\nnot support the use of `detection_rules`.", + "description": "Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a \"surrogate\" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`.", "id": "GooglePrivacyDlpV2SurrogateType", "properties": {}, "type": "object" }, "GooglePrivacyDlpV2Table": { - "description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed.\nSee https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to\nlearn more.", + "description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more.", "id": "GooglePrivacyDlpV2Table", "properties": { "headers": { @@ -6796,7 +6837,7 @@ "id": "GooglePrivacyDlpV2TableLocation", "properties": { "rowIndex": { - "description": "The zero-based index of the row where the finding is located. Only\npopulated for resources that have a natural ordering, not BigQuery. In\nBigQuery, to identify the row a finding came from, populate\nBigQueryOptions.identifying_fields with your primary key column names and\nwhen you store the findings the value of those columns will be stored\ninside of Finding.", + "description": "The zero-based index of the row where the finding is located. Only populated for resources that have a natural ordering, not BigQuery. In BigQuery, to identify the row a finding came from, populate BigQueryOptions.identifying_fields with your primary key column names and when you store the findings the value of those columns will be stored inside of Finding.", "format": "int64", "type": "string" } @@ -6808,7 +6849,7 @@ "id": "GooglePrivacyDlpV2TableOptions", "properties": { "identifyingFields": { - "description": "The columns that are the primary keys for table objects included in\nContentItem. A copy of this cell's value will stored alongside alongside\neach finding so that the finding can be traced to the specific row it came\nfrom. No more than 3 may be provided.", + "description": "The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided.", "items": { "$ref": "GooglePrivacyDlpV2FieldId" }, @@ -6822,7 +6863,7 @@ "id": "GooglePrivacyDlpV2TaggedField", "properties": { "customTag": { - "description": "A column can be tagged with a custom tag. In this case, the user must\nindicate an auxiliary table that contains statistical information on\nthe possible values of this column (below).", + "description": "A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below).", "type": "string" }, "field": { @@ -6831,11 +6872,11 @@ }, "inferred": { "$ref": "GoogleProtobufEmpty", - "description": "If no semantic tag is indicated, we infer the statistical model from\nthe distribution of values in the input data" + "description": "If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data" }, "infoType": { "$ref": "GooglePrivacyDlpV2InfoType", - "description": "A column can be tagged with a InfoType to use the relevant public\ndataset as a statistical model of population, if available. We\ncurrently support US ZIP codes, region codes, ages and genders.\nTo programmatically obtain the list of supported InfoTypes, use\nListInfoTypes with the supported_by=RISK_ANALYSIS filter." + "description": "A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter." } }, "type": "object" @@ -6847,7 +6888,7 @@ "type": "object" }, "GooglePrivacyDlpV2TimePartConfig": { - "description": "For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a\nportion of the value.", + "description": "For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a portion of the value.", "id": "GooglePrivacyDlpV2TimePartConfig", "properties": { "partToExtract": { @@ -6880,7 +6921,7 @@ "id": "GooglePrivacyDlpV2TimeZone", "properties": { "offsetMinutes": { - "description": "Set only if the offset can be determined. Positive for time ahead of UTC.\nE.g. For \"UTC-9\", this value is -540.", + "description": "Set only if the offset can be determined. Positive for time ahead of UTC. E.g. For \"UTC-9\", this value is -540.", "format": "int32", "type": "integer" } @@ -6888,15 +6929,15 @@ "type": "object" }, "GooglePrivacyDlpV2TimespanConfig": { - "description": "Configuration of the timespan of the items to include in scanning.\nCurrently only supported when inspecting Google Cloud Storage and BigQuery.", + "description": "Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Google Cloud Storage and BigQuery.", "id": "GooglePrivacyDlpV2TimespanConfig", "properties": { "enableAutoPopulationOfTimespanConfig": { - "description": "When the job is started by a JobTrigger we will automatically figure out\na valid start_time to avoid scanning files that have not been modified\nsince the last time the JobTrigger executed. This will be based on the\ntime of the execution of the last run of the JobTrigger.", + "description": "When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger.", "type": "boolean" }, "endTime": { - "description": "Exclude files or rows newer than this value.\nIf set to zero, no upper time limit is applied.", + "description": "Exclude files or rows newer than this value. If set to zero, no upper time limit is applied.", "format": "google-datetime", "type": "string" }, @@ -6907,13 +6948,13 @@ }, "timestampField": { "$ref": "GooglePrivacyDlpV2FieldId", - "description": "Specification of the field containing the timestamp of scanned items.\nUsed for data sources like Datastore and BigQuery.\n\nFor BigQuery:\nRequired to filter out rows based on the given start and\nend times. If not specified and the table was modified between the given\nstart and end times, the entire table will be scanned.\nThe valid data types of the timestamp field are: `INTEGER`, `DATE`,\n`TIMESTAMP`, or `DATETIME` BigQuery column.\n\nFor Datastore.\nValid data types of the timestamp field are: `TIMESTAMP`.\nDatastore entity will be scanned if the timestamp property does not\nexist or its value is empty or invalid." + "description": "Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: `INTEGER`, `DATE`, `TIMESTAMP`, or `DATETIME` BigQuery column. For Datastore. Valid data types of the timestamp field are: `TIMESTAMP`. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid." } }, "type": "object" }, "GooglePrivacyDlpV2TransformationErrorHandling": { - "description": "How to handle transformation errors during de-identification. A\ntransformation error occurs when the requested transformation is incompatible\nwith the data. For example, trying to de-identify an IP address using a\n`DateShift` transformation would result in a transformation error, since date\ninfo cannot be extracted from an IP address.\nInformation about any incompatible transformations, and how they were\nhandled, is returned in the response as part of the\n`TransformationOverviews`.", + "description": "How to handle transformation errors during de-identification. A transformation error occurs when the requested transformation is incompatible with the data. For example, trying to de-identify an IP address using a `DateShift` transformation would result in a transformation error, since date info cannot be extracted from an IP address. Information about any incompatible transformations, and how they were handled, is returned in the response as part of the `TransformationOverviews`.", "id": "GooglePrivacyDlpV2TransformationErrorHandling", "properties": { "leaveUntransformed": { @@ -6947,7 +6988,7 @@ "type": "object" }, "GooglePrivacyDlpV2TransformationSummary": { - "description": "Summary of a single transformation.\nOnly one of 'transformation', 'field_transformation', or 'record_suppress'\nwill be set.", + "description": "Summary of a single transformation. Only one of 'transformation', 'field_transformation', or 'record_suppress' will be set.", "id": "GooglePrivacyDlpV2TransformationSummary", "properties": { "field": { @@ -6955,7 +6996,7 @@ "description": "Set if the transformation was limited to a specific FieldId." }, "fieldTransformations": { - "description": "The field transformation that was applied.\nIf multiple field transformations are requested for a single field,\nthis list will contain all of them; otherwise, only one is supplied.", + "description": "The field transformation that was applied. If multiple field transformations are requested for a single field, this list will contain all of them; otherwise, only one is supplied.", "items": { "$ref": "GooglePrivacyDlpV2FieldTransformation" }, @@ -6989,11 +7030,11 @@ "type": "object" }, "GooglePrivacyDlpV2TransientCryptoKey": { - "description": "Use this to have a random data crypto key generated.\nIt will be discarded after the request finishes.", + "description": "Use this to have a random data crypto key generated. It will be discarded after the request finishes.", "id": "GooglePrivacyDlpV2TransientCryptoKey", "properties": { "name": { - "description": "Required. Name of the key.\nThis is an arbitrary string used to differentiate different keys.\nA unique key is generated per name: two separate `TransientCryptoKey`\nprotos share the same generated key if their names are the same.\nWhen the data crypto key is generated, this name is not used in any way\n(repeating the api call will result in a different key being generated).", + "description": "Required. Name of the key. This is an arbitrary string used to differentiate different keys. A unique key is generated per name: two separate `TransientCryptoKey` protos share the same generated key if their names are the same. When the data crypto key is generated, this name is not used in any way (repeating the api call will result in a different key being generated).", "type": "string" } }, @@ -7005,7 +7046,7 @@ "properties": { "manual": { "$ref": "GooglePrivacyDlpV2Manual", - "description": "For use with hybrid jobs. Jobs must be manually created and finished.\nEarly access feature is in a pre-release state and might change or have\nlimited support. For more information, see\nhttps://cloud.google.com/products#product-launch-stages." + "description": "For use with hybrid jobs. Jobs must be manually created and finished. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages." }, "schedule": { "$ref": "GooglePrivacyDlpV2Schedule", @@ -7015,7 +7056,7 @@ "type": "object" }, "GooglePrivacyDlpV2UnwrappedCryptoKey": { - "description": "Using raw keys is prone to security risks due to accidentally\nleaking the key. Choose another type of key if possible.", + "description": "Using raw keys is prone to security risks due to accidentally leaking the key. Choose another type of key if possible.", "id": "GooglePrivacyDlpV2UnwrappedCryptoKey", "properties": { "key": { @@ -7080,7 +7121,7 @@ "properties": { "config": { "$ref": "GooglePrivacyDlpV2StoredInfoTypeConfig", - "description": "Updated configuration for the storedInfoType. If not provided, a new\nversion of the storedInfoType will be created with the existing\nconfiguration." + "description": "Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration." }, "updateMask": { "description": "Mask to control which fields get updated.", @@ -7091,7 +7132,7 @@ "type": "object" }, "GooglePrivacyDlpV2Value": { - "description": "Set of primitive values supported by the system.\nNote that for the purposes of inspection or transformation, the number\nof bytes considered to comprise a 'Value' is based on its representation\nas a UTF-8 encoded string. For example, if 'integer_value' is set to\n123456789, the number of bytes would be counted as 9, even though an\nint64 only holds up to 8 bytes of data.", + "description": "Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data.", "id": "GooglePrivacyDlpV2Value", "properties": { "booleanValue": { @@ -7173,7 +7214,7 @@ "id": "GooglePrivacyDlpV2WordList", "properties": { "words": { - "description": "Words or phrases defining the dictionary. The dictionary must contain\nat least one phrase and every phrase must contain at least 2 characters\nthat are letters or digits. [required]", + "description": "Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]", "items": { "type": "string" }, @@ -7183,13 +7224,13 @@ "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": { @@ -7198,7 +7239,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.", @@ -7209,28 +7250,28 @@ "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" }, "GoogleTypeDate": { - "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": "GoogleTypeDate", "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" } @@ -7238,11 +7279,11 @@ "type": "object" }, "GoogleTypeTimeOfDay": { - "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`.", + "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "GoogleTypeTimeOfDay", "properties": { "hours": { - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.", + "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, @@ -7257,7 +7298,7 @@ "type": "integer" }, "seconds": { - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.", + "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/discovery/gmail-v1.json b/discovery/gmail-v1.json index 99723ea5e1..ff1686b8e7 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 threads, messages, and labels.", + "description": "The Gmail API lets you view and manage Gmail mailbox data like\n 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` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan 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` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan 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` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan 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` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan 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. Does not simply trash it.", + "description": "Immediately and permanently deletes the specified draft.\nDoes 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` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -333,12 +333,6 @@ "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" }, @@ -350,7 +344,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -378,7 +372,7 @@ "parameters": { "includeSpamTrash": { "default": "false", - "description": "Include drafts from `SPAM` and `TRASH` in the results.", + "description": "Include drafts from `SPAM` and `TRASH`\nin the results.", "location": "query", "type": "boolean" }, @@ -395,13 +389,13 @@ "type": "string" }, "q": { - "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\"`.", + "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\"`.", "location": "query", "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -419,7 +413,7 @@ ] }, "send": { - "description": "Sends the specified, existing draft to the recipients in the `To`, `Cc`, and `Bcc` headers.", + "description": "Sends the specified, existing draft to the recipients in the\n`To`, `Cc`, and `Bcc` headers.", "flatPath": "gmail/v1/users/{userId}/drafts/send", "httpMethod": "POST", "id": "gmail.users.drafts.send", @@ -445,7 +439,7 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -500,7 +494,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -526,7 +520,7 @@ "history": { "methods": { "list": { - "description": "Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing `historyId`).", + "description": "Lists the history of all changes to the given mailbox. History results are\nreturned in chronological order (increasing `historyId`).", "flatPath": "gmail/v1/users/{userId}/history", "httpMethod": "GET", "id": "gmail.users.history.list", @@ -542,12 +536,6 @@ "labelAdded", "labelRemoved" ], - "enumDescriptions": [ - "", - "", - "", - "" - ], "location": "query", "repeated": true, "type": "string" @@ -570,14 +558,14 @@ "type": "string" }, "startHistoryId": { - "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.", + "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.", "format": "uint64", "location": "query", "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -609,7 +597,7 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -629,7 +617,7 @@ ] }, "delete": { - "description": "Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to.", + "description": "Immediately and permanently deletes the specified label and removes it from\nany messages and threads that it is applied to.", "flatPath": "gmail/v1/users/{userId}/labels/{id}", "httpMethod": "DELETE", "id": "gmail.users.labels.delete", @@ -646,7 +634,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -677,7 +665,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -706,7 +694,7 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -742,7 +730,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -779,7 +767,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -803,7 +791,7 @@ "messages": { "methods": { "batchDelete": { - "description": "Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.", + "description": "Deletes many messages by message ID. Provides no guarantees that messages\nwere not already deleted or even existed at all.", "flatPath": "gmail/v1/users/{userId}/messages/batchDelete", "httpMethod": "POST", "id": "gmail.users.messages.batchDelete", @@ -813,7 +801,7 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -838,7 +826,7 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -854,7 +842,7 @@ ] }, "delete": { - "description": "Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer `messages.trash` instead.", + "description": "Immediately and permanently deletes the specified message. This operation\ncannot be undone. Prefer `messages.trash` instead.", "flatPath": "gmail/v1/users/{userId}/messages/{id}", "httpMethod": "DELETE", "id": "gmail.users.messages.delete", @@ -871,7 +859,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -901,12 +889,6 @@ "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" }, @@ -917,14 +899,14 @@ "type": "string" }, "metadataHeaders": { - "description": "When given and format is `METADATA`, only include headers specified.", + "description": "When given and format is `METADATA`, only include headers\nspecified.", "location": "query", "repeated": true, "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -945,7 +927,7 @@ ] }, "import": { - "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.", + "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.", "flatPath": "gmail/v1/users/{userId}/messages/import", "httpMethod": "POST", "id": "gmail.users.messages.import", @@ -971,7 +953,7 @@ "parameters": { "deleted": { "default": "false", - "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.", + "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.", "location": "query", "type": "boolean" }, @@ -982,28 +964,24 @@ "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 this email as SPAM in the mailbox.", + "description": "Ignore the Gmail spam classifier decision and never mark\nthis email as SPAM in the mailbox.", "location": "query", "type": "boolean" }, "processForCalendar": { "default": "false", - "description": "Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.", + "description": "Process calendar invites in the email and add any extracted\nmeetings to the Google Calendar for this user.", "location": "query", "type": "boolean" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1024,7 +1002,7 @@ "supportsMediaUpload": true }, "insert": { - "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.", + "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.", "flatPath": "gmail/v1/users/{userId}/messages", "httpMethod": "POST", "id": "gmail.users.messages.insert", @@ -1050,7 +1028,7 @@ "parameters": { "deleted": { "default": "false", - "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.", + "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.", "location": "query", "type": "boolean" }, @@ -1061,16 +1039,12 @@ "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` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1101,7 +1075,7 @@ "parameters": { "includeSpamTrash": { "default": "false", - "description": "Include messages from `SPAM` and `TRASH` in the results.", + "description": "Include messages from `SPAM` and `TRASH`\nin the results.", "location": "query", "type": "boolean" }, @@ -1124,13 +1098,13 @@ "type": "string" }, "q": { - "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.", + "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.", "location": "query", "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1165,7 +1139,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1184,7 +1158,7 @@ ] }, "send": { - "description": "Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers.", + "description": "Sends the specified message to the recipients in the\n`To`, `Cc`, and `Bcc` headers.", "flatPath": "gmail/v1/users/{userId}/messages/send", "httpMethod": "POST", "id": "gmail.users.messages.send", @@ -1210,7 +1184,7 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1250,7 +1224,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1283,7 +1257,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1327,7 +1301,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1362,7 +1336,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1390,7 +1364,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1418,7 +1392,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1446,7 +1420,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1474,7 +1448,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1492,7 +1466,7 @@ ] }, "updateAutoForwarding": { - "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.", + "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.", "flatPath": "gmail/v1/users/{userId}/settings/autoForwarding", "httpMethod": "PUT", "id": "gmail.users.settings.updateAutoForwarding", @@ -1502,7 +1476,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1530,7 +1504,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1548,7 +1522,7 @@ ] }, "updateLanguage": { - "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.", + "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.", "flatPath": "gmail/v1/users/{userId}/settings/language", "httpMethod": "PUT", "id": "gmail.users.settings.updateLanguage", @@ -1558,7 +1532,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1586,7 +1560,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1614,7 +1588,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1636,7 +1610,7 @@ "delegates": { "methods": { "create": { - "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.", + "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.", "flatPath": "gmail/v1/users/{userId}/settings/delegates", "httpMethod": "POST", "id": "gmail.users.settings.delegates.create", @@ -1646,7 +1620,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1664,7 +1638,7 @@ ] }, "delete": { - "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.", + "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.", "flatPath": "gmail/v1/users/{userId}/settings/delegates/{delegateEmail}", "httpMethod": "DELETE", "id": "gmail.users.settings.delegates.delete", @@ -1681,7 +1655,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1693,7 +1667,7 @@ ] }, "get": { - "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.", + "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.", "flatPath": "gmail/v1/users/{userId}/settings/delegates/{delegateEmail}", "httpMethod": "GET", "id": "gmail.users.settings.delegates.get", @@ -1703,14 +1677,14 @@ ], "parameters": { "delegateEmail": { - "description": "The email address of the user whose delegate relationship is to be retrieved.", + "description": "The email address of the user whose delegate relationship is to be\nretrieved.", "location": "path", "required": true, "type": "string" }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1728,7 +1702,7 @@ ] }, "list": { - "description": "Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.", + "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.", "flatPath": "gmail/v1/users/{userId}/settings/delegates", "httpMethod": "GET", "id": "gmail.users.settings.delegates.list", @@ -1738,7 +1712,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1770,7 +1744,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1805,7 +1779,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1834,7 +1808,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1862,7 +1836,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1884,7 +1858,7 @@ "forwardingAddresses": { "methods": { "create": { - "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.", + "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.", "flatPath": "gmail/v1/users/{userId}/settings/forwardingAddresses", "httpMethod": "POST", "id": "gmail.users.settings.forwardingAddresses.create", @@ -1894,7 +1868,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1912,7 +1886,7 @@ ] }, "delete": { - "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.", + "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.", "flatPath": "gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}", "httpMethod": "DELETE", "id": "gmail.users.settings.forwardingAddresses.delete", @@ -1929,7 +1903,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1958,7 +1932,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -1986,7 +1960,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2008,7 +1982,7 @@ "sendAs": { "methods": { "create": { - "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.", + "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.", "flatPath": "gmail/v1/users/{userId}/settings/sendAs", "httpMethod": "POST", "id": "gmail.users.settings.sendAs.create", @@ -2018,7 +1992,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2036,7 +2010,7 @@ ] }, "delete": { - "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.", + "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.", "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}", "httpMethod": "DELETE", "id": "gmail.users.settings.sendAs.delete", @@ -2053,7 +2027,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2065,7 +2039,7 @@ ] }, "get": { - "description": "Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.", + "description": "Gets the specified send-as alias. Fails with an HTTP 404 error if the\nspecified address is not a member of the collection.", "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}", "httpMethod": "GET", "id": "gmail.users.settings.sendAs.get", @@ -2082,7 +2056,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2100,7 +2074,7 @@ ] }, "list": { - "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.", + "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.", "flatPath": "gmail/v1/users/{userId}/settings/sendAs", "httpMethod": "GET", "id": "gmail.users.settings.sendAs.list", @@ -2110,7 +2084,7 @@ "parameters": { "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2145,7 +2119,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2164,7 +2138,7 @@ ] }, "update": { - "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.", + "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.", "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}", "httpMethod": "PUT", "id": "gmail.users.settings.sendAs.update", @@ -2181,7 +2155,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2200,7 +2174,7 @@ ] }, "verify": { - "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.", + "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.", "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify", "httpMethod": "POST", "id": "gmail.users.settings.sendAs.verify", @@ -2217,7 +2191,7 @@ }, "userId": { "default": "me", - "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2250,14 +2224,14 @@ "type": "string" }, "sendAsEmail": { - "description": "The email address that appears in the \"From:\" header for mail sent using this alias.", + "description": "The email address that appears in the \"From:\" header for mail sent using\nthis alias.", "location": "path", "required": true, "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2287,14 +2261,14 @@ "type": "string" }, "sendAsEmail": { - "description": "The email address that appears in the \"From:\" header for mail sent using this alias.", + "description": "The email address that appears in the \"From:\" header for mail sent using\nthis alias.", "location": "path", "required": true, "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2313,7 +2287,7 @@ ] }, "insert": { - "description": "Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.", + "description": "Insert (upload) the given S/MIME config for the specified send-as alias.\nNote 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", @@ -2323,14 +2297,14 @@ ], "parameters": { "sendAsEmail": { - "description": "The email address that appears in the \"From:\" header for mail sent using this alias.", + "description": "The email address that appears in the \"From:\" header for mail sent using\nthis alias.", "location": "path", "required": true, "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2359,14 +2333,14 @@ ], "parameters": { "sendAsEmail": { - "description": "The email address that appears in the \"From:\" header for mail sent using this alias.", + "description": "The email address that appears in the \"From:\" header for mail sent using\nthis alias.", "location": "path", "required": true, "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2402,14 +2376,14 @@ "type": "string" }, "sendAsEmail": { - "description": "The email address that appears in the \"From:\" header for mail sent using this alias.", + "description": "The email address that appears in the \"From:\" header for mail sent using\nthis alias.", "location": "path", "required": true, "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2430,7 +2404,7 @@ "threads": { "methods": { "delete": { - "description": "Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer `threads.trash` instead.", + "description": "Immediately and permanently deletes the specified thread. This operation\ncannot be undone. Prefer `threads.trash` instead.", "flatPath": "gmail/v1/users/{userId}/threads/{id}", "httpMethod": "DELETE", "id": "gmail.users.threads.delete", @@ -2447,7 +2421,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2476,11 +2450,6 @@ "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" }, @@ -2498,7 +2467,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2529,7 +2498,7 @@ "parameters": { "includeSpamTrash": { "default": "false", - "description": "Include threads from `SPAM` and `TRASH` in the results.", + "description": "Include threads from `SPAM` and `TRASH`\nin the results.", "location": "query", "type": "boolean" }, @@ -2552,13 +2521,13 @@ "type": "string" }, "q": { - "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.", + "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.", "location": "query", "type": "string" }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2576,7 +2545,7 @@ ] }, "modify": { - "description": "Modifies the labels applied to the thread. This applies to all messages in the thread.", + "description": "Modifies the labels applied to the thread. This applies to all messages\nin the thread.", "flatPath": "gmail/v1/users/{userId}/threads/{id}/modify", "httpMethod": "POST", "id": "gmail.users.threads.modify", @@ -2593,7 +2562,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2629,7 +2598,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2662,7 +2631,7 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", + "description": "The user's email address. The special value `me`\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" @@ -2682,7 +2651,7 @@ } } }, - "revision": "20200803", + "revision": "20200727", "rootUrl": "https://www.googleapis.com/", "schemas": { "AutoForwarding": { @@ -2708,7 +2677,7 @@ "type": "string" }, "emailAddress": { - "description": "Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.", + "description": "Email address to which all incoming messages are forwarded. This email\naddress must be a verified member of the forwarding addresses.", "type": "string" }, "enabled": { @@ -2742,7 +2711,7 @@ "type": "array" }, "ids": { - "description": "The IDs of the messages to modify. There is a limit of 1000 ids per request.", + "description": "The IDs of the messages to modify. There is a limit of 1000 ids per\nrequest.", "items": { "type": "string" }, @@ -2759,7 +2728,7 @@ "type": "object" }, "Delegate": { - "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.", + "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.", "id": "Delegate", "properties": { "delegateEmail": { @@ -2767,7 +2736,7 @@ "type": "string" }, "verificationStatus": { - "description": "Indicates whether this address has been verified and can act as a delegate for the account. Read-only.", + "description": "Indicates whether this address has been verified and can act as a delegate\nfor the account. Read-only.", "enum": [ "verificationStatusUnspecified", "accepted", @@ -2778,9 +2747,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 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." + "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." ], "type": "string" } @@ -2808,7 +2777,7 @@ "type": "object" }, "Filter": { - "description": "Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.", + "description": "Resource definition for Gmail filters. Filters apply to specific messages\ninstead of an entire email thread.", "id": "Filter", "properties": { "action": { @@ -2868,15 +2837,15 @@ "type": "boolean" }, "negatedQuery": { - "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\"`.", + "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\"`.", "type": "string" }, "query": { - "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\"`.", + "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\"`.", "type": "string" }, "size": { - "description": "The size of the entire RFC822 message in bytes, including all headers and attachments.", + "description": "The size of the entire RFC822 message in bytes, including all headers and\nattachments.", "format": "int32", "type": "integer" }, @@ -2895,11 +2864,11 @@ "type": "string" }, "subject": { - "description": "Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.", + "description": "Case-insensitive phrase found in the message's subject. Trailing and\nleading 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 \"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.", + "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.", "type": "string" } }, @@ -2914,7 +2883,7 @@ "type": "string" }, "verificationStatus": { - "description": "Indicates whether this address has been verified and is usable for forwarding. Read-only.", + "description": "Indicates whether this address has been verified and is usable for\nforwarding. Read-only.", "enum": [ "verificationStatusUnspecified", "accepted", @@ -2931,7 +2900,7 @@ "type": "object" }, "History": { - "description": "A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways.", + "description": "A record of a change to the user's mailbox. Each history change may affect\nmultiple messages in multiple ways.", "id": "History", "properties": { "id": { @@ -2954,7 +2923,7 @@ "type": "array" }, "messages": { - "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.", + "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.", "items": { "$ref": "Message" }, @@ -3032,7 +3001,7 @@ "id": "ImapSettings", "properties": { "autoExpunge": { - "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.", + "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.", "type": "boolean" }, "enabled": { @@ -3040,7 +3009,7 @@ "type": "boolean" }, "expungeBehavior": { - "description": "The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.", + "description": "The action that will be executed on a message when it is marked as deleted\nand expunged from the last visible IMAP folder.", "enum": [ "expungeBehaviorUnspecified", "archive", @@ -3051,12 +3020,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 expunged messages cannot be recovered." + "Immediately and permanently delete messages marked as deleted. The\nexpunged messages cannot be recovered." ], "type": "string" }, "maxFolderSize": { - "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.", + "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.", "format": "int32", "type": "integer" } @@ -3064,12 +3033,12 @@ "type": "object" }, "Label": { - "description": "Labels are used to categorize messages and threads within the user's mailbox.", + "description": "Labels are used to categorize messages and threads within the\nuser's mailbox.", "id": "Label", "properties": { "color": { "$ref": "LabelColor", - "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" + "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" }, "id": { "annotations": { @@ -3087,7 +3056,7 @@ "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", + "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", "enum": [ "labelShow", "labelShowIfUnread", @@ -3107,7 +3076,7 @@ "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", + "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", "enum": [ "show", "hide" @@ -3135,7 +3104,7 @@ "gmail.users.labels.update" ] }, - "description": "The display name of the label. @mutable gmail.users.labels.create gmail.users.labels.update", + "description": "The display name of the label.\n@mutable gmail.users.labels.create gmail.users.labels.update", "type": "string" }, "threadsTotal": { @@ -3149,7 +3118,7 @@ "type": "integer" }, "type": { - "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.", + "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.", "enum": [ "system", "user" @@ -3167,22 +3136,22 @@ "id": "LabelColor", "properties": { "backgroundColor": { - "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", + "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", "type": "string" }, "textColor": { - "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", + "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", "type": "string" } }, "type": "object" }, "LanguageSettings": { - "description": "Language settings for an account. These settings correspond to the \"Language settings\" feature in the web interface.", + "description": "Language settings for an account. These settings correspond to\nthe \"Language\nsettings\" feature in the web interface.", "id": "LanguageSettings", "properties": { "displayLanguage": { - "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).", + "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).", "type": "string" } }, @@ -3206,7 +3175,7 @@ "id": "ListDraftsResponse", "properties": { "drafts": { - "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.", + "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.", "items": { "$ref": "Draft" }, @@ -3256,7 +3225,7 @@ "id": "ListHistoryResponse", "properties": { "history": { - "description": "List of history records. Any `messages` contained in the response will typically only have `id` and `threadId` fields populated.", + "description": "List of history records. Any `messages` contained in the\nresponse will typically only have `id` and\n`threadId` fields populated.", "items": { "$ref": "History" }, @@ -3278,7 +3247,7 @@ "id": "ListLabelsResponse", "properties": { "labels": { - "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.", + "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.", "items": { "$ref": "Label" }, @@ -3291,7 +3260,7 @@ "id": "ListMessagesResponse", "properties": { "messages": { - "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.", + "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.", "items": { "$ref": "Message" }, @@ -3349,7 +3318,7 @@ "type": "integer" }, "threads": { - "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.", + "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.", "items": { "$ref": "Thread" }, @@ -3372,12 +3341,12 @@ "type": "string" }, "internalDate": { - "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.", + "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.", "format": "int64", "type": "string" }, "labelIds": { - "description": "List of IDs of labels applied to this message. @mutable gmail.users.messages.insert gmail.users.messages.modify", + "description": "List of IDs of labels applied to this message.\n@mutable gmail.users.messages.insert gmail.users.messages.modify", "items": { "type": "string" }, @@ -3396,7 +3365,7 @@ "gmail.users.messages.send" ] }, - "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", + "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", "format": "byte", "type": "string" }, @@ -3410,7 +3379,7 @@ "type": "string" }, "threadId": { - "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", + "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", "type": "string" } }, @@ -3422,14 +3391,14 @@ "properties": { "body": { "$ref": "MessagePartBody", - "description": "The message part body for this part, which may be empty for container MIME message parts." + "description": "The message part body for this part, which may be empty for\ncontainer MIME message parts." }, "filename": { - "description": "The filename of the attachment. Only present if this message part represents an attachment.", + "description": "The filename of the attachment. Only present if this message part\nrepresents an attachment.", "type": "string" }, "headers": { - "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`.", + "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`.", "items": { "$ref": "MessagePartHeader" }, @@ -3444,7 +3413,7 @@ "type": "string" }, "parts": { - "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.", + "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.", "items": { "$ref": "MessagePart" }, @@ -3458,11 +3427,11 @@ "id": "MessagePartBody", "properties": { "attachmentId": { - "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.", + "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.", "type": "string" }, "data": { - "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.", + "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.", "format": "byte", "type": "string" }, @@ -3478,11 +3447,11 @@ "id": "MessagePartHeader", "properties": { "name": { - "description": "The name of the header before the `:` separator. For example, `To`.", + "description": "The name of the header before the `:` separator. For\nexample, `To`.", "type": "string" }, "value": { - "description": "The value of the header after the `:` separator. For example, `someuser@example.com`.", + "description": "The value of the header after the `:` separator. For example,\n`someuser@example.com`.", "type": "string" } }, @@ -3543,13 +3512,13 @@ "enumDescriptions": [ "Unspecified range.", "Indicates that no messages are accessible via POP.", - "Indicates that unfetched messages received after some past point in time are accessible via POP.", + "Indicates that unfetched messages received after some past point in\ntime 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 POP.", + "description": "The action that will be executed on a message after it has been fetched via\nPOP.", "enum": [ "dispositionUnspecified", "leaveInInbox", @@ -3596,43 +3565,43 @@ "type": "object" }, "SendAs": { - "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.", + "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.", "id": "SendAs", "properties": { "displayName": { - "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.", + "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.", "type": "string" }, "isDefault": { - "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.", + "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.", "type": "boolean" }, "isPrimary": { - "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.", + "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.", "type": "boolean" }, "replyToAddress": { - "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.", + "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.", "type": "string" }, "sendAsEmail": { - "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.", + "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.", "type": "string" }, "signature": { - "description": "An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.", + "description": "An optional HTML signature that is included in messages composed with this\nalias 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 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." + "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." }, "treatAsAlias": { - "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.", + "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.", "type": "boolean" }, "verificationStatus": { - "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.", + "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.", "enum": [ "verificationStatusUnspecified", "accepted", @@ -3674,11 +3643,11 @@ "type": "string" }, "pem": { - "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).", + "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).", "type": "string" }, "pkcs12": { - "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.", + "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.", "format": "byte", "type": "string" } @@ -3690,20 +3659,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. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.", + "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.", "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 service. Required.", + "description": "The protocol that will be used to secure communication with the SMTP\nservice. Required.", "enum": [ "securityModeUnspecified", "none", @@ -3712,14 +3681,14 @@ ], "enumDescriptions": [ "Unspecified security mode.", - "Communication with the remote SMTP service is unsecured. Requires port 25.", + "Communication with the remote SMTP service is unsecured. Requires port\n25.", "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. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.", + "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.", "type": "string" } }, @@ -3753,7 +3722,7 @@ "type": "object" }, "VacationSettings": { - "description": "Vacation auto-reply settings for an account. These settings correspond to the \"Vacation responder\" feature in the web interface.", + "description": "Vacation auto-reply settings for an account. These settings correspond to\nthe \"Vacation\nresponder\" feature in the web interface.", "id": "VacationSettings", "properties": { "enableAutoReply": { @@ -3761,32 +3730,32 @@ "type": "boolean" }, "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`.", + "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`.", "format": "int64", "type": "string" }, "responseBodyHtml": { - "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.", + "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.", "type": "string" }, "responseBodyPlainText": { - "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.", + "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.", "type": "string" }, "responseSubject": { - "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.", + "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.", "type": "string" }, "restrictToContacts": { - "description": "Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.", + "description": "Flag that determines whether responses are sent to recipients who are not\nin the user's list of contacts.", "type": "boolean" }, "restrictToDomain": { - "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.", + "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.", "type": "boolean" }, "startTime": { - "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`.", + "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`.", "format": "int64", "type": "string" } @@ -3804,20 +3773,20 @@ "exclude" ], "enumDescriptions": [ - "Only get push notifications for message changes relating to labelIds specified.", - "Get push notifications for all message changes except those relating to labelIds specified." + "Only get push notifications for message changes relating to labelIds\nspecified.", + "Get push notifications for all message changes except those relating\nto labelIds specified." ], "type": "string" }, "labelIds": { - "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.", + "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.", "items": { "type": "string" }, "type": "array" }, "topicName": { - "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).", + "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).", "type": "string" } }, @@ -3828,7 +3797,7 @@ "id": "WatchResponse", "properties": { "expiration": { - "description": "When Gmail will stop sending notifications for mailbox updates (epoch millis). Call `watch` again before this time to renew the watch.", + "description": "When Gmail will stop sending notifications for mailbox updates\n(epoch millis). Call `watch` again before this time to renew\nthe watch.", "format": "int64", "type": "string" }, diff --git a/discovery/manufacturers-v1.json b/discovery/manufacturers-v1.json index 1a01dc468d..151f4dc1cf 100644 --- a/discovery/manufacturers-v1.json +++ b/discovery/manufacturers-v1.json @@ -119,14 +119,14 @@ ], "parameters": { "name": { - "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.", + "description": "Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id.", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" }, "parent": { - "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.", + "description": "Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -142,7 +142,7 @@ ] }, "get": { - "description": "Gets the product from a Manufacturer Center account, including product\nissues.\n\nA recently updated product takes around 15 minutes to process. Changes are\nonly visible after it has been processed. While some issues may be\navailable once the product has been processed, other issues may take days\nto appear.", + "description": "Gets the product from a Manufacturer Center account, including product issues. A recently updated product takes around 15 minutes to process. Changes are only visible after it has been processed. While some issues may be available once the product has been processed, other issues may take days to appear.", "flatPath": "v1/accounts/{accountsId}/products/{productsId}", "httpMethod": "GET", "id": "manufacturers.accounts.products.get", @@ -152,26 +152,32 @@ ], "parameters": { "include": { - "description": "The information to be included in the response. Only sections listed here\nwill be returned.", + "description": "The information to be included in the response. Only sections listed here will be returned.", "enum": [ "UNKNOWN", "ATTRIBUTES", "ISSUES", "DESTINATION_STATUSES" ], + "enumDescriptions": [ + "Unknown, never used.", + "Include the attributes of the product.", + "Include the issues of the product.", + "Include the destination statuses of the product." + ], "location": "query", "repeated": true, "type": "string" }, "name": { - "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.", + "description": "Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id.", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" }, "parent": { - "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.", + "description": "Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -196,19 +202,25 @@ ], "parameters": { "include": { - "description": "The information to be included in the response. Only sections listed here\nwill be returned.", + "description": "The information to be included in the response. Only sections listed here will be returned.", "enum": [ "UNKNOWN", "ATTRIBUTES", "ISSUES", "DESTINATION_STATUSES" ], + "enumDescriptions": [ + "Unknown, never used.", + "Include the attributes of the product.", + "Include the issues of the product.", + "Include the destination statuses of the product." + ], "location": "query", "repeated": true, "type": "string" }, "pageSize": { - "description": "Maximum number of product statuses to return in the response, used for\npaging.", + "description": "Maximum number of product statuses to return in the response, used for paging.", "format": "int32", "location": "query", "type": "integer" @@ -219,7 +231,7 @@ "type": "string" }, "parent": { - "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.", + "description": "Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -235,7 +247,7 @@ ] }, "update": { - "description": "Inserts or updates the attributes of the product in a Manufacturer Center\naccount.\n\nCreates a product with the provided attributes. If the product already\nexists, then all attributes are replaced with the new ones. The checks at\nupload time are minimal. All required attributes need to be present for a\nproduct to be valid. Issues may show up later after the API has accepted a\nnew upload for a product and it is possible to overwrite an existing valid\nproduct with an invalid product. To detect this, you should retrieve the\nproduct and check it for issues once the new version is available.\n\nUploaded attributes first need to be processed before they can be\nretrieved. Until then, new products will be unavailable, and retrieval\nof previously uploaded products will return the original state of the\nproduct.", + "description": "Inserts or updates the attributes of the product in a Manufacturer Center account. Creates a product with the provided attributes. If the product already exists, then all attributes are replaced with the new ones. The checks at upload time are minimal. All required attributes need to be present for a product to be valid. Issues may show up later after the API has accepted a new upload for a product and it is possible to overwrite an existing valid product with an invalid product. To detect this, you should retrieve the product and check it for issues once the new version is available. Uploaded attributes first need to be processed before they can be retrieved. Until then, new products will be unavailable, and retrieval of previously uploaded products will return the original state of the product.", "flatPath": "v1/accounts/{accountsId}/products/{productsId}", "httpMethod": "PUT", "id": "manufacturers.accounts.products.update", @@ -245,14 +257,14 @@ ], "parameters": { "name": { - "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.", + "description": "Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id.", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" }, "parent": { - "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.", + "description": "Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -275,46 +287,46 @@ } } }, - "revision": "20200505", + "revision": "20200805", "rootUrl": "https://manufacturers.googleapis.com/", "schemas": { "Attributes": { - "description": "Attributes of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116.", + "description": "Attributes of the product. For more information, see https://support.google.com/manufacturers/answer/6124116.", "id": "Attributes", "properties": { "additionalImageLink": { - "description": "The additional images of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#addlimage.", + "description": "The additional images of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#addlimage.", "items": { "$ref": "Image" }, "type": "array" }, "ageGroup": { - "description": "The target age group of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#agegroup.", + "description": "The target age group of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#agegroup.", "type": "string" }, "brand": { - "description": "The brand name of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#brand.", + "description": "The brand name of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#brand.", "type": "string" }, "capacity": { "$ref": "Capacity", - "description": "The capacity of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity." + "description": "The capacity of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#capacity." }, "color": { - "description": "The color of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#color.", + "description": "The color of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#color.", "type": "string" }, "count": { "$ref": "Count", - "description": "The count of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count." + "description": "The count of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#count." }, "description": { - "description": "The description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#description.", + "description": "The description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#description.", "type": "string" }, "disclosureDate": { - "description": "The disclosure date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#disclosure.", + "description": "The disclosure date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#disclosure.", "type": "string" }, "excludedDestination": { @@ -325,26 +337,26 @@ "type": "array" }, "featureDescription": { - "description": "The rich format description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.", + "description": "The rich format description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#featuredesc.", "items": { "$ref": "FeatureDescription" }, "type": "array" }, "flavor": { - "description": "The flavor of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#flavor.", + "description": "The flavor of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#flavor.", "type": "string" }, "format": { - "description": "The format of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#format.", + "description": "The format of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#format.", "type": "string" }, "gender": { - "description": "The target gender of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#gender.", + "description": "The target gender of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#gender.", "type": "string" }, "gtin": { - "description": "The Global Trade Item Number (GTIN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#gtin.", + "description": "The Global Trade Item Number (GTIN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#gtin.", "items": { "type": "string" }, @@ -352,7 +364,7 @@ }, "imageLink": { "$ref": "Image", - "description": "The image of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#image." + "description": "The image of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#image." }, "includedDestination": { "description": "A list of included destinations.", @@ -362,92 +374,92 @@ "type": "array" }, "itemGroupId": { - "description": "The item group id of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#itemgroupid.", + "description": "The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid.", "type": "string" }, "material": { - "description": "The material of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#material.", + "description": "The material of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#material.", "type": "string" }, "mpn": { - "description": "The Manufacturer Part Number (MPN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#mpn.", + "description": "The Manufacturer Part Number (MPN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#mpn.", "type": "string" }, "pattern": { - "description": "The pattern of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#pattern.", + "description": "The pattern of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#pattern.", "type": "string" }, "productDetail": { - "description": "The details of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.", + "description": "The details of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail.", "items": { "$ref": "ProductDetail" }, "type": "array" }, "productLine": { - "description": "The name of the group of products related to the product. For more\ninformation, see\nhttps://support.google.com/manufacturers/answer/6124116#productline.", + "description": "The name of the group of products related to the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productline.", "type": "string" }, "productName": { - "description": "The canonical name of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productname.", + "description": "The canonical name of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productname.", "type": "string" }, "productPageUrl": { - "description": "The URL of the detail page of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productpage.", + "description": "The URL of the detail page of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productpage.", "type": "string" }, "productType": { - "description": "The type or category of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#producttype.", + "description": "The type or category of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#producttype.", "items": { "type": "string" }, "type": "array" }, "releaseDate": { - "description": "The release date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#release.", + "description": "The release date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#release.", "type": "string" }, "richProductContent": { - "description": "Rich product content. For more information, see\nhttps://support.google.com/manufacturers/answer/9389865", + "description": "Rich product content. For more information, see https://support.google.com/manufacturers/answer/9389865", "items": { "type": "string" }, "type": "array" }, "scent": { - "description": "The scent of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#scent.", + "description": "The scent of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#scent.", "type": "string" }, "size": { - "description": "The size of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#size.", + "description": "The size of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#size.", "type": "string" }, "sizeSystem": { - "description": "The size system of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#sizesystem.", + "description": "The size system of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#sizesystem.", "type": "string" }, "sizeType": { - "description": "The size type of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#sizetype.", + "description": "The size type of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#sizetype.", "type": "string" }, "suggestedRetailPrice": { "$ref": "Price", - "description": "The suggested retail price (MSRP) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#price." + "description": "The suggested retail price (MSRP) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#price." }, "targetClientId": { - "description": "The target client id. Should only be used in the accounts of the data\npartners.", + "description": "The target client id. Should only be used in the accounts of the data partners.", "type": "string" }, "theme": { - "description": "The theme of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#theme.", + "description": "The theme of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#theme.", "type": "string" }, "title": { - "description": "The title of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#title.", + "description": "The title of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#title.", "type": "string" }, "videoLink": { - "description": "The videos of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#video.", + "description": "The videos of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#video.", "items": { "type": "string" }, @@ -457,7 +469,7 @@ "type": "object" }, "Capacity": { - "description": "The capacity of a product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.", + "description": "The capacity of a product. For more information, see https://support.google.com/manufacturers/answer/6124116#capacity.", "id": "Capacity", "properties": { "unit": { @@ -473,7 +485,7 @@ "type": "object" }, "Count": { - "description": "The number of products in a single package. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count.", + "description": "The number of products in a single package. For more information, see https://support.google.com/manufacturers/answer/6124116#count.", "id": "Count", "properties": { "unit": { @@ -516,13 +528,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" }, "FeatureDescription": { - "description": "A feature description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.", + "description": "A feature description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#featuredesc.", "id": "FeatureDescription", "properties": { "headline": { @@ -545,11 +557,11 @@ "id": "Image", "properties": { "imageUrl": { - "description": "The URL of the image. For crawled images, this is the provided URL. For\nuploaded images, this is a serving URL from Google if the image has been\nprocessed successfully.", + "description": "The URL of the image. For crawled images, this is the provided URL. For uploaded images, this is a serving URL from Google if the image has been processed successfully.", "type": "string" }, "status": { - "description": "The status of the image.\n@OutputOnly", + "description": "The status of the image. @OutputOnly", "enum": [ "STATUS_UNSPECIFIED", "PENDING_PROCESSING", @@ -583,7 +595,7 @@ "type": "string" }, "type": { - "description": "The type of the image, i.e., crawled or uploaded.\n@OutputOnly", + "description": "The type of the image, i.e., crawled or uploaded. @OutputOnly", "enum": [ "TYPE_UNSPECIFIED", "CRAWLED", @@ -604,7 +616,7 @@ "id": "Issue", "properties": { "attribute": { - "description": "If present, the attribute that triggered the issue. For more information\nabout attributes, see\nhttps://support.google.com/manufacturers/answer/6124116.", + "description": "If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116.", "type": "string" }, "description": { @@ -624,8 +636,8 @@ ], "enumDescriptions": [ "Unspecified resolution, never used.", - "The user who provided the data must act in order to resolve the issue\n(for example by correcting some data).", - "The issue will be resolved automatically (for example image crawl or\nGoogle review). No action is required now. Resolution might lead to\nanother issue (for example if crawl fails)." + "The user who provided the data must act in order to resolve the issue (for example by correcting some data).", + "The issue will be resolved automatically (for example image crawl or Google review). No action is required now. Resolution might lead to another issue (for example if crawl fails)." ], "type": "string" }, @@ -640,8 +652,8 @@ "enumDescriptions": [ "Unspecified severity, never used.", "Error severity. The issue prevents the usage of the whole item.", - "Warning severity. The issue is either one that prevents the usage of the\nattribute that triggered it or one that will soon prevent the usage of\nthe whole item.", - "Info severity. The issue is one that doesn't require immediate attention.\nIt is, for example, used to communicate which attributes are still\npending review." + "Warning severity. The issue is either one that prevents the usage of the attribute that triggered it or one that will soon prevent the usage of the whole item.", + "Info severity. The issue is one that doesn't require immediate attention. It is, for example, used to communicate which attributes are still pending review." ], "type": "string" }, @@ -655,7 +667,7 @@ "type": "string" }, "type": { - "description": "The server-generated type of the issue, for example,\n“INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.", + "description": "The server-generated type of the issue, for example, “INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.", "type": "string" } }, @@ -699,10 +711,10 @@ "properties": { "attributes": { "$ref": "Attributes", - "description": "Attributes of the product uploaded to the Manufacturer Center. Manually\nedited attributes are taken into account." + "description": "Attributes of the product uploaded to the Manufacturer Center. Manually edited attributes are taken into account." }, "contentLanguage": { - "description": "The content language of the product as a two-letter ISO 639-1 language code\n(for example, en).", + "description": "The content language of the product as a two-letter ISO 639-1 language code (for example, en).", "type": "string" }, "destinationStatuses": { @@ -720,26 +732,26 @@ "type": "array" }, "name": { - "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.", + "description": "Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id.", "type": "string" }, "parent": { - "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.", + "description": "Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.", "type": "string" }, "productId": { - "description": "The ID of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#id.", + "description": "The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id.", "type": "string" }, "targetCountry": { - "description": "The target country of the product as a CLDR territory code (for example,\nUS).", + "description": "The target country of the product as a CLDR territory code (for example, US).", "type": "string" } }, "type": "object" }, "ProductDetail": { - "description": "A product detail of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.", + "description": "A product detail of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail.", "id": "ProductDetail", "properties": { "attributeName": { diff --git a/discovery/oslogin-v1alpha.json b/discovery/oslogin-v1alpha.json index 6788265ff9..d31d0bfc61 100644 --- a/discovery/oslogin-v1alpha.json +++ b/discovery/oslogin-v1alpha.json @@ -117,7 +117,7 @@ "users": { "methods": { "getLoginProfile": { - "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine.", + "description": "Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.", "flatPath": "v1alpha/users/{usersId}/loginProfile", "httpMethod": "GET", "id": "oslogin.users.getLoginProfile", @@ -139,6 +139,11 @@ "LINUX", "WINDOWS" ], + "enumDescriptions": [ + "The operating system type associated with the user account information is unspecified.", + "Linux user account information.", + "Windows user account information." + ], "location": "query", "type": "string" }, @@ -165,7 +170,7 @@ ] }, "importSshPublicKey": { - "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile.", + "description": "Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.", "flatPath": "v1alpha/users/{usersId}:importSshPublicKey", "httpMethod": "POST", "id": "oslogin.users.importSshPublicKey", @@ -212,7 +217,7 @@ ], "parameters": { "name": { - "description": "A reference to the POSIX account to update. POSIX accounts are identified\nby the project ID they are associated with. A reference to the POSIX\naccount is in format `users/{user}/projects/{project}`.", + "description": "A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`.", "location": "path", "pattern": "^users/[^/]+/projects/[^/]+$", "required": true, @@ -225,6 +230,11 @@ "LINUX", "WINDOWS" ], + "enumDescriptions": [ + "The operating system type associated with the user account information is unspecified.", + "Linux user account information.", + "Windows user account information." + ], "location": "query", "type": "string" } @@ -252,7 +262,7 @@ ], "parameters": { "name": { - "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.", + "description": "The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.", "location": "path", "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", "required": true, @@ -278,7 +288,7 @@ ], "parameters": { "name": { - "description": "The fingerprint of the public key to retrieve. Public keys are identified\nby their SHA-256 fingerprint. The fingerprint of the public key is in\nformat `users/{user}/sshPublicKeys/{fingerprint}`.", + "description": "The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.", "location": "path", "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", "required": true, @@ -295,7 +305,7 @@ ] }, "patch": { - "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics.", + "description": "Updates an SSH public key and returns the profile information. This method supports patch semantics.", "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}", "httpMethod": "PATCH", "id": "oslogin.users.sshPublicKeys.patch", @@ -304,7 +314,7 @@ ], "parameters": { "name": { - "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.", + "description": "The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.", "location": "path", "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", "required": true, @@ -334,11 +344,11 @@ } } }, - "revision": "20200504", + "revision": "20200801", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "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" @@ -355,7 +365,7 @@ "type": "object" }, "LoginProfile": { - "description": "The user profile information used for logging in to a virtual machine on\nGoogle Compute Engine.", + "description": "The user profile information used for logging in to a virtual machine on Google Compute Engine.", "id": "LoginProfile", "properties": { "name": { @@ -385,6 +395,7 @@ "properties": { "accountId": { "description": "Output only. A POSIX account identifier.", + "readOnly": true, "type": "string" }, "gecos": { @@ -402,6 +413,7 @@ }, "name": { "description": "Output only. The canonical resource name.", + "readOnly": true, "type": "string" }, "operatingSystemType": { @@ -412,7 +424,7 @@ "WINDOWS" ], "enumDescriptions": [ - "The operating system type associated with the user account information is\nunspecified.", + "The operating system type associated with the user account information is unspecified.", "Linux user account information.", "Windows user account information." ], @@ -427,7 +439,7 @@ "type": "string" }, "systemId": { - "description": "System identifier for which account the username or uid applies to.\nBy default, the empty value is used.", + "description": "System identifier for which account the username or uid applies to. By default, the empty value is used.", "type": "string" }, "uid": { @@ -453,14 +465,16 @@ }, "fingerprint": { "description": "Output only. The SHA-256 fingerprint of the SSH public key.", + "readOnly": true, "type": "string" }, "key": { - "description": "Public key text in SSH format, defined by\nRFC4253\nsection 6.6.", + "description": "Public key text in SSH format, defined by RFC4253 section 6.6.", "type": "string" }, "name": { "description": "Output only. The canonical resource name.", + "readOnly": true, "type": "string" } }, diff --git a/discovery/people-v1.json b/discovery/people-v1.json index 5a8317bec6..ffdb2566a8 100644 --- a/discovery/people-v1.json +++ b/discovery/people-v1.json @@ -431,7 +431,7 @@ "parameterOrder": [], "parameters": { "personFields": { - "description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", + "description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", "format": "google-fieldmask", "location": "query", "type": "string" @@ -501,7 +501,7 @@ ], "parameters": { "personFields": { - "description": "Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", + "description": "Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", "format": "google-fieldmask", "location": "query", "type": "string" @@ -550,7 +550,7 @@ ], "parameters": { "personFields": { - "description": "Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", + "description": "Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", "format": "google-fieldmask", "location": "query", "type": "string" @@ -613,7 +613,7 @@ "parameterOrder": [], "parameters": { "personFields": { - "description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", + "description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", "format": "google-fieldmask", "location": "query", "type": "string" @@ -700,7 +700,7 @@ "type": "string" }, "readMask": { - "description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", + "description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", "format": "google-fieldmask", "location": "query", "type": "string" @@ -778,7 +778,7 @@ "type": "string" }, "readMask": { - "description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", + "description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", "format": "google-fieldmask", "location": "query", "type": "string" @@ -818,7 +818,7 @@ ], "parameters": { "personFields": { - "description": "Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", + "description": "Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", "format": "google-fieldmask", "location": "query", "type": "string" @@ -849,7 +849,7 @@ "type": "string" }, "updatePersonFields": { - "description": "Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined", + "description": "Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined", "format": "google-fieldmask", "location": "query", "type": "string" @@ -919,7 +919,7 @@ "type": "string" }, "personFields": { - "description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", + "description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", "format": "google-fieldmask", "location": "query", "type": "string" @@ -997,7 +997,7 @@ } } }, - "revision": "20200730", + "revision": "20200805", "rootUrl": "https://people.googleapis.com/", "schemas": { "Address": { @@ -1184,6 +1184,25 @@ }, "type": "object" }, + "ClientData": { + "description": "Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.", + "id": "ClientData", + "properties": { + "key": { + "description": "The client specified key of the client data.", + "type": "string" + }, + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the client data." + }, + "value": { + "description": "The client specified value of the client data.", + "type": "string" + } + }, + "type": "object" + }, "ContactGroup": { "description": "A contact group.", "id": "ContactGroup", @@ -1305,7 +1324,7 @@ "type": "string" }, "readMask": { - "description": "Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to the copy mask with metadata and membership fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", + "description": "Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to the copy mask with metadata and membership fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", "format": "google-fieldmask", "type": "string" }, @@ -2095,6 +2114,13 @@ }, "type": "array" }, + "clientData": { + "description": "The person's client data.", + "items": { + "$ref": "ClientData" + }, + "type": "array" + }, "coverPhotos": { "description": "Output only. The person's cover photos.", "items": { @@ -2719,7 +2745,7 @@ "id": "UpdateContactPhotoRequest", "properties": { "personFields": { - "description": "Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", + "description": "Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined", "format": "google-fieldmask", "type": "string" }, diff --git a/discovery/playablelocations-v3.json b/discovery/playablelocations-v3.json index 9ec19ec9cc..22a99fe895 100644 --- a/discovery/playablelocations-v3.json +++ b/discovery/playablelocations-v3.json @@ -99,7 +99,7 @@ "v3": { "methods": { "logImpressions": { - "description": "Logs new events when playable locations are displayed, and when they are\ninteracted with.\n\nImpressions are not partially saved; either all impressions are saved and\nthis request succeeds, or no impressions are saved, and this request fails.", + "description": "Logs new events when playable locations are displayed, and when they are interacted with. Impressions are not partially saved; either all impressions are saved and this request succeeds, or no impressions are saved, and this request fails.", "flatPath": "v3:logImpressions", "httpMethod": "POST", "id": "playablelocations.logImpressions", @@ -114,7 +114,7 @@ } }, "logPlayerReports": { - "description": "Logs bad playable location reports submitted by players.\n\nReports are not partially saved; either all reports are saved and this\nrequest succeeds, or no reports are saved, and this request fails.", + "description": "Logs bad playable location reports submitted by players. Reports are not partially saved; either all reports are saved and this request succeeds, or no reports are saved, and this request fails.", "flatPath": "v3:logPlayerReports", "httpMethod": "POST", "id": "playablelocations.logPlayerReports", @@ -129,7 +129,7 @@ } }, "samplePlayableLocations": { - "description": "Returns a set of playable locations that lie within a specified area,\nthat satisfy optional filter criteria.\n\nNote: Identical `SamplePlayableLocations` requests can return different\nresults as the state of the world changes over time.", + "description": "Returns a set of playable locations that lie within a specified area, that satisfy optional filter criteria. Note: Identical `SamplePlayableLocations` requests can return different results as the state of the world changes over time.", "flatPath": "v3:samplePlayableLocations", "httpMethod": "POST", "id": "playablelocations.samplePlayableLocations", @@ -146,7 +146,7 @@ } } }, - "revision": "20200709", + "revision": "20200808", "rootUrl": "https://playablelocations.googleapis.com/", "schemas": { "GoogleMapsPlayablelocationsV3Impression": { @@ -154,7 +154,7 @@ "id": "GoogleMapsPlayablelocationsV3Impression", "properties": { "gameObjectType": { - "description": "An arbitrary, developer-defined type identifier for each type of game\nobject used in your game.\n\nSince players interact with differ types of game objects in different ways,\nthis field allows you to segregate impression data by type for analysis.\n\nYou should assign a unique `game_object_type` ID to represent a distinct\ntype of game object in your game.\n\nFor example, 1=monster location, 2=powerup location.", + "description": "An arbitrary, developer-defined type identifier for each type of game object used in your game. Since players interact with differ types of game objects in different ways, this field allows you to segregate impression data by type for analysis. You should assign a unique `game_object_type` ID to represent a distinct type of game object in your game. For example, 1=monster location, 2=powerup location.", "format": "int32", "type": "integer" }, @@ -185,24 +185,24 @@ "properties": { "clientInfo": { "$ref": "GoogleMapsUnityClientInfo", - "description": "Required. Information about the client device. For example, device model and\noperating system." + "description": "Required. Information about the client device. For example, device model and operating system." }, "impressions": { - "description": "Required. Impression event details. The maximum number of impression reports that you\ncan log at once is 50.", + "description": "Required. Impression event details. The maximum number of impression reports that you can log at once is 50.", "items": { "$ref": "GoogleMapsPlayablelocationsV3Impression" }, "type": "array" }, "requestId": { - "description": "Required. A string that uniquely identifies the log impressions request. This allows\nyou to detect duplicate requests. We recommend that you use UUIDs for this\nvalue. The value must not exceed 50 characters.\n\nYou should reuse the `request_id` only when retrying a request in case of\nfailure. In this case, the request must be identical to the one that\nfailed.", + "description": "Required. A string that uniquely identifies the log impressions request. This allows you to detect duplicate requests. We recommend that you use UUIDs for this value. The value must not exceed 50 characters. You should reuse the `request_id` only when retrying a request in case of failure. In this case, the request must be identical to the one that failed.", "type": "string" } }, "type": "object" }, "GoogleMapsPlayablelocationsV3LogImpressionsResponse": { - "description": "A response for the LogImpressions method.\nThis method returns no data upon success.", + "description": "A response for the LogImpressions method. This method returns no data upon success.", "id": "GoogleMapsPlayablelocationsV3LogImpressionsResponse", "properties": {}, "type": "object" @@ -213,34 +213,34 @@ "properties": { "clientInfo": { "$ref": "GoogleMapsUnityClientInfo", - "description": "Required. Information about the client device (for example, device model and\noperating system)." + "description": "Required. Information about the client device (for example, device model and operating system)." }, "playerReports": { - "description": "Required. Player reports. The maximum number of player reports that you can log at\nonce is 50.", + "description": "Required. Player reports. The maximum number of player reports that you can log at once is 50.", "items": { "$ref": "GoogleMapsPlayablelocationsV3PlayerReport" }, "type": "array" }, "requestId": { - "description": "Required. A string that uniquely identifies the log player reports request. This\nallows you to detect duplicate requests. We recommend that you use UUIDs\nfor this value. The value must not exceed 50 characters.\n\nYou should reuse the `request_id` only when retrying a request in the case\nof a failure. In that case, the request must be identical to the one that\nfailed.", + "description": "Required. A string that uniquely identifies the log player reports request. This allows you to detect duplicate requests. We recommend that you use UUIDs for this value. The value must not exceed 50 characters. You should reuse the `request_id` only when retrying a request in the case of a failure. In that case, the request must be identical to the one that failed.", "type": "string" } }, "type": "object" }, "GoogleMapsPlayablelocationsV3LogPlayerReportsResponse": { - "description": "A response for the LogPlayerReports\nmethod.\n\nThis method returns no data upon success.", + "description": "A response for the LogPlayerReports method. This method returns no data upon success.", "id": "GoogleMapsPlayablelocationsV3LogPlayerReportsResponse", "properties": {}, "type": "object" }, "GoogleMapsPlayablelocationsV3PlayerReport": { - "description": "A report submitted by a player about a playable location that is considered\ninappropriate for use in the game.", + "description": "A report submitted by a player about a playable location that is considered inappropriate for use in the game.", "id": "GoogleMapsPlayablelocationsV3PlayerReport", "properties": { "languageCode": { - "description": "Language code (in BCP-47 format) indicating the language of the freeform\ndescription provided in `reason_details`. Examples are \"en\", \"en-US\" or\n\"ja-Latn\". For more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "Language code (in BCP-47 format) indicating the language of the freeform description provided in `reason_details`. Examples are \"en\", \"en-US\" or \"ja-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "locationName": { @@ -248,7 +248,7 @@ "type": "string" }, "reasonDetails": { - "description": "Required. A free-form description detailing why the playable location is\nconsidered bad.", + "description": "Required. A free-form description detailing why the playable location is considered bad.", "type": "string" }, "reasons": { @@ -256,10 +256,10 @@ "enumDescriptions": [ "Unspecified reason. Do not use.", "The reason isn't one of the reasons in this enumeration.", - "The playable location isn't accessible to pedestrians. For example, if\nit's in the middle of a highway.", - "The playable location isn't open to the public. For example, a private\noffice building.", - "The playable location is permanently closed. For example, when a business\nhas been shut down.", - "The playable location is temporarily inaccessible. For example, when a\nbusiness has closed for renovations." + "The playable location isn't accessible to pedestrians. For example, if it's in the middle of a highway.", + "The playable location isn't open to the public. For example, a private office building.", + "The playable location is permanently closed. For example, when a business has been shut down.", + "The playable location is temporarily inaccessible. For example, when a business has closed for renovations." ], "items": { "enum": [ @@ -270,6 +270,14 @@ "PERMANENTLY_CLOSED", "TEMPORARILY_INACCESSIBLE" ], + "enumDescriptions": [ + "Unspecified reason. Do not use.", + "The reason isn't one of the reasons in this enumeration.", + "The playable location isn't accessible to pedestrians. For example, if it's in the middle of a highway.", + "The playable location isn't open to the public. For example, a private office building.", + "The playable location is permanently closed. For example, when a business has been shut down.", + "The playable location is temporarily inaccessible. For example, when a business has closed for renovations." + ], "type": "string" }, "type": "array" @@ -282,7 +290,7 @@ "id": "GoogleMapsPlayablelocationsV3SampleAreaFilter", "properties": { "s2CellId": { - "description": "Required. The S2 cell ID of the area you want. This must be between cell level 11 and\n14 (inclusive).\n\nS2 cells are 64-bit integers that identify areas on the Earth. They are\nhierarchical, and can therefore be used for spatial indexing.\n\nThe S2 geometry library is available in a number of languages:\n\n * [C++](https://github.com/google/s2geometry)\n * [Java](https://github.com/google/s2-geometry-library-java)\n * [Go](https://github.com/golang/geo)\n * [Python](https://github.com/google/s2geometry/tree/master/src/python)", + "description": "Required. The S2 cell ID of the area you want. This must be between cell level 11 and 14 (inclusive). S2 cells are 64-bit integers that identify areas on the Earth. They are hierarchical, and can therefore be used for spatial indexing. The S2 geometry library is available in a number of languages: * [C++](https://github.com/google/s2geometry) * [Java](https://github.com/google/s2-geometry-library-java) * [Go](https://github.com/golang/geo) * [Python](https://github.com/google/s2geometry/tree/master/src/python)", "format": "uint64", "type": "string" } @@ -290,20 +298,20 @@ "type": "object" }, "GoogleMapsPlayablelocationsV3SampleCriterion": { - "description": "Encapsulates a filter criterion for searching for a set of playable\nlocations.", + "description": "Encapsulates a filter criterion for searching for a set of playable locations.", "id": "GoogleMapsPlayablelocationsV3SampleCriterion", "properties": { "fieldsToReturn": { - "description": "Specifies which `PlayableLocation` fields are returned.\n\n`name` (which is used for logging impressions), `center_point` and\n`place_id` (or `plus_code`) are always returned.\n\nThe following fields are omitted unless you specify them here:\n\n * snapped_point\n * types\n\nNote: The more fields you include, the more expensive in terms of data and\nassociated latency your query will be.", + "description": "Specifies which `PlayableLocation` fields are returned. `name` (which is used for logging impressions), `center_point` and `place_id` (or `plus_code`) are always returned. The following fields are omitted unless you specify them here: * snapped_point * types Note: The more fields you include, the more expensive in terms of data and associated latency your query will be.", "format": "google-fieldmask", "type": "string" }, "filter": { "$ref": "GoogleMapsPlayablelocationsV3SampleFilter", - "description": "Specifies filtering options, and specifies what will be included in the\nresult set." + "description": "Specifies filtering options, and specifies what will be included in the result set." }, "gameObjectType": { - "description": "Required. An arbitrary, developer-defined identifier of the type of game object that\nthe playable location is used for. This field allows you to specify\ncriteria per game object type when searching for playable locations.\n\nYou should assign a unique `game_object_type` ID across all\n`request_criteria` to represent a distinct type of game object. For\nexample, 1=monster location, 2=powerup location.\n\nThe response contains a map.", + "description": "Required. An arbitrary, developer-defined identifier of the type of game object that the playable location is used for. This field allows you to specify criteria per game object type when searching for playable locations. You should assign a unique `game_object_type` ID across all `request_criteria` to represent a distinct type of game object. For example, 1=monster location, 2=powerup location. The response contains a map.", "format": "int32", "type": "integer" } @@ -315,31 +323,31 @@ "id": "GoogleMapsPlayablelocationsV3SampleFilter", "properties": { "includedTypes": { - "description": "Restricts the set of playable locations to just the\n[types](/maps/documentation/gaming/tt/types) that you want.", + "description": "Restricts the set of playable locations to just the [types](/maps/documentation/gaming/tt/types) that you want.", "items": { "type": "string" }, "type": "array" }, "maxLocationCount": { - "description": "Specifies the maximum number of playable locations to return. This value\nmust not be greater than 1000. The default value is 100.\n\nOnly the top-ranking playable locations are returned.", + "description": "Specifies the maximum number of playable locations to return. This value must not be greater than 1000. The default value is 100. Only the top-ranking playable locations are returned.", "format": "int32", "type": "integer" }, "spacing": { "$ref": "GoogleMapsPlayablelocationsV3SampleSpacingOptions", - "description": "A set of options that control the spacing between playable locations. By\ndefault the minimum distance between locations is 200m." + "description": "A set of options that control the spacing between playable locations. By default the minimum distance between locations is 200m." } }, "type": "object" }, "GoogleMapsPlayablelocationsV3SamplePlayableLocation": { - "description": "A geographical point suitable for placing game objects in location-based\ngames.", + "description": "A geographical point suitable for placing game objects in location-based games.", "id": "GoogleMapsPlayablelocationsV3SamplePlayableLocation", "properties": { "centerPoint": { "$ref": "GoogleTypeLatLng", - "description": "Required. The latitude and longitude associated with the center of the playable\nlocation.\n\nBy default, the set of playable locations returned from\nSamplePlayableLocations use\ncenter-point coordinates." + "description": "Required. The latitude and longitude associated with the center of the playable location. By default, the set of playable locations returned from SamplePlayableLocations use center-point coordinates." }, "name": { "description": "Required. The name of this playable location.", @@ -355,10 +363,10 @@ }, "snappedPoint": { "$ref": "GoogleTypeLatLng", - "description": "The playable location's coordinates, snapped to the sidewalk of the\nnearest road, if a nearby road exists." + "description": "The playable location's coordinates, snapped to the sidewalk of the nearest road, if a nearby road exists." }, "types": { - "description": "A collection of [Playable Location\nTypes](/maps/documentation/gaming/tt/types) for this playable location. The\nfirst type in the collection is the primary type.\n\nType information might not be available for all playable locations.", + "description": "A collection of [Playable Location Types](/maps/documentation/gaming/tt/types) for this playable location. The first type in the collection is the primary type. Type information might not be available for all playable locations.", "items": { "type": "string" }, @@ -382,7 +390,7 @@ "type": "object" }, "GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest": { - "description": "\nLife of a query:\n\n- When a game starts in a new location, your game server issues a\nSamplePlayableLocations\nrequest. The request specifies the S2 cell, and contains one or more\n\"criteria\" for filtering:\n\n- Criterion 0: i locations for long-lived bases, or level 0 monsters, or...\n- Criterion 1: j locations for short-lived bases, or level 1 monsters, ...\n- Criterion 2: k locations for random objects.\n- etc (up to 5 criterion may be specified).\n\n`PlayableLocationList` will then contain mutually\nexclusive lists of `PlayableLocation` objects that satisfy each of\nthe criteria. Think of it as a collection of real-world locations that you\ncan then associate with your game state.\n\nNote: These points are impermanent in nature. E.g, parks can close, and\nplaces can be removed.\n\nThe response specifies how long you can expect the playable locations to\nlast. Once they expire, you should query the `samplePlayableLocations` API\nagain to get a fresh view of the real world.", + "description": " Life of a query: - When a game starts in a new location, your game server issues a SamplePlayableLocations request. The request specifies the S2 cell, and contains one or more \"criteria\" for filtering: - Criterion 0: i locations for long-lived bases, or level 0 monsters, or... - Criterion 1: j locations for short-lived bases, or level 1 monsters, ... - Criterion 2: k locations for random objects. - etc (up to 5 criterion may be specified). `PlayableLocationList` will then contain mutually exclusive lists of `PlayableLocation` objects that satisfy each of the criteria. Think of it as a collection of real-world locations that you can then associate with your game state. Note: These points are impermanent in nature. E.g, parks can close, and places can be removed. The response specifies how long you can expect the playable locations to last. Once they expire, you should query the `samplePlayableLocations` API again to get a fresh view of the real world.", "id": "GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest", "properties": { "areaFilter": { @@ -390,7 +398,7 @@ "description": "Required. Specifies the area to search within for playable locations." }, "criteria": { - "description": "Required. Specifies one or more (up to 5) criteria for filtering the\nreturned playable locations.", + "description": "Required. Specifies one or more (up to 5) criteria for filtering the returned playable locations.", "items": { "$ref": "GoogleMapsPlayablelocationsV3SampleCriterion" }, @@ -400,18 +408,18 @@ "type": "object" }, "GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse": { - "description": "\nResponse for the\nSamplePlayableLocations\nmethod.", + "description": " Response for the SamplePlayableLocations method.", "id": "GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse", "properties": { "locationsPerGameObjectType": { "additionalProperties": { "$ref": "GoogleMapsPlayablelocationsV3SamplePlayableLocationList" }, - "description": "Each PlayableLocation object corresponds to a game_object_type specified\nin the request.", + "description": "Each PlayableLocation object corresponds to a game_object_type specified in the request.", "type": "object" }, "ttl": { - "description": "Required. Specifies the \"time-to-live\" for the set of playable locations. You can use\nthis value to determine how long to cache the set of playable locations.\nAfter this length of time, your back-end game server should issue a new\nSamplePlayableLocations\nrequest to get a fresh set of playable locations (because for example, they\nmight have been removed, a park might have closed for the day, a\nbusiness might have closed permanently).", + "description": "Required. Specifies the \"time-to-live\" for the set of playable locations. You can use this value to determine how long to cache the set of playable locations. After this length of time, your back-end game server should issue a new SamplePlayableLocations request to get a fresh set of playable locations (because for example, they might have been removed, a park might have closed for the day, a business might have closed permanently).", "format": "google-duration", "type": "string" } @@ -423,12 +431,12 @@ "id": "GoogleMapsPlayablelocationsV3SampleSpacingOptions", "properties": { "minSpacingMeters": { - "description": "Required. The minimum spacing between any two playable locations, measured in meters.\nThe minimum value is 30.\nThe maximum value is 1000.\n\nInputs will be rounded up to the next 10 meter interval.\n\nThe default value is 200m.\n\nSet this field to remove tight clusters of playable locations.\n\nNote:\n\nThe spacing is a greedy algorithm. It optimizes for selecting the highest\nranking locations first, not to maximize the number of locations selected.\nConsider the following scenario:\n\n * Rank: A: 2, B: 1, C: 3.\n * Distance: A--200m--B--200m--C\n\nIf spacing=250, it will pick the highest ranked location [B], not [A, C].\n\n\nNote:\n\nSpacing works within the game object type itself, as well as the previous\nones.\nSuppose three game object types, each with the following spacing:\n\n * X: 400m, Y: undefined, Z: 200m.\n\n1. Add locations for X, within 400m of each other.\n2. Add locations for Y, without any spacing.\n3. Finally, add locations for Z within 200m of each other as well X and Y.\n\nThe distance diagram between those locations end up as:\n\n * From->To.\n * X->X: 400m\n * Y->X, Y->Y: unspecified.\n * Z->X, Z->Y, Z->Z: 200m.", + "description": "Required. The minimum spacing between any two playable locations, measured in meters. The minimum value is 30. The maximum value is 1000. Inputs will be rounded up to the next 10 meter interval. The default value is 200m. Set this field to remove tight clusters of playable locations. Note: The spacing is a greedy algorithm. It optimizes for selecting the highest ranking locations first, not to maximize the number of locations selected. Consider the following scenario: * Rank: A: 2, B: 1, C: 3. * Distance: A--200m--B--200m--C If spacing=250, it will pick the highest ranked location [B], not [A, C]. Note: Spacing works within the game object type itself, as well as the previous ones. Suppose three game object types, each with the following spacing: * X: 400m, Y: undefined, Z: 200m. 1. Add locations for X, within 400m of each other. 2. Add locations for Y, without any spacing. 3. Finally, add locations for Z within 200m of each other as well X and Y. The distance diagram between those locations end up as: * From->To. * X->X: 400m * Y->X, Y->Y: unspecified. * Z->X, Z->Y, Z->Z: 200m.", "format": "double", "type": "number" }, "pointType": { - "description": "Specifies whether the minimum spacing constraint applies to the\ncenter-point or to the snapped point of playable locations. The default\nvalue is `CENTER_POINT`.\n\nIf a snapped point is not available for a playable location, its\ncenter-point is used instead.\n\nSet this to the point type used in your game.", + "description": "Specifies whether the minimum spacing constraint applies to the center-point or to the snapped point of playable locations. The default value is `CENTER_POINT`. If a snapped point is not available for a playable location, its center-point is used instead. Set this to the point type used in your game.", "enum": [ "POINT_TYPE_UNSPECIFIED", "CENTER_POINT", @@ -437,7 +445,7 @@ "enumDescriptions": [ "Unspecified point type. Do not use this value.", "The geographic coordinates correspond to the center of the location.", - "The geographic coordinates correspond to the location snapped to the\nsidewalk of the nearest road (when a nearby road exists)." + "The geographic coordinates correspond to the location snapped to the sidewalk of the nearest road (when a nearby road exists)." ], "type": "string" } @@ -449,31 +457,31 @@ "id": "GoogleMapsUnityClientInfo", "properties": { "apiClient": { - "description": "API client name and version. For example, the SDK calling the API. The\nexact format is up to the client.", + "description": "API client name and version. For example, the SDK calling the API. The exact format is up to the client.", "type": "string" }, "applicationId": { - "description": "Application ID, such as the package name on Android and the bundle\nidentifier on iOS platforms.", + "description": "Application ID, such as the package name on Android and the bundle identifier on iOS platforms.", "type": "string" }, "applicationVersion": { - "description": "Application version number, such as \"1.2.3\". The exact format is\napplication-dependent.", + "description": "Application version number, such as \"1.2.3\". The exact format is application-dependent.", "type": "string" }, "deviceModel": { - "description": "Device model as reported by the device. The exact format is\nplatform-dependent.", + "description": "Device model as reported by the device. The exact format is platform-dependent.", "type": "string" }, "languageCode": { - "description": "Language code (in BCP-47 format) indicating the UI language of the client.\nExamples are \"en\", \"en-US\" or \"ja-Latn\". For more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "Language code (in BCP-47 format) indicating the UI language of the client. Examples are \"en\", \"en-US\" or \"ja-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "operatingSystem": { - "description": "Operating system name and version as reported by the OS. For example,\n\"Mac OS X 10.10.4\". The exact format is platform-dependent.", + "description": "Operating system name and version as reported by the OS. For example, \"Mac OS X 10.10.4\". The exact format is platform-dependent.", "type": "string" }, "operatingSystemBuild": { - "description": "Build number/version of the operating system. e.g., the contents of\nandroid.os.Build.ID in Android, or the contents of sysctl \"kern.osversion\"\nin iOS.", + "description": "Build number/version of the operating system. e.g., the contents of android.os.Build.ID in Android, or the contents of sysctl \"kern.osversion\" in iOS.", "type": "string" }, "platform": { @@ -504,7 +512,7 @@ "type": "object" }, "GoogleTypeLatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\nWGS84\nstandard. Values must be within normalized ranges.", + "description": "An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", "id": "GoogleTypeLatLng", "properties": { "latitude": { diff --git a/discovery/vectortile-v1.json b/discovery/vectortile-v1.json index ba16e1f344..abfaf5a97a 100644 --- a/discovery/vectortile-v1.json +++ b/discovery/vectortile-v1.json @@ -3,7 +3,7 @@ "baseUrl": "https://vectortile.googleapis.com/", "batchPath": "batch", "canonicalName": "Semantic Tile", - "description": "Serves vector tiles containing geospatial data.\n", + "description": "Serves vector tiles containing geospatial data. ", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/maps/contact-sales/", "fullyEncodeReservedExpansion": true, @@ -108,27 +108,27 @@ ], "parameters": { "clientInfo.apiClient": { - "description": "API client name and version. For example, the SDK calling the API. The\nexact format is up to the client.", + "description": "API client name and version. For example, the SDK calling the API. The exact format is up to the client.", "location": "query", "type": "string" }, "clientInfo.applicationId": { - "description": "Application ID, such as the package name on Android and the bundle\nidentifier on iOS platforms.", + "description": "Application ID, such as the package name on Android and the bundle identifier on iOS platforms.", "location": "query", "type": "string" }, "clientInfo.applicationVersion": { - "description": "Application version number, such as \"1.2.3\". The exact format is\napplication-dependent.", + "description": "Application version number, such as \"1.2.3\". The exact format is application-dependent.", "location": "query", "type": "string" }, "clientInfo.deviceModel": { - "description": "Device model as reported by the device. The exact format is\nplatform-dependent.", + "description": "Device model as reported by the device. The exact format is platform-dependent.", "location": "query", "type": "string" }, "clientInfo.operatingSystem": { - "description": "Operating system name and version as reported by the OS. For example,\n\"Mac OS X 10.10.4\". The exact format is platform-dependent.", + "description": "Operating system name and version as reported by the OS. For example, \"Mac OS X 10.10.4\". The exact format is platform-dependent.", "location": "query", "type": "string" }, @@ -144,31 +144,41 @@ "IOS", "WEB_GL" ], + "enumDescriptions": [ + "Unspecified or unknown OS.", + "Development environment.", + "macOS.", + "Windows.", + "Linux", + "Android", + "iOS", + "WebGL." + ], "location": "query", "type": "string" }, "clientInfo.userId": { - "description": "A client-generated user ID. The ID should be generated and persisted during\nthe first user session or whenever a pre-existing ID is not found. The\nexact format is up to the client. This must be non-empty in a\nGetFeatureTileRequest (whether via the header or\nGetFeatureTileRequest.client_info).", + "description": "Required. A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.client_info).", "location": "query", "type": "string" }, "clientTileVersionId": { - "description": "Optional version id identifying the tile that is already in the client's\ncache. This field should be populated with the most recent version_id value\nreturned by the API for the requested tile.\n\nIf the version id is empty the server always returns a newly rendered tile.\nIf it is provided the server checks if the tile contents would be identical\nto one that's already on the client, and if so, returns a stripped-down\nresponse tile with STATUS_OK_DATA_UNCHANGED instead.", + "description": "Optional version id identifying the tile that is already in the client's cache. This field should be populated with the most recent version_id value returned by the API for the requested tile. If the version id is empty the server always returns a newly rendered tile. If it is provided the server checks if the tile contents would be identical to one that's already on the client, and if so, returns a stripped-down response tile with STATUS_OK_DATA_UNCHANGED instead.", "location": "query", "type": "string" }, "enableDetailedHighwayTypes": { - "description": "Flag indicating whether detailed highway types should be returned. If this\nis set, the CONTROLLED_ACCESS_HIGHWAY type may be returned. If not, then\nthese highways will have the generic HIGHWAY type.\n\nThis exists for backwards compatibility reasons.", + "description": "Flag indicating whether detailed highway types should be returned. If this is set, the CONTROLLED_ACCESS_HIGHWAY type may be returned. If not, then these highways will have the generic HIGHWAY type. This exists for backwards compatibility reasons.", "location": "query", "type": "boolean" }, "enableFeatureNames": { - "description": "Flag indicating whether human-readable names should be returned for\nfeatures. If this is set, the display_name field on the feature will be\nfilled out.", + "description": "Flag indicating whether human-readable names should be returned for features. If this is set, the display_name field on the feature will be filled out.", "location": "query", "type": "boolean" }, "enableModeledVolumes": { - "description": "Flag indicating whether 3D building models should be enabled. If this is\nset structures will be returned as 3D modeled volumes rather than 2.5D\nextruded areas where possible.", + "description": "Flag indicating whether 3D building models should be enabled. If this is set structures will be returned as 3D modeled volumes rather than 2.5D extruded areas where possible.", "location": "query", "type": "boolean" }, @@ -178,29 +188,29 @@ "type": "boolean" }, "enablePrivateRoads": { - "description": "Flag indicating whether the returned tile will contain road features that\nare marked private. Private roads are indicated by the\nFeature.segment_info.road_info.is_private field.", + "description": "Flag indicating whether the returned tile will contain road features that are marked private. Private roads are indicated by the Feature.segment_info.road_info.is_private field.", "location": "query", "type": "boolean" }, "enableUnclippedBuildings": { - "description": "Flag indicating whether unclipped buildings should be returned. If this is\nset, building render ops will extend beyond the tile boundary. Buildings\nwill only be returned on the tile that contains their centroid.", + "description": "Flag indicating whether unclipped buildings should be returned. If this is set, building render ops will extend beyond the tile boundary. Buildings will only be returned on the tile that contains their centroid.", "location": "query", "type": "boolean" }, "languageCode": { - "description": "Required. The BCP-47 language code corresponding to the language in which\nthe name was requested, such as \"en-US\" or \"sr-Latn\".\n\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "Required. The BCP-47 language code corresponding to the language in which the name was requested, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "location": "query", "type": "string" }, "name": { - "description": "Required. Resource name of the tile. The tile resource name is prefixed by\nits collection ID `tiles/` followed by the resource ID, which encodes the\ntile's global x and y coordinates and zoom level as `@,,z`.\nFor example, `tiles/@1,2,3z`.", + "description": "Required. Resource name of the tile. The tile resource name is prefixed by its collection ID `tiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `tiles/@1,2,3z`.", "location": "path", "pattern": "^featuretiles/[^/]+$", "required": true, "type": "string" }, "regionCode": { - "description": "Required. The Unicode country/region code (CLDR) of the location from which\nthe request is coming from, such as \"US\" and \"419\".\n\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#unicode_region_subtag.", + "description": "Required. The Unicode country/region code (CLDR) of the location from which the request is coming from, such as \"US\" and \"419\". For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag.", "location": "query", "type": "string" } @@ -224,33 +234,33 @@ ], "parameters": { "altitudePrecisionCentimeters": { - "description": "The precision of terrain altitudes in centimeters.\nPossible values: between 1 (cm level precision) and 1,000,000 (10-kilometer\nlevel precision).", + "description": "The precision of terrain altitudes in centimeters. Possible values: between 1 (cm level precision) and 1,000,000 (10-kilometer level precision).", "format": "int32", "location": "query", "type": "integer" }, "clientInfo.apiClient": { - "description": "API client name and version. For example, the SDK calling the API. The\nexact format is up to the client.", + "description": "API client name and version. For example, the SDK calling the API. The exact format is up to the client.", "location": "query", "type": "string" }, "clientInfo.applicationId": { - "description": "Application ID, such as the package name on Android and the bundle\nidentifier on iOS platforms.", + "description": "Application ID, such as the package name on Android and the bundle identifier on iOS platforms.", "location": "query", "type": "string" }, "clientInfo.applicationVersion": { - "description": "Application version number, such as \"1.2.3\". The exact format is\napplication-dependent.", + "description": "Application version number, such as \"1.2.3\". The exact format is application-dependent.", "location": "query", "type": "string" }, "clientInfo.deviceModel": { - "description": "Device model as reported by the device. The exact format is\nplatform-dependent.", + "description": "Device model as reported by the device. The exact format is platform-dependent.", "location": "query", "type": "string" }, "clientInfo.operatingSystem": { - "description": "Operating system name and version as reported by the OS. For example,\n\"Mac OS X 10.10.4\". The exact format is platform-dependent.", + "description": "Operating system name and version as reported by the OS. For example, \"Mac OS X 10.10.4\". The exact format is platform-dependent.", "location": "query", "type": "string" }, @@ -266,28 +276,38 @@ "IOS", "WEB_GL" ], + "enumDescriptions": [ + "Unspecified or unknown OS.", + "Development environment.", + "macOS.", + "Windows.", + "Linux", + "Android", + "iOS", + "WebGL." + ], "location": "query", "type": "string" }, "clientInfo.userId": { - "description": "A client-generated user ID. The ID should be generated and persisted during\nthe first user session or whenever a pre-existing ID is not found. The\nexact format is up to the client. This must be non-empty in a\nGetFeatureTileRequest (whether via the header or\nGetFeatureTileRequest.client_info).", + "description": "Required. A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.client_info).", "location": "query", "type": "string" }, "maxElevationResolutionCells": { - "description": "The maximum allowed resolution for the returned elevation heightmap.\nPossible values: between 1 and 1024 (and not less than\nmin_elevation_resolution_cells).\nOver-sized heightmaps will be non-uniformly down-sampled such that each\nedge is no longer than this value. Non-uniformity is chosen to maximise the\namount of preserved data.\n\nFor example:\nOriginal resolution: 100px (width) * 30px (height)\nmax_elevation_resolution: 30\nNew resolution: 30px (width) * 30px (height)", + "description": "The maximum allowed resolution for the returned elevation heightmap. Possible values: between 1 and 1024 (and not less than min_elevation_resolution_cells). Over-sized heightmaps will be non-uniformly down-sampled such that each edge is no longer than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 100px (width) * 30px (height) max_elevation_resolution: 30 New resolution: 30px (width) * 30px (height)", "format": "int32", "location": "query", "type": "integer" }, "minElevationResolutionCells": { - "description": "The minimum allowed resolution for the returned elevation heightmap.\nPossible values: between 0 and 1024 (and not more than\nmax_elevation_resolution_cells). Zero is supported for backward\ncompatibility.\nUnder-sized heightmaps will be non-uniformly up-sampled\nsuch that each edge is no shorter than this value. Non-uniformity is chosen\nto maximise the amount of preserved data.\n\nFor example:\nOriginal resolution: 30px (width) * 10px (height)\nmin_elevation_resolution: 30\nNew resolution: 30px (width) * 30px (height)", + "description": "The minimum allowed resolution for the returned elevation heightmap. Possible values: between 0 and 1024 (and not more than max_elevation_resolution_cells). Zero is supported for backward compatibility. Under-sized heightmaps will be non-uniformly up-sampled such that each edge is no shorter than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 30px (width) * 10px (height) min_elevation_resolution: 30 New resolution: 30px (width) * 30px (height)", "format": "int32", "location": "query", "type": "integer" }, "name": { - "description": "Required. Resource name of the tile. The tile resource name is prefixed by\nits collection ID `terraintiles/` followed by the resource ID, which\nencodes the tile's global x and y coordinates and zoom level as\n`@,,z`. For example, `terraintiles/@1,2,3z`.", + "description": "Required. Resource name of the tile. The tile resource name is prefixed by its collection ID `terraintiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `terraintiles/@1,2,3z`.", "location": "path", "pattern": "^terraintiles/[^/]+$", "required": true, @@ -300,6 +320,11 @@ "FIRST_DERIVATIVE", "SECOND_DERIVATIVE" ], + "enumDescriptions": [ + "An unknown or unspecified terrain format.", + "Terrain elevation data encoded as a FirstDerivativeElevationGrid. .", + "Terrain elevation data encoded as a SecondDerivativeElevationGrid." + ], "location": "query", "repeated": true, "type": "string" @@ -313,7 +338,7 @@ } } }, - "revision": "20200709", + "revision": "20200808", "rootUrl": "https://vectortile.googleapis.com/", "schemas": { "Area": { @@ -321,11 +346,11 @@ "id": "Area", "properties": { "hasExternalEdges": { - "description": "True if the polygon is not entirely internal to the feature that it belongs\nto: that is, some of the edges are bordering another feature.", + "description": "True if the polygon is not entirely internal to the feature that it belongs to: that is, some of the edges are bordering another feature.", "type": "boolean" }, "internalEdges": { - "description": "When has_external_edges is true, the polygon has some edges that border\nanother feature. This field indicates the internal edges that do not border\nanother feature. Each value is an index into the vertices array, and\ndenotes the start vertex of the internal edge (the next vertex in the\nboundary loop is the end of the edge). If the selected vertex is the last\nvertex in the boundary loop, then the edge between that vertex and the\nstarting vertex of the loop is internal.\n\nThis field may be used for styling. For example, building parapets could be\nplaced only on the external edges of a building polygon, or water could be\nlighter colored near the external edges of a body of water.\n\nIf has_external_edges is false, all edges are internal and this field will\nbe empty.", + "description": "When has_external_edges is true, the polygon has some edges that border another feature. This field indicates the internal edges that do not border another feature. Each value is an index into the vertices array, and denotes the start vertex of the internal edge (the next vertex in the boundary loop is the end of the edge). If the selected vertex is the last vertex in the boundary loop, then the edge between that vertex and the starting vertex of the loop is internal. This field may be used for styling. For example, building parapets could be placed only on the external edges of a building polygon, or water could be lighter colored near the external edges of a body of water. If has_external_edges is false, all edges are internal and this field will be empty.", "items": { "format": "int32", "type": "integer" @@ -333,7 +358,7 @@ "type": "array" }, "loopBreaks": { - "description": "Identifies the boundary loops of the polygon. Only set for INDEXED_TRIANGLE\npolygons. Each value is an index into the vertices array indicating the\nbeginning of a loop. For instance, values of [2, 5] would indicate\nloop_data contained 3 loops with indices 0-1, 2-4, and 5-end.\n\nThis may be used in conjunction with the internal_edges field for styling\npolygon boundaries. Note that an edge may be on a polygon boundary but\nstill internal to the feature. For example, a feature split across multiple\ntiles will have an internal polygon boundary edge along the edge of the\ntile.", + "description": "Identifies the boundary loops of the polygon. Only set for INDEXED_TRIANGLE polygons. Each value is an index into the vertices array indicating the beginning of a loop. For instance, values of [2, 5] would indicate loop_data contained 3 loops with indices 0-1, 2-4, and 5-end. This may be used in conjunction with the internal_edges field for styling polygon boundaries. Note that an edge may be on a polygon boundary but still internal to the feature. For example, a feature split across multiple tiles will have an internal polygon boundary edge along the edge of the tile.", "items": { "format": "int32", "type": "integer" @@ -341,7 +366,7 @@ "type": "array" }, "triangleIndices": { - "description": "When the polygon encoding is of type INDEXED_TRIANGLES, this contains the\nindices of the triangle vertices in the vertex_offsets field. There are 3\nvertex indices per triangle.", + "description": "When the polygon encoding is of type INDEXED_TRIANGLES, this contains the indices of the triangle vertices in the vertex_offsets field. There are 3 vertex indices per triangle.", "items": { "format": "int32", "type": "integer" @@ -356,9 +381,9 @@ "TRIANGLE_STRIP" ], "enumDescriptions": [ - "The first vertex in vertex_offset is the center of a triangle fan. The\nother vertices are arranged around this vertex in a fan shape. The\nfollowing diagram showes a triangle fan polygon with the vertices\nlabelled with their indices in the vertex_offset list.\n\nTriangle fan polygons always have a single boundary loop.\n\nVertices may be in either a clockwise or counterclockwise order.\n\n (1)\n / \\\n / \\\n / \\\n (0)-----(2)\n / \\ /\n / \\ /\n / \\ /\n (4)-----(3)", - "The polygon is a set of triangles with three vertex indices per triangle.\nThe vertex indices can be found in the triangle_indices field.\n\nIndexed triangle polygons also contain information about boundary loops.\nThese identify the loops at the boundary of the polygon and may be used\nin conjunction with the internal_edges field for styling. Boundary loops\nmay represent either a hole or a disconnected component of the polygon.\n\nThe following diagram shows an indexed triangle polygon with two boundary\nloops.\n\n (0) (4)\n / \\ / \\\n / \\ / \\\n (1)----(2) (3)----(5)", - "A strip of triangles, where each triangle uses the last edge of the\nprevious triangle.\n\nVertices may be in either a clockwise or counterclockwise order.\n\nOnly polygons without the has_external_edges flag set will use triangle\nstrips.\n\n (0)\n / \\\n / \\\n / \\\n (2)-----(1)\n / \\ /\n / \\ /\n / \\ /\n (4)-----(3)" + "The first vertex in vertex_offset is the center of a triangle fan. The other vertices are arranged around this vertex in a fan shape. The following diagram showes a triangle fan polygon with the vertices labelled with their indices in the vertex_offset list. Triangle fan polygons always have a single boundary loop. Vertices may be in either a clockwise or counterclockwise order. (1) / \\ / \\ / \\ (0)-----(2) / \\ / / \\ / / \\ / (4)-----(3)", + "The polygon is a set of triangles with three vertex indices per triangle. The vertex indices can be found in the triangle_indices field. Indexed triangle polygons also contain information about boundary loops. These identify the loops at the boundary of the polygon and may be used in conjunction with the internal_edges field for styling. Boundary loops may represent either a hole or a disconnected component of the polygon. The following diagram shows an indexed triangle polygon with two boundary loops. (0) (4) / \\ / \\ / \\ / \\ (1)----(2) (3)----(5)", + "A strip of triangles, where each triangle uses the last edge of the previous triangle. Vertices may be in either a clockwise or counterclockwise order. Only polygons without the has_external_edges flag set will use triangle strips. (0) / \\ / \\ / \\ (2)-----(1) / \\ / / \\ / / \\ / (4)-----(3)" ], "type": "string" }, @@ -367,7 +392,7 @@ "description": "The vertices present in the polygon defining the area." }, "zOrder": { - "description": "The z-ordering of this area. Areas with a lower z-order should be rendered\nbeneath areas with a higher z-order. This z-ordering does not imply\nanything about the altitude of the line relative to the ground, but it\ncan be used to prevent z-fighting during rendering on the client. This\nz-ordering can only be used to compare areas, and cannot be compared with\nthe z_order field in the Line message.\n\nThe z-order may be negative or zero.", + "description": "The z-ordering of this area. Areas with a lower z-order should be rendered beneath areas with a higher z-order. This z-ordering does not imply anything about the altitude of the line relative to the ground, but it can be used to prevent z-fighting during rendering on the client. This z-ordering can only be used to compare areas, and cannot be compared with the z_order field in the Line message. The z-order may be negative or zero.", "format": "int32", "type": "integer" } @@ -375,7 +400,7 @@ "type": "object" }, "ExtrudedArea": { - "description": "Represents a height-extruded area: a 3D prism with a constant X-Y plane cross\nsection. Used to represent extruded buildings. A single building may consist\nof several extruded areas.\n\nThe min_z and max_z fields are scaled to the size of the tile. An extruded\narea with a max_z value of 4096 has the same height as the width of the tile\nthat it is on.", + "description": "Represents a height-extruded area: a 3D prism with a constant X-Y plane cross section. Used to represent extruded buildings. A single building may consist of several extruded areas. The min_z and max_z fields are scaled to the size of the tile. An extruded area with a max_z value of 4096 has the same height as the width of the tile that it is on.", "id": "ExtrudedArea", "properties": { "area": { @@ -388,7 +413,7 @@ "type": "integer" }, "minZ": { - "description": "The z-value in local tile coordinates where the extruded area begins. This\nis non-zero for extruded areas that begin off the ground. For example, a\nbuilding with a skybridge may have an extruded area component with a\nnon-zero min_z.", + "description": "The z-value in local tile coordinates where the extruded area begins. This is non-zero for extruded areas that begin off the ground. For example, a building with a skybridge may have an extruded area component with a non-zero min_z.", "format": "int32", "type": "integer" } @@ -405,10 +430,10 @@ }, "geometry": { "$ref": "Geometry", - "description": "The geometry of this feature, representing the space that it occupies in\nthe world." + "description": "The geometry of this feature, representing the space that it occupies in the world." }, "placeId": { - "description": "Place ID of this feature, suitable for use in Places API details\nrequests.", + "description": "Place ID of this feature, suitable for use in Places API details requests.", "type": "string" }, "relations": { @@ -466,13 +491,13 @@ "A venue for private and public events.", "Place of interest to tourists, typically for natural or cultural value.", "A structure containing a business or businesses that sell goods.", - "Institution where young people receive general (not vocation or\nprofessional) education.", + "Institution where young people receive general (not vocation or professional) education.", "Segments such as roads and train lines.", "A way leading from one place to another intended for use by vehicles.", "A small city street, typically for travel in a residential neighborhood.", "Major through road that's expected to carry large volumes of traffic.", "A major road including freeways and state highways.", - "A highway with grade-separated crossings that is accessed exclusively by\nramps. These are usually called \"freeways\" or \"motorways\".\n\nThe enable_detailed_highway_types request flag must be set in order for\nthis type to be returned.", + "A highway with grade-separated crossings that is accessed exclusively by ramps. These are usually called \"freeways\" or \"motorways\". The enable_detailed_highway_types request flag must be set in order for this type to be returned.", "A path that's primarily intended for use by pedestrians and/or cyclists.", "Tracks intended for use by trains.", "Services which are part of the road network but are not roads.", @@ -492,7 +517,7 @@ "type": "object" }, "FeatureTile": { - "description": "A tile containing information about the map features located in the region it\ncovers.", + "description": "A tile containing information about the map features located in the region it covers.", "id": "FeatureTile", "properties": { "coordinates": { @@ -507,7 +532,7 @@ "type": "array" }, "name": { - "description": "Resource name of the tile. The tile resource name is prefixed by its\ncollection ID `tiles/` followed by the resource ID, which encodes the\ntile's global x and y coordinates and zoom level as `@,,z`. For\nexample, `tiles/@1,2,3z`.", + "description": "Resource name of the tile. The tile resource name is prefixed by its collection ID `tiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `tiles/@1,2,3z`.", "type": "string" }, "providers": { @@ -524,29 +549,29 @@ "STATUS_OK_DATA_UNCHANGED" ], "enumDescriptions": [ - "Everything worked out OK. The cache-control header determines how long\nthis Tile response may be cached by the client. See also version_id and\nSTATUS_OK_DATA_UNCHANGED.", - "Indicates that the request was processed successfully and that the tile\ndata that would have been returned are identical to the data already in\nthe client's cache, as specified by the value of client_tile_version_id\ncontained in GetFeatureTileRequest.\n\nIn particular, the tile's features and providers will not be populated\nwhen the tile data is identical. However, the cache-control header and\nversion_id can still change even when the tile contents itself does not,\nso clients should always use the most recent values returned by the API." + "Everything worked out OK. The cache-control header determines how long this Tile response may be cached by the client. See also version_id and STATUS_OK_DATA_UNCHANGED.", + "Indicates that the request was processed successfully and that the tile data that would have been returned are identical to the data already in the client's cache, as specified by the value of client_tile_version_id contained in GetFeatureTileRequest. In particular, the tile's features and providers will not be populated when the tile data is identical. However, the cache-control header and version_id can still change even when the tile contents itself does not, so clients should always use the most recent values returned by the API." ], "type": "string" }, "versionId": { - "description": "An opaque value, usually less than 30 characters, that contains version\ninfo about this tile and the data that was used to generate it.\n\nThe client should store this value in its tile cache and pass it back to\nthe API in the client_tile_version_id field of subsequent tile requests in\norder to enable the API to detect when the new tile would be the same as\nthe one the client already has in its cache.\n\nAlso see STATUS_OK_DATA_UNCHANGED.", + "description": "An opaque value, usually less than 30 characters, that contains version info about this tile and the data that was used to generate it. The client should store this value in its tile cache and pass it back to the API in the client_tile_version_id field of subsequent tile requests in order to enable the API to detect when the new tile would be the same as the one the client already has in its cache. Also see STATUS_OK_DATA_UNCHANGED.", "type": "string" } }, "type": "object" }, "FirstDerivativeElevationGrid": { - "description": "A packed representation of a 2D grid of uniformly spaced points containing\nelevation data. Each point within the grid represents the altitude in\nmeters above average sea level at that location within the tile.\n\nElevations provided are (generally) relative to the EGM96 geoid, however\nsome areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more\nthan 2 meters.\n\nThe grid is oriented north-west to south-east, as illustrated:\n\n rows[0].a[0] rows[0].a[m]\n +-----------------+\n | |\n | N |\n | ^ |\n | | |\n | W <-----> E |\n | | |\n | v |\n | S |\n | |\n +-----------------+\n rows[n].a[0] rows[n].a[m]\n\nRather than storing the altitudes directly, we store the diffs between them\nas integers at some requested level of precision to take advantage of\ninteger packing. The actual altitude values a[] can be reconstructed using\nthe scale and each row's first_altitude and altitude_diff fields.", + "description": "A packed representation of a 2D grid of uniformly spaced points containing elevation data. Each point within the grid represents the altitude in meters above average sea level at that location within the tile. Elevations provided are (generally) relative to the EGM96 geoid, however some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0].a[m] +-----------------+ | | | N | | ^ | | | | | W <-----> E | | | | | v | | S | | | +-----------------+ rows[n].a[0] rows[n].a[m] Rather than storing the altitudes directly, we store the diffs between them as integers at some requested level of precision to take advantage of integer packing. The actual altitude values a[] can be reconstructed using the scale and each row's first_altitude and altitude_diff fields.", "id": "FirstDerivativeElevationGrid", "properties": { "altitudeMultiplier": { - "description": "A multiplier applied to the altitude fields below to extract the actual\naltitudes in meters from the elevation grid.", + "description": "A multiplier applied to the altitude fields below to extract the actual altitudes in meters from the elevation grid.", "format": "float", "type": "number" }, "rows": { - "description": "Rows of points containing altitude data making up the elevation grid.\nEach row is the same length. Rows are ordered from north to south. E.g:\nrows[0] is the north-most row, and rows[n] is the south-most row.", + "description": "Rows of points containing altitude data making up the elevation grid. Each row is the same length. Rows are ordered from north to south. E.g: rows[0] is the north-most row, and rows[n] is the south-most row.", "items": { "$ref": "Row" }, @@ -556,7 +581,7 @@ "type": "object" }, "Geometry": { - "description": "Represents the geometry of a feature, that is, the shape that it has on the\nmap. The local tile coordinate system has the origin at the north-west\n(upper-left) corner of the tile, and is scaled to 4096 units across each\nedge. The height (Z) axis has the same scale factor: an extruded area with a\nmax_z value of 4096 has the same height as the width of the tile that it is\non.\n\nThere is no clipping boundary, so it is possible that some coordinates will\nlie outside the tile boundaries.", + "description": "Represents the geometry of a feature, that is, the shape that it has on the map. The local tile coordinate system has the origin at the north-west (upper-left) corner of the tile, and is scaled to 4096 units across each edge. The height (Z) axis has the same scale factor: an extruded area with a max_z value of 4096 has the same height as the width of the tile that it is on. There is no clipping boundary, so it is possible that some coordinates will lie outside the tile boundaries.", "id": "Geometry", "properties": { "areas": { @@ -591,7 +616,7 @@ "type": "object" }, "Line": { - "description": "Represents a 2D polyline. Used to represent segments such as roads, train\ntracks, etc.", + "description": "Represents a 2D polyline. Used to represent segments such as roads, train tracks, etc.", "id": "Line", "properties": { "vertexOffsets": { @@ -599,7 +624,7 @@ "description": "The vertices present in the polyline." }, "zOrder": { - "description": "The z-order of the line. Lines with a lower z-order should be rendered\nbeneath lines with a higher z-order. This z-ordering does not imply\nanything about the altitude of the area relative to the ground, but it\ncan be used to prevent z-fighting during rendering on the client. In\ngeneral, larger and more important road features will have a higher z-order\nline associated with them. This z-ordering can only be used to compare\nlines, and cannot be compared with the z_order field in the Area message.\n\nThe z-order may be negative or zero.", + "description": "The z-order of the line. Lines with a lower z-order should be rendered beneath lines with a higher z-order. This z-ordering does not imply anything about the altitude of the area relative to the ground, but it can be used to prevent z-fighting during rendering on the client. In general, larger and more important road features will have a higher z-order line associated with them. This z-ordering can only be used to compare lines, and cannot be compared with the z_order field in the Area message. The z-order may be negative or zero.", "format": "int32", "type": "integer" } @@ -625,7 +650,7 @@ "type": "object" }, "ProviderInfo": { - "description": "Information about the data providers that should be included in the\nattribution string shown by the client.", + "description": "Information about the data providers that should be included in the attribution string shown by the client.", "id": "ProviderInfo", "properties": { "description": { @@ -636,11 +661,11 @@ "type": "object" }, "Relation": { - "description": "Represents a relation to another feature in the tile. For example, a building\nmight be occupied by a given POI. The related feature can be retrieved using\nthe related feature index.", + "description": "Represents a relation to another feature in the tile. For example, a building might be occupied by a given POI. The related feature can be retrieved using the related feature index.", "id": "Relation", "properties": { "relatedFeatureIndex": { - "description": "Zero-based index to look up the related feature from the list of features\nin the tile.", + "description": "Zero-based index to look up the related feature from the list of features in the tile.", "format": "int32", "type": "integer" }, @@ -666,18 +691,18 @@ "id": "RoadInfo", "properties": { "isPrivate": { - "description": "Road has signage discouraging or prohibiting use by the general public.\nE.g., roads with signs that say \"Private\", or \"No trespassing.\"", + "description": "Road has signage discouraging or prohibiting use by the general public. E.g., roads with signs that say \"Private\", or \"No trespassing.\"", "type": "boolean" } }, "type": "object" }, "Row": { - "description": "A row of altitude points in the elevation grid, ordered from west to\neast.", + "description": "A row of altitude points in the elevation grid, ordered from west to east.", "id": "Row", "properties": { "altitudeDiffs": { - "description": "The difference between each successive pair of altitudes, from west to\neast. The first, westmost point, is just the altitude rather than a\ndiff. The units are specified by the altitude_multiplier parameter\nabove; the value in meters is given by altitude_multiplier *\naltitude_diffs[n]. The altitude row (in metres above sea level) can be\nreconstructed with: a[0] = altitude_diffs[0] * altitude_multiplier when\nn > 0, a[n] = a[n-1] + altitude_diffs[n-1] * altitude_multiplier.", + "description": "The difference between each successive pair of altitudes, from west to east. The first, westmost point, is just the altitude rather than a diff. The units are specified by the altitude_multiplier parameter above; the value in meters is given by altitude_multiplier * altitude_diffs[n]. The altitude row (in metres above sea level) can be reconstructed with: a[0] = altitude_diffs[0] * altitude_multiplier when n > 0, a[n] = a[n-1] + altitude_diffs[n-1] * altitude_multiplier.", "items": { "format": "int32", "type": "integer" @@ -688,26 +713,26 @@ "type": "object" }, "SecondDerivativeElevationGrid": { - "description": "A packed representation of a 2D grid of uniformly spaced points containing\nelevation data. Each point within the grid represents the altitude in\nmeters above average sea level at that location within the tile.\n\nElevations provided are (generally) relative to the EGM96 geoid, however\nsome areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more\nthan 2 meters.\n\nThe grid is oriented north-west to south-east, as illustrated:\n\n rows[0].a[0] rows[0].a[m]\n +-----------------+\n | |\n | N |\n | ^ |\n | | |\n | W <-----> E |\n | | |\n | v |\n | S |\n | |\n +-----------------+\n rows[n].a[0] rows[n].a[m]\n\nRather than storing the altitudes directly, we store the diffs of the diffs\nbetween them as integers at some requested level of precision to take\nadvantage of integer packing.\n\nNote that the data is packed in such a way that is fast to decode in\nUnity and that further optimizes wire size.", + "description": "A packed representation of a 2D grid of uniformly spaced points containing elevation data. Each point within the grid represents the altitude in meters above average sea level at that location within the tile. Elevations provided are (generally) relative to the EGM96 geoid, however some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0].a[m] +-----------------+ | | | N | | ^ | | | | | W <-----> E | | | | | v | | S | | | +-----------------+ rows[n].a[0] rows[n].a[m] Rather than storing the altitudes directly, we store the diffs of the diffs between them as integers at some requested level of precision to take advantage of integer packing. Note that the data is packed in such a way that is fast to decode in Unity and that further optimizes wire size.", "id": "SecondDerivativeElevationGrid", "properties": { "altitudeMultiplier": { - "description": "A multiplier applied to the elements in the encoded data to extract the\nactual altitudes in meters.", + "description": "A multiplier applied to the elements in the encoded data to extract the actual altitudes in meters.", "format": "float", "type": "number" }, "columnCount": { - "description": "The number of columns included in the encoded elevation data (i.e. the\nhorizontal resolution of the grid).", + "description": "The number of columns included in the encoded elevation data (i.e. the horizontal resolution of the grid).", "format": "int32", "type": "integer" }, "encodedData": { - "description": "A stream of elements each representing a point on the tile running across\neach row from left to right, top to bottom.\n\nThere will be precisely horizontal_resolution * vertical_resolution\nelements in the stream.\n\nThe elements are not the heights, rather the second order derivative of\nthe values one would expect in a stream of height data.\n\nEach element is a varint with the following encoding:\n------------------------------------------------------------------------|\n| Head Nibble |\n------------------------------------------------------------------------|\n| Bit 0 | Bit 1 | Bits 2-3 |\n| Terminator| Sign (1=neg) | Least significant 2 bits of absolute error |\n------------------------------------------------------------------------|\n| Tail Nibble #1 |\n------------------------------------------------------------------------|\n| Bit 0 | Bit 1-3 |\n| Terminator| Least significant 3 bits of absolute error |\n------------------------------------------------------------------------|\n| ...\n| Tail Nibble #n |\n------------------------------------------------------------------------|\n| Bit 0 | Bit 1-3 |\n| Terminator| Least significant 3 bits of absolute error |\n------------------------------------------------------------------------|", + "description": "A stream of elements each representing a point on the tile running across each row from left to right, top to bottom. There will be precisely horizontal_resolution * vertical_resolution elements in the stream. The elements are not the heights, rather the second order derivative of the values one would expect in a stream of height data. Each element is a varint with the following encoding: ------------------------------------------------------------------------| | Head Nibble | ------------------------------------------------------------------------| | Bit 0 | Bit 1 | Bits 2-3 | | Terminator| Sign (1=neg) | Least significant 2 bits of absolute error | ------------------------------------------------------------------------| | Tail Nibble #1 | ------------------------------------------------------------------------| | Bit 0 | Bit 1-3 | | Terminator| Least significant 3 bits of absolute error | ------------------------------------------------------------------------| | ... | Tail Nibble #n | ------------------------------------------------------------------------| | Bit 0 | Bit 1-3 | | Terminator| Least significant 3 bits of absolute error | ------------------------------------------------------------------------|", "format": "byte", "type": "string" }, "rowCount": { - "description": "The number of rows included in the encoded elevation data (i.e. the\nvertical resolution of the grid).", + "description": "The number of rows included in the encoded elevation data (i.e. the vertical resolution of the grid).", "format": "int32", "type": "integer" } @@ -726,7 +751,7 @@ "type": "object" }, "TerrainTile": { - "description": "A tile containing information about the terrain located in the region it\ncovers.", + "description": "A tile containing information about the terrain located in the region it covers.", "id": "TerrainTile", "properties": { "coordinates": { @@ -738,18 +763,18 @@ "description": "Terrain elevation data encoded as a FirstDerivativeElevationGrid." }, "name": { - "description": "Resource name of the tile. The tile resource name is prefixed by its\ncollection ID `terrain/` followed by the resource ID, which encodes the\ntile's global x and y coordinates and zoom level as `@,,z`.\nFor example, `terrain/@1,2,3z`.", + "description": "Resource name of the tile. The tile resource name is prefixed by its collection ID `terrain/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `terrain/@1,2,3z`.", "type": "string" }, "secondDerivative": { "$ref": "SecondDerivativeElevationGrid", - "description": "Terrain elevation data encoded as a SecondDerivativeElevationGrid.\n." + "description": "Terrain elevation data encoded as a SecondDerivativeElevationGrid. ." } }, "type": "object" }, "TileCoordinates": { - "description": "Global tile coordinates. Global tile coordinates reference a specific tile on\nthe map at a specific zoom level.\n\nThe origin of this coordinate system is always at the northwest corner of the\nmap, with x values increasing from west to east and y values increasing from\nnorth to south. Tiles are indexed using x, y coordinates from that origin.\nThe zoom level containing the entire world in a tile is 0, and it increases\nas you zoom in. Zoom level n + 1 will contain 4 times as many tiles as zoom\nlevel n.\n\nThe zoom level controls the level of detail of the data that is returned. In\nparticular, this affects the set of feature types returned, their density,\nand geometry simplification. The exact tile contents may change over time,\nbut care will be taken to keep supporting the most important use cases. For\nexample, zoom level 15 shows roads for orientation and planning in the local\nneighborhood and zoom level 17 shows buildings to give users on foot a sense\nof situational awareness.", + "description": "Global tile coordinates. Global tile coordinates reference a specific tile on the map at a specific zoom level. The origin of this coordinate system is always at the northwest corner of the map, with x values increasing from west to east and y values increasing from north to south. Tiles are indexed using x, y coordinates from that origin. The zoom level containing the entire world in a tile is 0, and it increases as you zoom in. Zoom level n + 1 will contain 4 times as many tiles as zoom level n. The zoom level controls the level of detail of the data that is returned. In particular, this affects the set of feature types returned, their density, and geometry simplification. The exact tile contents may change over time, but care will be taken to keep supporting the most important use cases. For example, zoom level 15 shows roads for orientation and planning in the local neighborhood and zoom level 17 shows buildings to give users on foot a sense of situational awareness.", "id": "TileCoordinates", "properties": { "x": { @@ -771,11 +796,11 @@ "type": "object" }, "TriangleStrip": { - "description": "Represents a strip of triangles. Each triangle uses the last edge of the\nprevious one. The following diagram shows an example of a triangle strip,\nwith each vertex labeled with its index in the vertex_index array.\n\n (1)-----(3)\n / \\ / \\\n / \\ / \\\n / \\ / \\\n (0)-----(2)-----(4)\n\nVertices may be in either clockwise or counter-clockwise order.", + "description": "Represents a strip of triangles. Each triangle uses the last edge of the previous one. The following diagram shows an example of a triangle strip, with each vertex labeled with its index in the vertex_index array. (1)-----(3) / \\ / \\ / \\ / \\ / \\ / \\ (0)-----(2)-----(4) Vertices may be in either clockwise or counter-clockwise order.", "id": "TriangleStrip", "properties": { "vertexIndices": { - "description": "Index into the vertex_offset array representing the next vertex in the\ntriangle strip.", + "description": "Index into the vertex_offset array representing the next vertex in the triangle strip.", "items": { "format": "int32", "type": "integer" @@ -786,7 +811,7 @@ "type": "object" }, "Vertex2DList": { - "description": "2D vertex list used for lines and areas. Each entry represents an offset from\nthe previous one in local tile coordinates. The first entry is offset from\n(0, 0).\n\nFor example, the list of vertices [(1,1), (2, 2), (1, 2)] would be encoded\nin vertex offsets as [(1, 1), (1, 1), (-1, 0)].", + "description": "2D vertex list used for lines and areas. Each entry represents an offset from the previous one in local tile coordinates. The first entry is offset from (0, 0). For example, the list of vertices [(1,1), (2, 2), (1, 2)] would be encoded in vertex offsets as [(1, 1), (1, 1), (-1, 0)].", "id": "Vertex2DList", "properties": { "xOffsets": { @@ -809,7 +834,7 @@ "type": "object" }, "Vertex3DList": { - "description": "3D vertex list used for modeled volumes. Each entry represents an offset from\nthe previous one in local tile coordinates. The first coordinate is offset\nfrom (0, 0, 0).", + "description": "3D vertex list used for modeled volumes. Each entry represents an offset from the previous one in local tile coordinates. The first coordinate is offset from (0, 0, 0).", "id": "Vertex3DList", "properties": { "xOffsets": { diff --git a/discovery/vision-v1.json b/discovery/vision-v1.json index 2cf2f81603..4c4aa359f7 100644 --- a/discovery/vision-v1.json +++ b/discovery/vision-v1.json @@ -111,7 +111,7 @@ "files": { "methods": { "annotate": { - "description": "Service that performs image detection and annotation for a batch of files.\nNow only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported.\n\nThis service will extract at most 5 (customers can specify which 5 in\nAnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each\nfile provided and perform detection and annotation for each image\nextracted.", + "description": "Service that performs image detection and annotation for a batch of files. Now only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.", "flatPath": "v1/files:annotate", "httpMethod": "POST", "id": "vision.files.annotate", @@ -130,7 +130,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of generic\nfiles, such as PDF files, which may contain multiple pages and multiple\nimages per page. Progress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", + "description": "Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", "flatPath": "v1/files:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.files.asyncBatchAnnotate", @@ -172,7 +172,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of images.\n\nProgress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results).\n\nThis service will write image annotation outputs to json files in customer\nGCS bucket, each json file containing BatchAnnotateImagesResponse proto.", + "description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.", "flatPath": "v1/images:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.images.asyncBatchAnnotate", @@ -197,7 +197,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": "v1/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "id": "vision.locations.operations.get", @@ -229,7 +229,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": "vision.operations.cancel", @@ -258,7 +258,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": "vision.operations.delete", @@ -284,7 +284,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": "vision.operations.get", @@ -310,7 +310,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": "vision.operations.list", @@ -358,7 +358,7 @@ "files": { "methods": { "annotate": { - "description": "Service that performs image detection and annotation for a batch of files.\nNow only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported.\n\nThis service will extract at most 5 (customers can specify which 5 in\nAnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each\nfile provided and perform detection and annotation for each image\nextracted.", + "description": "Service that performs image detection and annotation for a batch of files. Now only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.", "flatPath": "v1/projects/{projectsId}/files:annotate", "httpMethod": "POST", "id": "vision.projects.files.annotate", @@ -367,7 +367,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -387,7 +387,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of generic\nfiles, such as PDF files, which may contain multiple pages and multiple\nimages per page. Progress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", + "description": "Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", "flatPath": "v1/projects/{projectsId}/files:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.projects.files.asyncBatchAnnotate", @@ -396,7 +396,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -429,7 +429,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -449,7 +449,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of images.\n\nProgress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results).\n\nThis service will write image annotation outputs to json files in customer\nGCS bucket, each json file containing BatchAnnotateImagesResponse proto.", + "description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.", "flatPath": "v1/projects/{projectsId}/images:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.projects.images.asyncBatchAnnotate", @@ -458,7 +458,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -484,7 +484,7 @@ "files": { "methods": { "annotate": { - "description": "Service that performs image detection and annotation for a batch of files.\nNow only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported.\n\nThis service will extract at most 5 (customers can specify which 5 in\nAnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each\nfile provided and perform detection and annotation for each image\nextracted.", + "description": "Service that performs image detection and annotation for a batch of files. Now only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/files:annotate", "httpMethod": "POST", "id": "vision.projects.locations.files.annotate", @@ -493,7 +493,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -513,7 +513,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of generic\nfiles, such as PDF files, which may contain multiple pages and multiple\nimages per page. Progress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", + "description": "Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/files:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.projects.locations.files.asyncBatchAnnotate", @@ -522,7 +522,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -555,7 +555,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -575,7 +575,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of images.\n\nProgress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results).\n\nThis service will write image annotation outputs to json files in customer\nGCS bucket, each json file containing BatchAnnotateImagesResponse proto.", + "description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/images:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.projects.locations.images.asyncBatchAnnotate", @@ -584,7 +584,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -608,7 +608,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": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "id": "vision.projects.locations.operations.get", @@ -638,7 +638,7 @@ "productSets": { "methods": { "addProduct": { - "description": "Adds a Product to the specified ProductSet. If the Product is already\npresent, no change is made.\n\nOne Product can be added to at most 100 ProductSets.\n\nPossible errors:\n\n* Returns NOT_FOUND if the Product or the ProductSet doesn't exist.", + "description": "Adds a Product to the specified ProductSet. If the Product is already present, no change is made. One Product can be added to at most 100 ProductSets. Possible errors: * Returns NOT_FOUND if the Product or the ProductSet doesn't exist.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}:addProduct", "httpMethod": "POST", "id": "vision.projects.locations.productSets.addProduct", @@ -647,7 +647,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name for the ProductSet to modify.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`", + "description": "Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$", "required": true, @@ -667,7 +667,7 @@ ] }, "create": { - "description": "Creates and returns a new ProductSet resource.\n\nPossible errors:\n\n* Returns INVALID_ARGUMENT if display_name is missing, or is longer than\n 4096 characters.", + "description": "Creates and returns a new ProductSet resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets", "httpMethod": "POST", "id": "vision.projects.locations.productSets.create", @@ -676,14 +676,14 @@ ], "parameters": { "parent": { - "description": "Required. The project in which the ProductSet should be created.\n\nFormat is `projects/PROJECT_ID/locations/LOC_ID`.", + "description": "Required. The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "productSetId": { - "description": "A user-supplied resource id for this ProductSet. If set, the server will\nattempt to use this value as the resource id. If it is already in use, an\nerror is returned with code ALREADY_EXISTS. Must be at most 128 characters\nlong. It cannot contain the character `/`.", + "description": "A user-supplied resource id for this ProductSet. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.", "location": "query", "type": "string" } @@ -701,7 +701,7 @@ ] }, "delete": { - "description": "Permanently deletes a ProductSet. Products and ReferenceImages in the\nProductSet are not deleted.\n\nThe actual image files are not deleted from Google Cloud Storage.", + "description": "Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted. The actual image files are not deleted from Google Cloud Storage.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}", "httpMethod": "DELETE", "id": "vision.projects.locations.productSets.delete", @@ -710,7 +710,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the ProductSet to delete.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`", + "description": "Required. Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$", "required": true, @@ -727,7 +727,7 @@ ] }, "get": { - "description": "Gets information associated with a ProductSet.\n\nPossible errors:\n\n* Returns NOT_FOUND if the ProductSet does not exist.", + "description": "Gets information associated with a ProductSet. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}", "httpMethod": "GET", "id": "vision.projects.locations.productSets.get", @@ -736,7 +736,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the ProductSet to get.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`", + "description": "Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$", "required": true, @@ -753,7 +753,7 @@ ] }, "import": { - "description": "Asynchronous API that imports a list of reference images to specified\nproduct sets based on a list of image information.\n\nThe google.longrunning.Operation API can be used to keep track of the\nprogress and results of the request.\n`Operation.metadata` contains `BatchOperationMetadata`. (progress)\n`Operation.response` contains `ImportProductSetsResponse`. (results)\n\nThe input source of this method is a csv file on Google Cloud Storage.\nFor the format of the csv file please see\nImportProductSetsGcsSource.csv_file_uri.", + "description": "Asynchronous API that imports a list of reference images to specified product sets based on a list of image information. The google.longrunning.Operation API can be used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) `Operation.response` contains `ImportProductSetsResponse`. (results) The input source of this method is a csv file on Google Cloud Storage. For the format of the csv file please see ImportProductSetsGcsSource.csv_file_uri.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets:import", "httpMethod": "POST", "id": "vision.projects.locations.productSets.import", @@ -762,7 +762,7 @@ ], "parameters": { "parent": { - "description": "Required. The project in which the ProductSets should be imported.\n\nFormat is `projects/PROJECT_ID/locations/LOC_ID`.", + "description": "Required. The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -782,7 +782,7 @@ ] }, "list": { - "description": "Lists ProductSets in an unspecified order.\n\nPossible errors:\n\n* Returns INVALID_ARGUMENT if page_size is greater than 100, or less\n than 1.", + "description": "Lists ProductSets in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets", "httpMethod": "GET", "id": "vision.projects.locations.productSets.list", @@ -802,7 +802,7 @@ "type": "string" }, "parent": { - "description": "Required. The project from which ProductSets should be listed.\n\nFormat is `projects/PROJECT_ID/locations/LOC_ID`.", + "description": "Required. The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -819,7 +819,7 @@ ] }, "patch": { - "description": "Makes changes to a ProductSet resource.\nOnly display_name can be updated currently.\n\nPossible errors:\n\n* Returns NOT_FOUND if the ProductSet does not exist.\n* Returns INVALID_ARGUMENT if display_name is present in update_mask but\n missing from the request or longer than 4096 characters.", + "description": "Makes changes to a ProductSet resource. Only display_name can be updated currently. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but missing from the request or longer than 4096 characters.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}", "httpMethod": "PATCH", "id": "vision.projects.locations.productSets.patch", @@ -828,14 +828,14 @@ ], "parameters": { "name": { - "description": "The resource name of the ProductSet.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.\n\nThis field is ignored when creating a ProductSet.", + "description": "The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "The FieldMask that specifies which fields to\nupdate.\nIf update_mask isn't specified, all mutable fields are to be updated.\nValid mask path is `display_name`.", + "description": "The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask path is `display_name`.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -863,7 +863,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name for the ProductSet to modify.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`", + "description": "Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$", "required": true, @@ -887,7 +887,7 @@ "products": { "methods": { "list": { - "description": "Lists the Products in a ProductSet, in an unspecified order. If the\nProductSet does not exist, the products field of the response will be\nempty.\n\nPossible errors:\n\n* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.", + "description": "Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}/products", "httpMethod": "GET", "id": "vision.projects.locations.productSets.products.list", @@ -896,7 +896,7 @@ ], "parameters": { "name": { - "description": "Required. The ProductSet resource for which to retrieve Products.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`", + "description": "Required. The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$", "required": true, @@ -930,7 +930,7 @@ "products": { "methods": { "create": { - "description": "Creates and returns a new product resource.\n\nPossible errors:\n\n* Returns INVALID_ARGUMENT if display_name is missing or longer than 4096\n characters.\n* Returns INVALID_ARGUMENT if description is longer than 4096 characters.\n* Returns INVALID_ARGUMENT if product_category is missing or invalid.", + "description": "Creates and returns a new product resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is missing or invalid.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products", "httpMethod": "POST", "id": "vision.projects.locations.products.create", @@ -939,14 +939,14 @@ ], "parameters": { "parent": { - "description": "Required. The project in which the Product should be created.\n\nFormat is\n`projects/PROJECT_ID/locations/LOC_ID`.", + "description": "Required. The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "productId": { - "description": "A user-supplied resource id for this Product. If set, the server will\nattempt to use this value as the resource id. If it is already in use, an\nerror is returned with code ALREADY_EXISTS. Must be at most 128 characters\nlong. It cannot contain the character `/`.", + "description": "A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.", "location": "query", "type": "string" } @@ -964,7 +964,7 @@ ] }, "delete": { - "description": "Permanently deletes a product and its reference images.\n\nMetadata of the product and all its images will be deleted right away, but\nsearch queries against ProductSets containing the product may still work\nuntil all related caches are refreshed.", + "description": "Permanently deletes a product and its reference images. Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work until all related caches are refreshed.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}", "httpMethod": "DELETE", "id": "vision.projects.locations.products.delete", @@ -973,7 +973,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of product to delete.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`", + "description": "Required. Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", "required": true, @@ -990,7 +990,7 @@ ] }, "get": { - "description": "Gets information associated with a Product.\n\nPossible errors:\n\n* Returns NOT_FOUND if the Product does not exist.", + "description": "Gets information associated with a Product. Possible errors: * Returns NOT_FOUND if the Product does not exist.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}", "httpMethod": "GET", "id": "vision.projects.locations.products.get", @@ -999,7 +999,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the Product to get.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`", + "description": "Required. Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", "required": true, @@ -1016,7 +1016,7 @@ ] }, "list": { - "description": "Lists products in an unspecified order.\n\nPossible errors:\n\n* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.", + "description": "Lists products in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products", "httpMethod": "GET", "id": "vision.projects.locations.products.list", @@ -1036,7 +1036,7 @@ "type": "string" }, "parent": { - "description": "Required. The project OR ProductSet from which Products should be listed.\n\nFormat:\n`projects/PROJECT_ID/locations/LOC_ID`", + "description": "Required. The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1053,7 +1053,7 @@ ] }, "patch": { - "description": "Makes changes to a Product resource.\nOnly the `display_name`, `description`, and `labels` fields can be updated\nright now.\n\nIf labels are updated, the change will not be reflected in queries until\nthe next index time.\n\nPossible errors:\n\n* Returns NOT_FOUND if the Product does not exist.\n* Returns INVALID_ARGUMENT if display_name is present in update_mask but is\n missing from the request or longer than 4096 characters.\n* Returns INVALID_ARGUMENT if description is present in update_mask but is\n longer than 4096 characters.\n* Returns INVALID_ARGUMENT if product_category is present in update_mask.", + "description": "Makes changes to a Product resource. Only the `display_name`, `description`, and `labels` fields can be updated right now. If labels are updated, the change will not be reflected in queries until the next index time. Possible errors: * Returns NOT_FOUND if the Product does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but is missing from the request or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is present in update_mask but is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is present in update_mask.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}", "httpMethod": "PATCH", "id": "vision.projects.locations.products.patch", @@ -1062,14 +1062,14 @@ ], "parameters": { "name": { - "description": "The resource name of the product.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.\n\nThis field is ignored when creating a product.", + "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "The FieldMask that specifies which fields\nto update.\nIf update_mask isn't specified, all mutable fields are to be updated.\nValid mask paths include `product_labels`, `display_name`, and\n`description`.", + "description": "The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask paths include `product_labels`, `display_name`, and `description`.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1088,7 +1088,7 @@ ] }, "purge": { - "description": "Asynchronous API to delete all Products in a ProductSet or all Products\nthat are in no ProductSet.\n\nIf a Product is a member of the specified ProductSet in addition to other\nProductSets, the Product will still be deleted.\n\nIt is recommended to not delete the specified ProductSet until after this\noperation has completed. It is also recommended to not add any of the\nProducts involved in the batch delete to a new ProductSet while this\noperation is running because those Products may still end up deleted.\n\nIt's not possible to undo the PurgeProducts operation. Therefore, it is\nrecommended to keep the csv files used in ImportProductSets (if that was\nhow you originally built the Product Set) before starting PurgeProducts, in\ncase you need to re-import the data after deletion.\n\nIf the plan is to purge all of the Products from a ProductSet and then\nre-use the empty ProductSet to re-import new Products into the empty\nProductSet, you must wait until the PurgeProducts operation has finished\nfor that ProductSet.\n\nThe google.longrunning.Operation API can be used to keep track of the\nprogress and results of the request.\n`Operation.metadata` contains `BatchOperationMetadata`. (progress)", + "description": "Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet. If a Product is a member of the specified ProductSet in addition to other ProductSets, the Product will still be deleted. It is recommended to not delete the specified ProductSet until after this operation has completed. It is also recommended to not add any of the Products involved in the batch delete to a new ProductSet while this operation is running because those Products may still end up deleted. It's not possible to undo the PurgeProducts operation. Therefore, it is recommended to keep the csv files used in ImportProductSets (if that was how you originally built the Product Set) before starting PurgeProducts, in case you need to re-import the data after deletion. If the plan is to purge all of the Products from a ProductSet and then re-use the empty ProductSet to re-import new Products into the empty ProductSet, you must wait until the PurgeProducts operation has finished for that ProductSet. The google.longrunning.Operation API can be used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress)", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products:purge", "httpMethod": "POST", "id": "vision.projects.locations.products.purge", @@ -1097,7 +1097,7 @@ ], "parameters": { "parent": { - "description": "Required. The project and location in which the Products should be deleted.\n\nFormat is `projects/PROJECT_ID/locations/LOC_ID`.", + "description": "Required. The project and location in which the Products should be deleted. Format is `projects/PROJECT_ID/locations/LOC_ID`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1121,7 +1121,7 @@ "referenceImages": { "methods": { "create": { - "description": "Creates and returns a new ReferenceImage resource.\n\nThe `bounding_poly` field is optional. If `bounding_poly` is not specified,\nthe system will try to detect regions of interest in the image that are\ncompatible with the product_category on the parent product. If it is\nspecified, detection is ALWAYS skipped. The system converts polygons into\nnon-rotated rectangles.\n\nNote that the pipeline will resize the image if the image resolution is too\nlarge to process (above 50MP).\n\nPossible errors:\n\n* Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096\n characters.\n* Returns INVALID_ARGUMENT if the product does not exist.\n* Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing\n compatible with the parent product's product_category is detected.\n* Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.", + "description": "Creates and returns a new ReferenceImage resource. The `bounding_poly` field is optional. If `bounding_poly` is not specified, the system will try to detect regions of interest in the image that are compatible with the product_category on the parent product. If it is specified, detection is ALWAYS skipped. The system converts polygons into non-rotated rectangles. Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP). Possible errors: * Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if the product does not exist. * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected. * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/referenceImages", "httpMethod": "POST", "id": "vision.projects.locations.products.referenceImages.create", @@ -1130,14 +1130,14 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the product in which to create the reference image.\n\nFormat is\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.", + "description": "Required. Resource name of the product in which to create the reference image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", "required": true, "type": "string" }, "referenceImageId": { - "description": "A user-supplied resource id for the ReferenceImage to be added. If set,\nthe server will attempt to use this value as the resource id. If it is\nalready in use, an error is returned with code ALREADY_EXISTS. Must be at\nmost 128 characters long. It cannot contain the character `/`.", + "description": "A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.", "location": "query", "type": "string" } @@ -1155,7 +1155,7 @@ ] }, "delete": { - "description": "Permanently deletes a reference image.\n\nThe image metadata will be deleted right away, but search queries\nagainst ProductSets containing the image may still work until all related\ncaches are refreshed.\n\nThe actual image files are not deleted from Google Cloud Storage.", + "description": "Permanently deletes a reference image. The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed. The actual image files are not deleted from Google Cloud Storage.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/referenceImages/{referenceImagesId}", "httpMethod": "DELETE", "id": "vision.projects.locations.products.referenceImages.delete", @@ -1164,7 +1164,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the reference image to delete.\n\nFormat is:\n\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`", + "description": "Required. The resource name of the reference image to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/referenceImages/[^/]+$", "required": true, @@ -1181,7 +1181,7 @@ ] }, "get": { - "description": "Gets information associated with a ReferenceImage.\n\nPossible errors:\n\n* Returns NOT_FOUND if the specified image does not exist.", + "description": "Gets information associated with a ReferenceImage. Possible errors: * Returns NOT_FOUND if the specified image does not exist.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/referenceImages/{referenceImagesId}", "httpMethod": "GET", "id": "vision.projects.locations.products.referenceImages.get", @@ -1190,7 +1190,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ReferenceImage to get.\n\nFormat is:\n\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.", + "description": "Required. The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/referenceImages/[^/]+$", "required": true, @@ -1207,7 +1207,7 @@ ] }, "list": { - "description": "Lists reference images.\n\nPossible errors:\n\n* Returns NOT_FOUND if the parent product does not exist.\n* Returns INVALID_ARGUMENT if the page_size is greater than 100, or less\n than 1.", + "description": "Lists reference images. Possible errors: * Returns NOT_FOUND if the parent product does not exist. * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less than 1.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/referenceImages", "httpMethod": "GET", "id": "vision.projects.locations.products.referenceImages.list", @@ -1222,12 +1222,12 @@ "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results to be returned. This is the value\nof `nextPageToken` returned in a previous reference image list request.\n\nDefaults to the first page if not specified.", + "description": "A token identifying a page of results to be returned. This is the value of `nextPageToken` returned in a previous reference image list request. Defaults to the first page if not specified.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Resource name of the product containing the reference images.\n\nFormat is\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.", + "description": "Required. Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", "required": true, @@ -1252,7 +1252,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": "v1/projects/{projectsId}/operations/{operationsId}", "httpMethod": "GET", "id": "vision.projects.operations.get", @@ -1282,7 +1282,7 @@ } } }, - "revision": "20200710", + "revision": "20200801", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AddProductToProductSetRequest": { @@ -1290,7 +1290,7 @@ "id": "AddProductToProductSetRequest", "properties": { "product": { - "description": "Required. The resource name for the Product to be added to this ProductSet.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`", + "description": "Required. The resource name for the Product to be added to this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`", "type": "string" } }, @@ -1316,7 +1316,7 @@ "description": "Required. Information about the input file." }, "pages": { - "description": "Pages of the file to perform image annotation.\n\nPages starts from 1, we assume the first page of the file is page 1.\nAt most 5 pages are supported per request. Pages can be negative.\n\nPage 1 means the first page.\nPage 2 means the second page.\nPage -1 means the last page.\nPage -2 means the second to the last page.\n\nIf the file is GIF instead of PDF or TIFF, page refers to GIF frames.\n\nIf this field is empty, by default the service performs image annotation\nfor the first 5 pages of the file.", + "description": "Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file.", "items": { "format": "int32", "type": "integer" @@ -1327,19 +1327,19 @@ "type": "object" }, "AnnotateFileResponse": { - "description": "Response to a single file annotation request. A file may contain one or more\nimages, which individually have their own responses.", + "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "AnnotateFileResponse", "properties": { "error": { "$ref": "Status", - "description": "If set, represents the error message for the failed request. The\n`responses` field will not be set in this case." + "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." }, "inputConfig": { "$ref": "InputConfig", "description": "Information about the file for which this response is generated." }, "responses": { - "description": "Individual responses to images found within the file. This field will be\nempty if the `error` field is set.", + "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "AnnotateImageResponse" }, @@ -1354,7 +1354,7 @@ "type": "object" }, "AnnotateImageRequest": { - "description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features, and with context information.", + "description": "Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information.", "id": "AnnotateImageRequest", "properties": { "features": { @@ -1381,7 +1381,7 @@ "properties": { "context": { "$ref": "ImageAnnotationContext", - "description": "If present, contextual information is needed to understand where this image\ncomes from." + "description": "If present, contextual information is needed to understand where this image comes from." }, "cropHintsAnnotation": { "$ref": "CropHintsAnnotation", @@ -1389,7 +1389,7 @@ }, "error": { "$ref": "Status", - "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." + "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set." }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", @@ -1400,7 +1400,7 @@ }, "fullTextAnnotation": { "$ref": "TextAnnotation", - "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." + "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." }, "imagePropertiesAnnotation": { "$ref": "ImageProperties", @@ -1421,7 +1421,7 @@ "type": "array" }, "localizedObjectAnnotations": { - "description": "If present, localized object detection has completed successfully.\nThis will be sorted descending by confidence score.", + "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "LocalizedObjectAnnotation" }, @@ -1494,11 +1494,11 @@ "type": "object" }, "AsyncBatchAnnotateFilesRequest": { - "description": "Multiple async file annotation requests are batched into a single service\ncall.", + "description": "Multiple async file annotation requests are batched into a single service call.", "id": "AsyncBatchAnnotateFilesRequest", "properties": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "requests": { @@ -1516,7 +1516,7 @@ "id": "AsyncBatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, one for each request in\nAsyncBatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "items": { "$ref": "AsyncAnnotateFileResponse" }, @@ -1534,7 +1534,7 @@ "description": "Required. The desired output location and metadata (e.g. format)." }, "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "requests": { @@ -1563,11 +1563,11 @@ "id": "BatchAnnotateFilesRequest", "properties": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "requests": { - "description": "Required. The list of file annotation requests. Right now we support only one\nAnnotateFileRequest in BatchAnnotateFilesRequest.", + "description": "Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.", "items": { "$ref": "AnnotateFileRequest" }, @@ -1581,7 +1581,7 @@ "id": "BatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, each response corresponding to each\nAnnotateFileRequest in BatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.", "items": { "$ref": "AnnotateFileResponse" }, @@ -1595,7 +1595,7 @@ "id": "BatchAnnotateImagesRequest", "properties": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "requests": { @@ -1623,11 +1623,11 @@ "type": "object" }, "BatchOperationMetadata": { - "description": "Metadata for the batch operations such as the current state.\n\nThis is included in the `metadata` field of the `Operation` returned by the\n`GetOperation` call of the `google::longrunning::Operations` service.", + "description": "Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.", "id": "BatchOperationMetadata", "properties": { "endTime": { - "description": "The time when the batch request is finished and\ngoogle.longrunning.Operation.done is set to true.", + "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.", "format": "google-datetime", "type": "string" }, @@ -1643,9 +1643,9 @@ "enumDescriptions": [ "Invalid.", "Request is actively being processed.", - "The request is done and at least one item has been successfully\nprocessed.", + "The request is done and at least one item has been successfully processed.", "The request is done and no item has been successfully processed.", - "The request is done after the longrunning.Operations.CancelOperation has\nbeen called by the user. Any records that were processed before the\ncancel command are output as specified in the request." + "The request is done after the longrunning.Operations.CancelOperation has been called by the user. Any records that were processed before the cancel command are output as specified in the request." ], "type": "string" }, @@ -1683,7 +1683,7 @@ }, "boundingBox": { "$ref": "BoundingPoly", - "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", @@ -1732,11 +1732,11 @@ "type": "object" }, "Color": { - "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well.\n\nNote: this proto does not carry information about the absolute color space\nthat should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,\nDCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color\nspace.\n\nNote: when color equality needs to be decided, implementations, unless\ndocumented otherwise, will treat two colors to be equal if all their red,\ngreen, blue and alpha values each differ by at most 1e-5.\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [[Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha <= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red << 16) | (green << 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i < missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...", + "description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of \"java.awt.Color\" in Java; it can also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\" method in iOS; and, with just a little work, it can be easily formatted into a CSS \"rgba()\" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be equal if all their red, green, blue and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...", "id": "Color", "properties": { "alpha": { - "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).", + "description": "The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0).", "format": "float", "type": "number" }, @@ -1759,7 +1759,7 @@ "type": "object" }, "ColorInfo": { - "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", + "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "ColorInfo", "properties": { "color": { @@ -1767,7 +1767,7 @@ "description": "RGB components of the color." }, "pixelFraction": { - "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", + "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" }, @@ -1785,15 +1785,15 @@ "properties": { "boundingPoly": { "$ref": "BoundingPoly", - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale." + "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { - "description": "Confidence of this being a salient region. Range [0, 1].", + "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { - "description": "Fraction of importance of this salient region with respect to the original\nimage.", + "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } @@ -1819,7 +1819,7 @@ "id": "CropHintsParams", "properties": { "aspectRatios": { - "description": "Aspect ratios in floats, representing the ratio of the width to the height\nof the image. For example, if the desired aspect ratio is 4/3, the\ncorresponding float value should be 1.33333. If not specified, the\nbest possible crop is returned. The number of provided aspect ratios is\nlimited to a maximum of 16; any aspect ratios provided after the 16th are\nignored.", + "description": "Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored.", "items": { "format": "float", "type": "number" @@ -1852,7 +1852,7 @@ "Regular space.", "Sure space (very wide).", "Line-wrapping break.", - "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", + "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" @@ -1870,7 +1870,7 @@ "type": "number" }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -1891,7 +1891,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" @@ -1902,10 +1902,10 @@ "properties": { "boundingPoly": { "$ref": "BoundingPoly", - "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." + "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "confidence": { - "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", + "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float", "type": "number" }, @@ -1914,22 +1914,22 @@ "type": "string" }, "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", + "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "locations": { - "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", + "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "LocationInfo" }, "type": "array" }, "mid": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", + "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "properties": { - "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", + "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "items": { "$ref": "Property" }, @@ -1941,7 +1941,7 @@ "type": "number" }, "topicality": { - "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", + "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float", "type": "number" } @@ -1994,7 +1994,7 @@ }, "boundingPoly": { "$ref": "BoundingPoly", - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." + "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", @@ -2003,7 +2003,7 @@ }, "fdBoundingPoly": { "$ref": "BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe fd (face detection) prefix." + "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." }, "headwearLikelihood": { "description": "Headwear likelihood.", @@ -2058,12 +2058,12 @@ "type": "array" }, "panAngle": { - "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", + "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "rollAngle": { - "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", + "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "format": "float", "type": "number" }, @@ -2108,7 +2108,7 @@ "type": "string" }, "tiltAngle": { - "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", + "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, @@ -2136,16 +2136,16 @@ "type": "object" }, "Feature": { - "description": "The type of Google Cloud Vision API detection to perform, and the maximum\nnumber of results to return for that type. Multiple `Feature` objects can\nbe specified in the `features` list.", + "description": "The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list.", "id": "Feature", "properties": { "maxResults": { - "description": "Maximum number of results of this type. Does not apply to\n`TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.", + "description": "Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.", "format": "int32", "type": "integer" }, "model": { - "description": "Model to use for the feature.\nSupported values: \"builtin/stable\" (the default if unset) and\n\"builtin/latest\".", + "description": "Model to use for the feature. Supported values: \"builtin/stable\" (the default if unset) and \"builtin/latest\".", "type": "string" }, "type": { @@ -2171,10 +2171,10 @@ "Run landmark detection.", "Run logo detection.", "Run label detection.", - "Run text detection / optical character recognition (OCR). Text detection\nis optimized for areas of text within a larger image; if the image is\na document, use `DOCUMENT_TEXT_DETECTION` instead.", - "Run dense text document OCR. Takes precedence when both\n`DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present.", - "Run Safe Search to detect potentially unsafe\nor undesirable content.", - "Compute a set of image properties, such as the\nimage's dominant colors.", + "Run text detection / optical character recognition (OCR). Text detection is optimized for areas of text within a larger image; if the image is a document, use `DOCUMENT_TEXT_DETECTION` instead.", + "Run dense text document OCR. Takes precedence when both `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present.", + "Run Safe Search to detect potentially unsafe or undesirable content.", + "Compute a set of image properties, such as the image's dominant colors.", "Run crop hints.", "Run web detection.", "Run Product Search.", @@ -2190,7 +2190,7 @@ "id": "GcsDestination", "properties": { "uri": { - "description": "Google Cloud Storage URI prefix where the results will be stored. Results\nwill be in JSON format and preceded by its corresponding input URI prefix.\nThis field can either represent a gcs file prefix or gcs directory. In\neither case, the uri should be unique because in order to get all of the\noutput files, you will need to do a wildcard gcs search on the uri prefix\nyou provide.\n\nExamples:\n\n* File Prefix: gs://bucket-name/here/filenameprefix The output files\nwill be created in gs://bucket-name/here/ and the names of the\noutput files will begin with \"filenameprefix\".\n\n* Directory Prefix: gs://bucket-name/some/location/ The output files\nwill be created in gs://bucket-name/some/location/ and the names of the\noutput files could be anything because there was no filename prefix\nspecified.\n\nIf multiple outputs, each response is still AnnotateFileResponse, each of\nwhich contains some subset of the full list of AnnotateImageResponse.\nMultiple outputs can happen if, for example, the output JSON is too large\nand overflows into multiple sharded files.", + "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, @@ -2201,26 +2201,26 @@ "id": "GcsSource", "properties": { "uri": { - "description": "Google Cloud Storage URI for the input file. This must only be a\nGoogle Cloud Storage object. Wildcards are not currently supported.", + "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p1beta1AnnotateFileResponse": { - "description": "Response to a single file annotation request. A file may contain one or more\nimages, which individually have their own responses.", + "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "GoogleCloudVisionV1p1beta1AnnotateFileResponse", "properties": { "error": { "$ref": "Status", - "description": "If set, represents the error message for the failed request. The\n`responses` field will not be set in this case." + "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." }, "inputConfig": { "$ref": "GoogleCloudVisionV1p1beta1InputConfig", "description": "Information about the file for which this response is generated." }, "responses": { - "description": "Individual responses to images found within the file. This field will be\nempty if the `error` field is set.", + "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "GoogleCloudVisionV1p1beta1AnnotateImageResponse" }, @@ -2240,7 +2240,7 @@ "properties": { "context": { "$ref": "GoogleCloudVisionV1p1beta1ImageAnnotationContext", - "description": "If present, contextual information is needed to understand where this image\ncomes from." + "description": "If present, contextual information is needed to understand where this image comes from." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p1beta1CropHintsAnnotation", @@ -2248,7 +2248,7 @@ }, "error": { "$ref": "Status", - "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." + "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set." }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", @@ -2259,7 +2259,7 @@ }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p1beta1TextAnnotation", - "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." + "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." }, "imagePropertiesAnnotation": { "$ref": "GoogleCloudVisionV1p1beta1ImageProperties", @@ -2280,7 +2280,7 @@ "type": "array" }, "localizedObjectAnnotations": { - "description": "If present, localized object detection has completed successfully.\nThis will be sorted descending by confidence score.", + "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation" }, @@ -2331,7 +2331,7 @@ "id": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, one for each request in\nAsyncBatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse" }, @@ -2366,7 +2366,7 @@ }, "boundingBox": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", @@ -2409,7 +2409,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1ColorInfo": { - "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", + "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "GoogleCloudVisionV1p1beta1ColorInfo", "properties": { "color": { @@ -2417,7 +2417,7 @@ "description": "RGB components of the color." }, "pixelFraction": { - "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", + "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" }, @@ -2435,15 +2435,15 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale." + "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { - "description": "Confidence of this being a salient region. Range [0, 1].", + "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { - "description": "Fraction of importance of this salient region with respect to the original\nimage.", + "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } @@ -2484,10 +2484,10 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." + "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "confidence": { - "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", + "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float", "type": "number" }, @@ -2496,22 +2496,22 @@ "type": "string" }, "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", + "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "locations": { - "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", + "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "GoogleCloudVisionV1p1beta1LocationInfo" }, "type": "array" }, "mid": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", + "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "properties": { - "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", + "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "items": { "$ref": "GoogleCloudVisionV1p1beta1Property" }, @@ -2523,7 +2523,7 @@ "type": "number" }, "topicality": { - "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", + "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float", "type": "number" } @@ -2576,7 +2576,7 @@ }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." + "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", @@ -2585,7 +2585,7 @@ }, "fdBoundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe fd (face detection) prefix." + "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." }, "headwearLikelihood": { "description": "Headwear likelihood.", @@ -2640,12 +2640,12 @@ "type": "array" }, "panAngle": { - "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", + "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "rollAngle": { - "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", + "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "format": "float", "type": "number" }, @@ -2690,7 +2690,7 @@ "type": "string" }, "tiltAngle": { - "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", + "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, @@ -2811,7 +2811,7 @@ "id": "GoogleCloudVisionV1p1beta1GcsDestination", "properties": { "uri": { - "description": "Google Cloud Storage URI prefix where the results will be stored. Results\nwill be in JSON format and preceded by its corresponding input URI prefix.\nThis field can either represent a gcs file prefix or gcs directory. In\neither case, the uri should be unique because in order to get all of the\noutput files, you will need to do a wildcard gcs search on the uri prefix\nyou provide.\n\nExamples:\n\n* File Prefix: gs://bucket-name/here/filenameprefix The output files\nwill be created in gs://bucket-name/here/ and the names of the\noutput files will begin with \"filenameprefix\".\n\n* Directory Prefix: gs://bucket-name/some/location/ The output files\nwill be created in gs://bucket-name/some/location/ and the names of the\noutput files could be anything because there was no filename prefix\nspecified.\n\nIf multiple outputs, each response is still AnnotateFileResponse, each of\nwhich contains some subset of the full list of AnnotateImageResponse.\nMultiple outputs can happen if, for example, the output JSON is too large\nand overflows into multiple sharded files.", + "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, @@ -2822,18 +2822,18 @@ "id": "GoogleCloudVisionV1p1beta1GcsSource", "properties": { "uri": { - "description": "Google Cloud Storage URI for the input file. This must only be a\nGoogle Cloud Storage object. Wildcards are not currently supported.", + "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p1beta1ImageAnnotationContext": { - "description": "If an image was produced from a file (e.g. a PDF), this message gives\ninformation about the source of that image.", + "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "GoogleCloudVisionV1p1beta1ImageAnnotationContext", "properties": { "pageNumber": { - "description": "If the file was a PDF or TIFF, this field gives the page number within\nthe file used to produce the image.", + "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" }, @@ -2860,7 +2860,7 @@ "id": "GoogleCloudVisionV1p1beta1InputConfig", "properties": { "content": { - "description": "File content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateFiles requests. It does\nnot work for AsyncBatchAnnotateFiles requests.", + "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "format": "byte", "type": "string" }, @@ -2869,7 +2869,7 @@ "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { - "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and\n\"image/gif\" are supported. Wildcards are not supported.", + "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } }, @@ -2884,7 +2884,7 @@ "description": "Image region to which this object belongs. This must be populated." }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -2915,7 +2915,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1NormalizedVertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the normalized vertex coordinates are relative to the original image\nand range from 0 to 1.", + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudVisionV1p1beta1NormalizedVertex", "properties": { "x": { @@ -2971,7 +2971,7 @@ "id": "GoogleCloudVisionV1p1beta1OutputConfig", "properties": { "batchSize": { - "description": "The max number of response protos to put into each output JSON file on\nGoogle Cloud Storage.\nThe valid range is [1, 100]. If not specified, the default value is 20.\n\nFor example, for one pdf file with 100 pages, 100 response protos will\nbe generated. If `batch_size` = 20, then 5 json files each\ncontaining 20 response protos will be written under the prefix\n`gcs_destination`.`uri`.\n\nCurrently, batch_size only applies to GcsDestination, with potential future\nsupport for other output configurations.", + "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, @@ -2999,7 +2999,7 @@ "type": "number" }, "height": { - "description": "Page height. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, @@ -3008,7 +3008,7 @@ "description": "Additional information detected on the page." }, "width": { - "description": "Page width. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" } @@ -3021,7 +3021,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", @@ -3043,7 +3043,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1Position": { - "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", + "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p1beta1Position", "properties": { "x": { @@ -3069,23 +3069,23 @@ "id": "GoogleCloudVisionV1p1beta1Product", "properties": { "description": { - "description": "User-provided metadata to be stored with this product. Must be at most 4096\ncharacters long.", + "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "displayName": { - "description": "The user-provided name for this Product. Must not be empty. Must be at most\n4096 characters long.", + "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { - "description": "The resource name of the product.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.\n\nThis field is ignored when creating a product.", + "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "productCategory": { - "description": "Immutable. The category for the product identified by the reference image. This should\nbe either \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\". The legacy categories\n\"homegoods\", \"apparel\", and \"toys\" are still supported, but these should\nnot be used for new products.", + "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { - "description": "Key-value pairs that can be attached to a product. At query time,\nconstraints can be specified based on the product_labels.\n\nNote that integer values can be provided as strings, e.g. \"1199\". Only\nstrings with integer values can match a range-based restriction which is\nto be supported soon.\n\nMultiple values can be assigned to the same key. One product may have up to\n500 product_labels.\n\nNotice that the total number of distinct product_labels over all products\nin one ProductSet cannot exceed 1M, otherwise the product search pipeline\nwill refuse to work for that ProductSet.", + "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.", "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductKeyValue" }, @@ -3099,11 +3099,11 @@ "id": "GoogleCloudVisionV1p1beta1ProductKeyValue", "properties": { "key": { - "description": "The key of the label attached to the product. Cannot be empty and cannot\nexceed 128 bytes.", + "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { - "description": "The value of the label attached to the product. Cannot be empty and\ncannot exceed 128 bytes.", + "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, @@ -3114,12 +3114,12 @@ "id": "GoogleCloudVisionV1p1beta1ProductSearchResults", "properties": { "indexTime": { - "description": "Timestamp of the index which provided these results. Products added to the\nproduct set and products removed from the product set after this time are\nnot reflected in the current results.", + "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime", "type": "string" }, "productGroupedResults": { - "description": "List of results grouped by products detected in the query image. Each entry\ncorresponds to one bounding polygon in the query image, and contains the\nmatching products specific to that region. There may be duplicate product\nmatches in the union of all the per-product results.", + "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult" }, @@ -3136,7 +3136,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult": { - "description": "Information about the products similar to a single product in a query\nimage.", + "description": "Information about the products similar to a single product in a query image.", "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult", "properties": { "boundingPoly": { @@ -3165,7 +3165,7 @@ "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation", "properties": { "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -3189,7 +3189,7 @@ "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult", "properties": { "image": { - "description": "The resource name of the image from the product that is the closest match\nto the query.", + "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { @@ -3197,7 +3197,7 @@ "description": "The Product." }, "score": { - "description": "A confidence level on the match, ranging from 0 (no confidence) to\n1 (full confidence).", + "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" } @@ -3225,11 +3225,11 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1SafeSearchAnnotation": { - "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", + "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation", "properties": { "adult": { - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -3269,7 +3269,7 @@ "type": "string" }, "racy": { - "description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.", + "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -3289,7 +3289,7 @@ "type": "string" }, "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -3337,7 +3337,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", @@ -3356,7 +3356,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1TextAnnotation": { - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", + "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "GoogleCloudVisionV1p1beta1TextAnnotation", "properties": { "pages": { @@ -3396,7 +3396,7 @@ "Regular space.", "Sure space (very wide).", "Line-wrapping break.", - "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", + "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" @@ -3414,7 +3414,7 @@ "type": "number" }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -3439,7 +3439,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1Vertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p1beta1Vertex", "properties": { "x": { @@ -3460,14 +3460,14 @@ "id": "GoogleCloudVisionV1p1beta1WebDetection", "properties": { "bestGuessLabels": { - "description": "The service's best guess as to the topic of the request image.\nInferred from similar images on the open web.", + "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel" }, "type": "array" }, "fullMatchingImages": { - "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", + "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, @@ -3481,7 +3481,7 @@ "type": "array" }, "partialMatchingImages": { - "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", + "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, @@ -3517,7 +3517,7 @@ "type": "string" }, "score": { - "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", + "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } @@ -3549,7 +3549,7 @@ "type": "string" }, "languageCode": { - "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -3560,7 +3560,7 @@ "id": "GoogleCloudVisionV1p1beta1WebDetectionWebPage", "properties": { "fullMatchingImages": { - "description": "Fully matching images on the page.\nCan include resized copies of the query image.", + "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, @@ -3571,7 +3571,7 @@ "type": "string" }, "partialMatchingImages": { - "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", + "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, @@ -3595,7 +3595,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", @@ -3607,7 +3607,7 @@ "description": "Additional information detected for the word." }, "symbols": { - "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", + "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "GoogleCloudVisionV1p1beta1Symbol" }, @@ -3617,19 +3617,19 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1AnnotateFileResponse": { - "description": "Response to a single file annotation request. A file may contain one or more\nimages, which individually have their own responses.", + "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "GoogleCloudVisionV1p2beta1AnnotateFileResponse", "properties": { "error": { "$ref": "Status", - "description": "If set, represents the error message for the failed request. The\n`responses` field will not be set in this case." + "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." }, "inputConfig": { "$ref": "GoogleCloudVisionV1p2beta1InputConfig", "description": "Information about the file for which this response is generated." }, "responses": { - "description": "Individual responses to images found within the file. This field will be\nempty if the `error` field is set.", + "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "GoogleCloudVisionV1p2beta1AnnotateImageResponse" }, @@ -3649,7 +3649,7 @@ "properties": { "context": { "$ref": "GoogleCloudVisionV1p2beta1ImageAnnotationContext", - "description": "If present, contextual information is needed to understand where this image\ncomes from." + "description": "If present, contextual information is needed to understand where this image comes from." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p2beta1CropHintsAnnotation", @@ -3657,7 +3657,7 @@ }, "error": { "$ref": "Status", - "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." + "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set." }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", @@ -3668,7 +3668,7 @@ }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p2beta1TextAnnotation", - "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." + "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." }, "imagePropertiesAnnotation": { "$ref": "GoogleCloudVisionV1p2beta1ImageProperties", @@ -3689,7 +3689,7 @@ "type": "array" }, "localizedObjectAnnotations": { - "description": "If present, localized object detection has completed successfully.\nThis will be sorted descending by confidence score.", + "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation" }, @@ -3740,7 +3740,7 @@ "id": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, one for each request in\nAsyncBatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse" }, @@ -3775,7 +3775,7 @@ }, "boundingBox": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", @@ -3818,7 +3818,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1ColorInfo": { - "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", + "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "GoogleCloudVisionV1p2beta1ColorInfo", "properties": { "color": { @@ -3826,7 +3826,7 @@ "description": "RGB components of the color." }, "pixelFraction": { - "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", + "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" }, @@ -3844,15 +3844,15 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale." + "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { - "description": "Confidence of this being a salient region. Range [0, 1].", + "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { - "description": "Fraction of importance of this salient region with respect to the original\nimage.", + "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } @@ -3893,10 +3893,10 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." + "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "confidence": { - "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", + "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float", "type": "number" }, @@ -3905,22 +3905,22 @@ "type": "string" }, "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", + "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "locations": { - "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", + "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "GoogleCloudVisionV1p2beta1LocationInfo" }, "type": "array" }, "mid": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", + "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "properties": { - "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", + "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "items": { "$ref": "GoogleCloudVisionV1p2beta1Property" }, @@ -3932,7 +3932,7 @@ "type": "number" }, "topicality": { - "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", + "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float", "type": "number" } @@ -3985,7 +3985,7 @@ }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." + "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", @@ -3994,7 +3994,7 @@ }, "fdBoundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe fd (face detection) prefix." + "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." }, "headwearLikelihood": { "description": "Headwear likelihood.", @@ -4049,12 +4049,12 @@ "type": "array" }, "panAngle": { - "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", + "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "rollAngle": { - "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", + "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "format": "float", "type": "number" }, @@ -4099,7 +4099,7 @@ "type": "string" }, "tiltAngle": { - "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", + "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, @@ -4220,7 +4220,7 @@ "id": "GoogleCloudVisionV1p2beta1GcsDestination", "properties": { "uri": { - "description": "Google Cloud Storage URI prefix where the results will be stored. Results\nwill be in JSON format and preceded by its corresponding input URI prefix.\nThis field can either represent a gcs file prefix or gcs directory. In\neither case, the uri should be unique because in order to get all of the\noutput files, you will need to do a wildcard gcs search on the uri prefix\nyou provide.\n\nExamples:\n\n* File Prefix: gs://bucket-name/here/filenameprefix The output files\nwill be created in gs://bucket-name/here/ and the names of the\noutput files will begin with \"filenameprefix\".\n\n* Directory Prefix: gs://bucket-name/some/location/ The output files\nwill be created in gs://bucket-name/some/location/ and the names of the\noutput files could be anything because there was no filename prefix\nspecified.\n\nIf multiple outputs, each response is still AnnotateFileResponse, each of\nwhich contains some subset of the full list of AnnotateImageResponse.\nMultiple outputs can happen if, for example, the output JSON is too large\nand overflows into multiple sharded files.", + "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, @@ -4231,18 +4231,18 @@ "id": "GoogleCloudVisionV1p2beta1GcsSource", "properties": { "uri": { - "description": "Google Cloud Storage URI for the input file. This must only be a\nGoogle Cloud Storage object. Wildcards are not currently supported.", + "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1ImageAnnotationContext": { - "description": "If an image was produced from a file (e.g. a PDF), this message gives\ninformation about the source of that image.", + "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "GoogleCloudVisionV1p2beta1ImageAnnotationContext", "properties": { "pageNumber": { - "description": "If the file was a PDF or TIFF, this field gives the page number within\nthe file used to produce the image.", + "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" }, @@ -4269,7 +4269,7 @@ "id": "GoogleCloudVisionV1p2beta1InputConfig", "properties": { "content": { - "description": "File content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateFiles requests. It does\nnot work for AsyncBatchAnnotateFiles requests.", + "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "format": "byte", "type": "string" }, @@ -4278,7 +4278,7 @@ "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { - "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and\n\"image/gif\" are supported. Wildcards are not supported.", + "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } }, @@ -4293,7 +4293,7 @@ "description": "Image region to which this object belongs. This must be populated." }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -4324,7 +4324,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1NormalizedVertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the normalized vertex coordinates are relative to the original image\nand range from 0 to 1.", + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudVisionV1p2beta1NormalizedVertex", "properties": { "x": { @@ -4380,7 +4380,7 @@ "id": "GoogleCloudVisionV1p2beta1OutputConfig", "properties": { "batchSize": { - "description": "The max number of response protos to put into each output JSON file on\nGoogle Cloud Storage.\nThe valid range is [1, 100]. If not specified, the default value is 20.\n\nFor example, for one pdf file with 100 pages, 100 response protos will\nbe generated. If `batch_size` = 20, then 5 json files each\ncontaining 20 response protos will be written under the prefix\n`gcs_destination`.`uri`.\n\nCurrently, batch_size only applies to GcsDestination, with potential future\nsupport for other output configurations.", + "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, @@ -4408,7 +4408,7 @@ "type": "number" }, "height": { - "description": "Page height. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, @@ -4417,7 +4417,7 @@ "description": "Additional information detected on the page." }, "width": { - "description": "Page width. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" } @@ -4430,7 +4430,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", @@ -4452,7 +4452,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1Position": { - "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", + "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p2beta1Position", "properties": { "x": { @@ -4478,23 +4478,23 @@ "id": "GoogleCloudVisionV1p2beta1Product", "properties": { "description": { - "description": "User-provided metadata to be stored with this product. Must be at most 4096\ncharacters long.", + "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "displayName": { - "description": "The user-provided name for this Product. Must not be empty. Must be at most\n4096 characters long.", + "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { - "description": "The resource name of the product.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.\n\nThis field is ignored when creating a product.", + "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "productCategory": { - "description": "Immutable. The category for the product identified by the reference image. This should\nbe either \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\". The legacy categories\n\"homegoods\", \"apparel\", and \"toys\" are still supported, but these should\nnot be used for new products.", + "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { - "description": "Key-value pairs that can be attached to a product. At query time,\nconstraints can be specified based on the product_labels.\n\nNote that integer values can be provided as strings, e.g. \"1199\". Only\nstrings with integer values can match a range-based restriction which is\nto be supported soon.\n\nMultiple values can be assigned to the same key. One product may have up to\n500 product_labels.\n\nNotice that the total number of distinct product_labels over all products\nin one ProductSet cannot exceed 1M, otherwise the product search pipeline\nwill refuse to work for that ProductSet.", + "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.", "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductKeyValue" }, @@ -4508,11 +4508,11 @@ "id": "GoogleCloudVisionV1p2beta1ProductKeyValue", "properties": { "key": { - "description": "The key of the label attached to the product. Cannot be empty and cannot\nexceed 128 bytes.", + "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { - "description": "The value of the label attached to the product. Cannot be empty and\ncannot exceed 128 bytes.", + "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, @@ -4523,12 +4523,12 @@ "id": "GoogleCloudVisionV1p2beta1ProductSearchResults", "properties": { "indexTime": { - "description": "Timestamp of the index which provided these results. Products added to the\nproduct set and products removed from the product set after this time are\nnot reflected in the current results.", + "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime", "type": "string" }, "productGroupedResults": { - "description": "List of results grouped by products detected in the query image. Each entry\ncorresponds to one bounding polygon in the query image, and contains the\nmatching products specific to that region. There may be duplicate product\nmatches in the union of all the per-product results.", + "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult" }, @@ -4545,7 +4545,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult": { - "description": "Information about the products similar to a single product in a query\nimage.", + "description": "Information about the products similar to a single product in a query image.", "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult", "properties": { "boundingPoly": { @@ -4574,7 +4574,7 @@ "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation", "properties": { "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -4598,7 +4598,7 @@ "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsResult", "properties": { "image": { - "description": "The resource name of the image from the product that is the closest match\nto the query.", + "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { @@ -4606,7 +4606,7 @@ "description": "The Product." }, "score": { - "description": "A confidence level on the match, ranging from 0 (no confidence) to\n1 (full confidence).", + "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" } @@ -4634,11 +4634,11 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1SafeSearchAnnotation": { - "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", + "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "GoogleCloudVisionV1p2beta1SafeSearchAnnotation", "properties": { "adult": { - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -4678,7 +4678,7 @@ "type": "string" }, "racy": { - "description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.", + "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -4698,7 +4698,7 @@ "type": "string" }, "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -4746,7 +4746,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", @@ -4765,7 +4765,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1TextAnnotation": { - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", + "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "GoogleCloudVisionV1p2beta1TextAnnotation", "properties": { "pages": { @@ -4805,7 +4805,7 @@ "Regular space.", "Sure space (very wide).", "Line-wrapping break.", - "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", + "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" @@ -4823,7 +4823,7 @@ "type": "number" }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -4848,7 +4848,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1Vertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p2beta1Vertex", "properties": { "x": { @@ -4869,14 +4869,14 @@ "id": "GoogleCloudVisionV1p2beta1WebDetection", "properties": { "bestGuessLabels": { - "description": "The service's best guess as to the topic of the request image.\nInferred from similar images on the open web.", + "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebLabel" }, "type": "array" }, "fullMatchingImages": { - "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", + "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, @@ -4890,7 +4890,7 @@ "type": "array" }, "partialMatchingImages": { - "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", + "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, @@ -4926,7 +4926,7 @@ "type": "string" }, "score": { - "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", + "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } @@ -4958,7 +4958,7 @@ "type": "string" }, "languageCode": { - "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -4969,7 +4969,7 @@ "id": "GoogleCloudVisionV1p2beta1WebDetectionWebPage", "properties": { "fullMatchingImages": { - "description": "Fully matching images on the page.\nCan include resized copies of the query image.", + "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, @@ -4980,7 +4980,7 @@ "type": "string" }, "partialMatchingImages": { - "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", + "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, @@ -5004,7 +5004,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", @@ -5016,7 +5016,7 @@ "description": "Additional information detected for the word." }, "symbols": { - "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", + "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "GoogleCloudVisionV1p2beta1Symbol" }, @@ -5026,19 +5026,19 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1AnnotateFileResponse": { - "description": "Response to a single file annotation request. A file may contain one or more\nimages, which individually have their own responses.", + "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "GoogleCloudVisionV1p3beta1AnnotateFileResponse", "properties": { "error": { "$ref": "Status", - "description": "If set, represents the error message for the failed request. The\n`responses` field will not be set in this case." + "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." }, "inputConfig": { "$ref": "GoogleCloudVisionV1p3beta1InputConfig", "description": "Information about the file for which this response is generated." }, "responses": { - "description": "Individual responses to images found within the file. This field will be\nempty if the `error` field is set.", + "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "GoogleCloudVisionV1p3beta1AnnotateImageResponse" }, @@ -5058,7 +5058,7 @@ "properties": { "context": { "$ref": "GoogleCloudVisionV1p3beta1ImageAnnotationContext", - "description": "If present, contextual information is needed to understand where this image\ncomes from." + "description": "If present, contextual information is needed to understand where this image comes from." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p3beta1CropHintsAnnotation", @@ -5066,7 +5066,7 @@ }, "error": { "$ref": "Status", - "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." + "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set." }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", @@ -5077,7 +5077,7 @@ }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p3beta1TextAnnotation", - "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." + "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." }, "imagePropertiesAnnotation": { "$ref": "GoogleCloudVisionV1p3beta1ImageProperties", @@ -5098,7 +5098,7 @@ "type": "array" }, "localizedObjectAnnotations": { - "description": "If present, localized object detection has completed successfully.\nThis will be sorted descending by confidence score.", + "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation" }, @@ -5149,7 +5149,7 @@ "id": "GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, one for each request in\nAsyncBatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse" }, @@ -5159,11 +5159,11 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1BatchOperationMetadata": { - "description": "Metadata for the batch operations such as the current state.\n\nThis is included in the `metadata` field of the `Operation` returned by the\n`GetOperation` call of the `google::longrunning::Operations` service.", + "description": "Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.", "id": "GoogleCloudVisionV1p3beta1BatchOperationMetadata", "properties": { "endTime": { - "description": "The time when the batch request is finished and\ngoogle.longrunning.Operation.done is set to true.", + "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.", "format": "google-datetime", "type": "string" }, @@ -5179,9 +5179,9 @@ "enumDescriptions": [ "Invalid.", "Request is actively being processed.", - "The request is done and at least one item has been successfully\nprocessed.", + "The request is done and at least one item has been successfully processed.", "The request is done and no item has been successfully processed.", - "The request is done after the longrunning.Operations.CancelOperation has\nbeen called by the user. Any records that were processed before the\ncancel command are output as specified in the request." + "The request is done after the longrunning.Operations.CancelOperation has been called by the user. Any records that were processed before the cancel command are output as specified in the request." ], "type": "string" }, @@ -5219,7 +5219,7 @@ }, "boundingBox": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", @@ -5262,7 +5262,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1ColorInfo": { - "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", + "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "GoogleCloudVisionV1p3beta1ColorInfo", "properties": { "color": { @@ -5270,7 +5270,7 @@ "description": "RGB components of the color." }, "pixelFraction": { - "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", + "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" }, @@ -5288,15 +5288,15 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale." + "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { - "description": "Confidence of this being a salient region. Range [0, 1].", + "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { - "description": "Fraction of importance of this salient region with respect to the original\nimage.", + "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } @@ -5337,10 +5337,10 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." + "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "confidence": { - "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", + "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float", "type": "number" }, @@ -5349,22 +5349,22 @@ "type": "string" }, "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", + "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "locations": { - "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", + "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "GoogleCloudVisionV1p3beta1LocationInfo" }, "type": "array" }, "mid": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", + "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "properties": { - "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", + "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "items": { "$ref": "GoogleCloudVisionV1p3beta1Property" }, @@ -5376,7 +5376,7 @@ "type": "number" }, "topicality": { - "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", + "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float", "type": "number" } @@ -5429,7 +5429,7 @@ }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." + "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", @@ -5438,7 +5438,7 @@ }, "fdBoundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe fd (face detection) prefix." + "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." }, "headwearLikelihood": { "description": "Headwear likelihood.", @@ -5493,12 +5493,12 @@ "type": "array" }, "panAngle": { - "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", + "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "rollAngle": { - "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", + "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "format": "float", "type": "number" }, @@ -5543,7 +5543,7 @@ "type": "string" }, "tiltAngle": { - "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", + "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, @@ -5664,7 +5664,7 @@ "id": "GoogleCloudVisionV1p3beta1GcsDestination", "properties": { "uri": { - "description": "Google Cloud Storage URI prefix where the results will be stored. Results\nwill be in JSON format and preceded by its corresponding input URI prefix.\nThis field can either represent a gcs file prefix or gcs directory. In\neither case, the uri should be unique because in order to get all of the\noutput files, you will need to do a wildcard gcs search on the uri prefix\nyou provide.\n\nExamples:\n\n* File Prefix: gs://bucket-name/here/filenameprefix The output files\nwill be created in gs://bucket-name/here/ and the names of the\noutput files will begin with \"filenameprefix\".\n\n* Directory Prefix: gs://bucket-name/some/location/ The output files\nwill be created in gs://bucket-name/some/location/ and the names of the\noutput files could be anything because there was no filename prefix\nspecified.\n\nIf multiple outputs, each response is still AnnotateFileResponse, each of\nwhich contains some subset of the full list of AnnotateImageResponse.\nMultiple outputs can happen if, for example, the output JSON is too large\nand overflows into multiple sharded files.", + "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, @@ -5675,18 +5675,18 @@ "id": "GoogleCloudVisionV1p3beta1GcsSource", "properties": { "uri": { - "description": "Google Cloud Storage URI for the input file. This must only be a\nGoogle Cloud Storage object. Wildcards are not currently supported.", + "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p3beta1ImageAnnotationContext": { - "description": "If an image was produced from a file (e.g. a PDF), this message gives\ninformation about the source of that image.", + "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "GoogleCloudVisionV1p3beta1ImageAnnotationContext", "properties": { "pageNumber": { - "description": "If the file was a PDF or TIFF, this field gives the page number within\nthe file used to produce the image.", + "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" }, @@ -5709,7 +5709,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1ImportProductSetsResponse": { - "description": "Response message for the `ImportProductSets` method.\n\nThis message is returned by the\ngoogle.longrunning.Operations.GetOperation method in the returned\ngoogle.longrunning.Operation.response field.", + "description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.", "id": "GoogleCloudVisionV1p3beta1ImportProductSetsResponse", "properties": { "referenceImages": { @@ -5720,7 +5720,7 @@ "type": "array" }, "statuses": { - "description": "The rpc status for each ImportProductSet request, including both successes\nand errors.\n\nThe number of statuses here matches the number of lines in the csv file,\nand statuses[i] stores the success or failure status of processing the i-th\nline of the csv, starting from line 0.", + "description": "The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.", "items": { "$ref": "Status" }, @@ -5734,7 +5734,7 @@ "id": "GoogleCloudVisionV1p3beta1InputConfig", "properties": { "content": { - "description": "File content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateFiles requests. It does\nnot work for AsyncBatchAnnotateFiles requests.", + "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "format": "byte", "type": "string" }, @@ -5743,7 +5743,7 @@ "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { - "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and\n\"image/gif\" are supported. Wildcards are not supported.", + "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } }, @@ -5758,7 +5758,7 @@ "description": "Image region to which this object belongs. This must be populated." }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -5789,7 +5789,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1NormalizedVertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the normalized vertex coordinates are relative to the original image\nand range from 0 to 1.", + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudVisionV1p3beta1NormalizedVertex", "properties": { "x": { @@ -5845,7 +5845,7 @@ "id": "GoogleCloudVisionV1p3beta1OutputConfig", "properties": { "batchSize": { - "description": "The max number of response protos to put into each output JSON file on\nGoogle Cloud Storage.\nThe valid range is [1, 100]. If not specified, the default value is 20.\n\nFor example, for one pdf file with 100 pages, 100 response protos will\nbe generated. If `batch_size` = 20, then 5 json files each\ncontaining 20 response protos will be written under the prefix\n`gcs_destination`.`uri`.\n\nCurrently, batch_size only applies to GcsDestination, with potential future\nsupport for other output configurations.", + "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, @@ -5873,7 +5873,7 @@ "type": "number" }, "height": { - "description": "Page height. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, @@ -5882,7 +5882,7 @@ "description": "Additional information detected on the page." }, "width": { - "description": "Page width. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" } @@ -5895,7 +5895,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", @@ -5917,7 +5917,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1Position": { - "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", + "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p3beta1Position", "properties": { "x": { @@ -5943,23 +5943,23 @@ "id": "GoogleCloudVisionV1p3beta1Product", "properties": { "description": { - "description": "User-provided metadata to be stored with this product. Must be at most 4096\ncharacters long.", + "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "displayName": { - "description": "The user-provided name for this Product. Must not be empty. Must be at most\n4096 characters long.", + "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { - "description": "The resource name of the product.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.\n\nThis field is ignored when creating a product.", + "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "productCategory": { - "description": "Immutable. The category for the product identified by the reference image. This should\nbe either \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\". The legacy categories\n\"homegoods\", \"apparel\", and \"toys\" are still supported, but these should\nnot be used for new products.", + "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { - "description": "Key-value pairs that can be attached to a product. At query time,\nconstraints can be specified based on the product_labels.\n\nNote that integer values can be provided as strings, e.g. \"1199\". Only\nstrings with integer values can match a range-based restriction which is\nto be supported soon.\n\nMultiple values can be assigned to the same key. One product may have up to\n500 product_labels.\n\nNotice that the total number of distinct product_labels over all products\nin one ProductSet cannot exceed 1M, otherwise the product search pipeline\nwill refuse to work for that ProductSet.", + "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.", "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductKeyValue" }, @@ -5973,11 +5973,11 @@ "id": "GoogleCloudVisionV1p3beta1ProductKeyValue", "properties": { "key": { - "description": "The key of the label attached to the product. Cannot be empty and cannot\nexceed 128 bytes.", + "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { - "description": "The value of the label attached to the product. Cannot be empty and\ncannot exceed 128 bytes.", + "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, @@ -5988,12 +5988,12 @@ "id": "GoogleCloudVisionV1p3beta1ProductSearchResults", "properties": { "indexTime": { - "description": "Timestamp of the index which provided these results. Products added to the\nproduct set and products removed from the product set after this time are\nnot reflected in the current results.", + "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime", "type": "string" }, "productGroupedResults": { - "description": "List of results grouped by products detected in the query image. Each entry\ncorresponds to one bounding polygon in the query image, and contains the\nmatching products specific to that region. There may be duplicate product\nmatches in the union of all the per-product results.", + "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult" }, @@ -6010,7 +6010,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult": { - "description": "Information about the products similar to a single product in a query\nimage.", + "description": "Information about the products similar to a single product in a query image.", "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult", "properties": { "boundingPoly": { @@ -6039,7 +6039,7 @@ "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation", "properties": { "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -6063,7 +6063,7 @@ "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsResult", "properties": { "image": { - "description": "The resource name of the image from the product that is the closest match\nto the query.", + "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { @@ -6071,7 +6071,7 @@ "description": "The Product." }, "score": { - "description": "A confidence level on the match, ranging from 0 (no confidence) to\n1 (full confidence).", + "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" } @@ -6099,33 +6099,33 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1ReferenceImage": { - "description": "A `ReferenceImage` represents a product image and its associated metadata,\nsuch as bounding boxes.", + "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.", "id": "GoogleCloudVisionV1p3beta1ReferenceImage", "properties": { "boundingPolys": { - "description": "Optional. Bounding polygons around the areas of interest in the reference image.\nIf this field is empty, the system will try to detect regions of\ninterest. At most 10 bounding polygons will be used.\n\nThe provided shape is converted into a non-rotated rectangle. Once\nconverted, the small edge of the rectangle must be greater than or equal\nto 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5\nis not).", + "description": "Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).", "items": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "type": "array" }, "name": { - "description": "The resource name of the reference image.\n\nFormat is:\n\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.\n\nThis field is ignored when creating a reference image.", + "description": "The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.", "type": "string" }, "uri": { - "description": "Required. The Google Cloud Storage URI of the reference image.\n\nThe URI must start with `gs://`.", + "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p3beta1SafeSearchAnnotation": { - "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", + "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "GoogleCloudVisionV1p3beta1SafeSearchAnnotation", "properties": { "adult": { - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -6165,7 +6165,7 @@ "type": "string" }, "racy": { - "description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.", + "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -6185,7 +6185,7 @@ "type": "string" }, "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -6233,7 +6233,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", @@ -6252,7 +6252,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1TextAnnotation": { - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", + "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "GoogleCloudVisionV1p3beta1TextAnnotation", "properties": { "pages": { @@ -6292,7 +6292,7 @@ "Regular space.", "Sure space (very wide).", "Line-wrapping break.", - "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", + "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" @@ -6310,7 +6310,7 @@ "type": "number" }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -6335,7 +6335,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1Vertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p3beta1Vertex", "properties": { "x": { @@ -6356,14 +6356,14 @@ "id": "GoogleCloudVisionV1p3beta1WebDetection", "properties": { "bestGuessLabels": { - "description": "The service's best guess as to the topic of the request image.\nInferred from similar images on the open web.", + "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebLabel" }, "type": "array" }, "fullMatchingImages": { - "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", + "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, @@ -6377,7 +6377,7 @@ "type": "array" }, "partialMatchingImages": { - "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", + "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, @@ -6413,7 +6413,7 @@ "type": "string" }, "score": { - "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", + "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } @@ -6445,7 +6445,7 @@ "type": "string" }, "languageCode": { - "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -6456,7 +6456,7 @@ "id": "GoogleCloudVisionV1p3beta1WebDetectionWebPage", "properties": { "fullMatchingImages": { - "description": "Fully matching images on the page.\nCan include resized copies of the query image.", + "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, @@ -6467,7 +6467,7 @@ "type": "string" }, "partialMatchingImages": { - "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", + "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, @@ -6491,7 +6491,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", @@ -6503,7 +6503,7 @@ "description": "Additional information detected for the word." }, "symbols": { - "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", + "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "GoogleCloudVisionV1p3beta1Symbol" }, @@ -6513,19 +6513,19 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1AnnotateFileResponse": { - "description": "Response to a single file annotation request. A file may contain one or more\nimages, which individually have their own responses.", + "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "GoogleCloudVisionV1p4beta1AnnotateFileResponse", "properties": { "error": { "$ref": "Status", - "description": "If set, represents the error message for the failed request. The\n`responses` field will not be set in this case." + "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." }, "inputConfig": { "$ref": "GoogleCloudVisionV1p4beta1InputConfig", "description": "Information about the file for which this response is generated." }, "responses": { - "description": "Individual responses to images found within the file. This field will be\nempty if the `error` field is set.", + "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "GoogleCloudVisionV1p4beta1AnnotateImageResponse" }, @@ -6545,7 +6545,7 @@ "properties": { "context": { "$ref": "GoogleCloudVisionV1p4beta1ImageAnnotationContext", - "description": "If present, contextual information is needed to understand where this image\ncomes from." + "description": "If present, contextual information is needed to understand where this image comes from." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p4beta1CropHintsAnnotation", @@ -6553,7 +6553,7 @@ }, "error": { "$ref": "Status", - "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." + "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set." }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", @@ -6564,7 +6564,7 @@ }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p4beta1TextAnnotation", - "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." + "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." }, "imagePropertiesAnnotation": { "$ref": "GoogleCloudVisionV1p4beta1ImageProperties", @@ -6585,7 +6585,7 @@ "type": "array" }, "localizedObjectAnnotations": { - "description": "If present, localized object detection has completed successfully.\nThis will be sorted descending by confidence score.", + "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation" }, @@ -6636,7 +6636,7 @@ "id": "GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, one for each request in\nAsyncBatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse" }, @@ -6661,7 +6661,7 @@ "id": "GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, each response corresponding to each\nAnnotateFileRequest in BatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p4beta1AnnotateFileResponse" }, @@ -6671,11 +6671,11 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1BatchOperationMetadata": { - "description": "Metadata for the batch operations such as the current state.\n\nThis is included in the `metadata` field of the `Operation` returned by the\n`GetOperation` call of the `google::longrunning::Operations` service.", + "description": "Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.", "id": "GoogleCloudVisionV1p4beta1BatchOperationMetadata", "properties": { "endTime": { - "description": "The time when the batch request is finished and\ngoogle.longrunning.Operation.done is set to true.", + "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.", "format": "google-datetime", "type": "string" }, @@ -6691,9 +6691,9 @@ "enumDescriptions": [ "Invalid.", "Request is actively being processed.", - "The request is done and at least one item has been successfully\nprocessed.", + "The request is done and at least one item has been successfully processed.", "The request is done and no item has been successfully processed.", - "The request is done after the longrunning.Operations.CancelOperation has\nbeen called by the user. Any records that were processed before the\ncancel command are output as specified in the request." + "The request is done after the longrunning.Operations.CancelOperation has been called by the user. Any records that were processed before the cancel command are output as specified in the request." ], "type": "string" }, @@ -6731,7 +6731,7 @@ }, "boundingBox": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", @@ -6786,14 +6786,14 @@ "type": "string" }, "name": { - "description": "The resource name of the preloaded Celebrity. Has the format\n`builtin/{mid}`.", + "description": "The resource name of the preloaded Celebrity. Has the format `builtin/{mid}`.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1ColorInfo": { - "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", + "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "GoogleCloudVisionV1p4beta1ColorInfo", "properties": { "color": { @@ -6801,7 +6801,7 @@ "description": "RGB components of the color." }, "pixelFraction": { - "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", + "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" }, @@ -6819,15 +6819,15 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale." + "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { - "description": "Confidence of this being a salient region. Range [0, 1].", + "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { - "description": "Fraction of importance of this salient region with respect to the original\nimage.", + "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } @@ -6868,10 +6868,10 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." + "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "confidence": { - "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", + "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float", "type": "number" }, @@ -6880,22 +6880,22 @@ "type": "string" }, "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", + "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "locations": { - "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", + "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "GoogleCloudVisionV1p4beta1LocationInfo" }, "type": "array" }, "mid": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", + "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "properties": { - "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", + "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "items": { "$ref": "GoogleCloudVisionV1p4beta1Property" }, @@ -6907,7 +6907,7 @@ "type": "number" }, "topicality": { - "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", + "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float", "type": "number" } @@ -6960,7 +6960,7 @@ }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." + "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", @@ -6969,7 +6969,7 @@ }, "fdBoundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe fd (face detection) prefix." + "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." }, "headwearLikelihood": { "description": "Headwear likelihood.", @@ -7024,19 +7024,19 @@ "type": "array" }, "panAngle": { - "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", + "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "recognitionResult": { - "description": "Additional recognition information. Only computed if\nimage_context.face_recognition_params is provided, **and** a match is found\nto a Celebrity in the input CelebritySet. This field is\nsorted in order of decreasing confidence values.", + "description": "Additional recognition information. Only computed if image_context.face_recognition_params is provided, **and** a match is found to a Celebrity in the input CelebritySet. This field is sorted in order of decreasing confidence values.", "items": { "$ref": "GoogleCloudVisionV1p4beta1FaceRecognitionResult" }, "type": "array" }, "rollAngle": { - "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", + "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "format": "float", "type": "number" }, @@ -7081,7 +7081,7 @@ "type": "string" }, "tiltAngle": { - "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", + "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, @@ -7218,7 +7218,7 @@ "id": "GoogleCloudVisionV1p4beta1GcsDestination", "properties": { "uri": { - "description": "Google Cloud Storage URI prefix where the results will be stored. Results\nwill be in JSON format and preceded by its corresponding input URI prefix.\nThis field can either represent a gcs file prefix or gcs directory. In\neither case, the uri should be unique because in order to get all of the\noutput files, you will need to do a wildcard gcs search on the uri prefix\nyou provide.\n\nExamples:\n\n* File Prefix: gs://bucket-name/here/filenameprefix The output files\nwill be created in gs://bucket-name/here/ and the names of the\noutput files will begin with \"filenameprefix\".\n\n* Directory Prefix: gs://bucket-name/some/location/ The output files\nwill be created in gs://bucket-name/some/location/ and the names of the\noutput files could be anything because there was no filename prefix\nspecified.\n\nIf multiple outputs, each response is still AnnotateFileResponse, each of\nwhich contains some subset of the full list of AnnotateImageResponse.\nMultiple outputs can happen if, for example, the output JSON is too large\nand overflows into multiple sharded files.", + "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, @@ -7229,18 +7229,18 @@ "id": "GoogleCloudVisionV1p4beta1GcsSource", "properties": { "uri": { - "description": "Google Cloud Storage URI for the input file. This must only be a\nGoogle Cloud Storage object. Wildcards are not currently supported.", + "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1ImageAnnotationContext": { - "description": "If an image was produced from a file (e.g. a PDF), this message gives\ninformation about the source of that image.", + "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "GoogleCloudVisionV1p4beta1ImageAnnotationContext", "properties": { "pageNumber": { - "description": "If the file was a PDF or TIFF, this field gives the page number within\nthe file used to produce the image.", + "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" }, @@ -7263,7 +7263,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1ImportProductSetsResponse": { - "description": "Response message for the `ImportProductSets` method.\n\nThis message is returned by the\ngoogle.longrunning.Operations.GetOperation method in the returned\ngoogle.longrunning.Operation.response field.", + "description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.", "id": "GoogleCloudVisionV1p4beta1ImportProductSetsResponse", "properties": { "referenceImages": { @@ -7274,7 +7274,7 @@ "type": "array" }, "statuses": { - "description": "The rpc status for each ImportProductSet request, including both successes\nand errors.\n\nThe number of statuses here matches the number of lines in the csv file,\nand statuses[i] stores the success or failure status of processing the i-th\nline of the csv, starting from line 0.", + "description": "The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.", "items": { "$ref": "Status" }, @@ -7288,7 +7288,7 @@ "id": "GoogleCloudVisionV1p4beta1InputConfig", "properties": { "content": { - "description": "File content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateFiles requests. It does\nnot work for AsyncBatchAnnotateFiles requests.", + "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "format": "byte", "type": "string" }, @@ -7297,7 +7297,7 @@ "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { - "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and\n\"image/gif\" are supported. Wildcards are not supported.", + "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } }, @@ -7312,7 +7312,7 @@ "description": "Image region to which this object belongs. This must be populated." }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -7343,7 +7343,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1NormalizedVertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the normalized vertex coordinates are relative to the original image\nand range from 0 to 1.", + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudVisionV1p4beta1NormalizedVertex", "properties": { "x": { @@ -7399,7 +7399,7 @@ "id": "GoogleCloudVisionV1p4beta1OutputConfig", "properties": { "batchSize": { - "description": "The max number of response protos to put into each output JSON file on\nGoogle Cloud Storage.\nThe valid range is [1, 100]. If not specified, the default value is 20.\n\nFor example, for one pdf file with 100 pages, 100 response protos will\nbe generated. If `batch_size` = 20, then 5 json files each\ncontaining 20 response protos will be written under the prefix\n`gcs_destination`.`uri`.\n\nCurrently, batch_size only applies to GcsDestination, with potential future\nsupport for other output configurations.", + "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, @@ -7427,7 +7427,7 @@ "type": "number" }, "height": { - "description": "Page height. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, @@ -7436,7 +7436,7 @@ "description": "Additional information detected on the page." }, "width": { - "description": "Page width. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" } @@ -7449,7 +7449,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", @@ -7471,7 +7471,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1Position": { - "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", + "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p4beta1Position", "properties": { "x": { @@ -7497,23 +7497,23 @@ "id": "GoogleCloudVisionV1p4beta1Product", "properties": { "description": { - "description": "User-provided metadata to be stored with this product. Must be at most 4096\ncharacters long.", + "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "displayName": { - "description": "The user-provided name for this Product. Must not be empty. Must be at most\n4096 characters long.", + "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { - "description": "The resource name of the product.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.\n\nThis field is ignored when creating a product.", + "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "productCategory": { - "description": "Immutable. The category for the product identified by the reference image. This should\nbe either \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\". The legacy categories\n\"homegoods\", \"apparel\", and \"toys\" are still supported, but these should\nnot be used for new products.", + "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { - "description": "Key-value pairs that can be attached to a product. At query time,\nconstraints can be specified based on the product_labels.\n\nNote that integer values can be provided as strings, e.g. \"1199\". Only\nstrings with integer values can match a range-based restriction which is\nto be supported soon.\n\nMultiple values can be assigned to the same key. One product may have up to\n500 product_labels.\n\nNotice that the total number of distinct product_labels over all products\nin one ProductSet cannot exceed 1M, otherwise the product search pipeline\nwill refuse to work for that ProductSet.", + "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductKeyValue" }, @@ -7527,11 +7527,11 @@ "id": "GoogleCloudVisionV1p4beta1ProductKeyValue", "properties": { "key": { - "description": "The key of the label attached to the product. Cannot be empty and cannot\nexceed 128 bytes.", + "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { - "description": "The value of the label attached to the product. Cannot be empty and\ncannot exceed 128 bytes.", + "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, @@ -7542,12 +7542,12 @@ "id": "GoogleCloudVisionV1p4beta1ProductSearchResults", "properties": { "indexTime": { - "description": "Timestamp of the index which provided these results. Products added to the\nproduct set and products removed from the product set after this time are\nnot reflected in the current results.", + "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime", "type": "string" }, "productGroupedResults": { - "description": "List of results grouped by products detected in the query image. Each entry\ncorresponds to one bounding polygon in the query image, and contains the\nmatching products specific to that region. There may be duplicate product\nmatches in the union of all the per-product results.", + "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult" }, @@ -7564,7 +7564,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult": { - "description": "Information about the products similar to a single product in a query\nimage.", + "description": "Information about the products similar to a single product in a query image.", "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult", "properties": { "boundingPoly": { @@ -7593,7 +7593,7 @@ "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation", "properties": { "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -7617,7 +7617,7 @@ "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsResult", "properties": { "image": { - "description": "The resource name of the image from the product that is the closest match\nto the query.", + "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { @@ -7625,7 +7625,7 @@ "description": "The Product." }, "score": { - "description": "A confidence level on the match, ranging from 0 (no confidence) to\n1 (full confidence).", + "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" } @@ -7653,33 +7653,33 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1ReferenceImage": { - "description": "A `ReferenceImage` represents a product image and its associated metadata,\nsuch as bounding boxes.", + "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.", "id": "GoogleCloudVisionV1p4beta1ReferenceImage", "properties": { "boundingPolys": { - "description": "Optional. Bounding polygons around the areas of interest in the reference image.\nIf this field is empty, the system will try to detect regions of\ninterest. At most 10 bounding polygons will be used.\n\nThe provided shape is converted into a non-rotated rectangle. Once\nconverted, the small edge of the rectangle must be greater than or equal\nto 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5\nis not).", + "description": "Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).", "items": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "type": "array" }, "name": { - "description": "The resource name of the reference image.\n\nFormat is:\n\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.\n\nThis field is ignored when creating a reference image.", + "description": "The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.", "type": "string" }, "uri": { - "description": "Required. The Google Cloud Storage URI of the reference image.\n\nThe URI must start with `gs://`.", + "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1SafeSearchAnnotation": { - "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", + "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "GoogleCloudVisionV1p4beta1SafeSearchAnnotation", "properties": { "adult": { - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -7719,7 +7719,7 @@ "type": "string" }, "racy": { - "description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.", + "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -7739,7 +7739,7 @@ "type": "string" }, "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -7787,7 +7787,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", @@ -7806,7 +7806,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1TextAnnotation": { - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", + "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "GoogleCloudVisionV1p4beta1TextAnnotation", "properties": { "pages": { @@ -7846,7 +7846,7 @@ "Regular space.", "Sure space (very wide).", "Line-wrapping break.", - "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", + "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" @@ -7864,7 +7864,7 @@ "type": "number" }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -7889,7 +7889,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1Vertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p4beta1Vertex", "properties": { "x": { @@ -7910,14 +7910,14 @@ "id": "GoogleCloudVisionV1p4beta1WebDetection", "properties": { "bestGuessLabels": { - "description": "The service's best guess as to the topic of the request image.\nInferred from similar images on the open web.", + "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebLabel" }, "type": "array" }, "fullMatchingImages": { - "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", + "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, @@ -7931,7 +7931,7 @@ "type": "array" }, "partialMatchingImages": { - "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", + "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, @@ -7967,7 +7967,7 @@ "type": "string" }, "score": { - "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", + "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } @@ -7999,7 +7999,7 @@ "type": "string" }, "languageCode": { - "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -8010,7 +8010,7 @@ "id": "GoogleCloudVisionV1p4beta1WebDetectionWebPage", "properties": { "fullMatchingImages": { - "description": "Fully matching images on the page.\nCan include resized copies of the query image.", + "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, @@ -8021,7 +8021,7 @@ "type": "string" }, "partialMatchingImages": { - "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", + "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, @@ -8045,7 +8045,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", @@ -8057,7 +8057,7 @@ "description": "Additional information detected for the word." }, "symbols": { - "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", + "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "GoogleCloudVisionV1p4beta1Symbol" }, @@ -8067,7 +8067,7 @@ "type": "object" }, "GroupedResult": { - "description": "Information about the products similar to a single product in a query\nimage.", + "description": "Information about the products similar to a single product in a query image.", "id": "GroupedResult", "properties": { "boundingPoly": { @@ -8096,23 +8096,23 @@ "id": "Image", "properties": { "content": { - "description": "Image content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateImages requests. It does\nnot work for AsyncBatchAnnotateImages requests.", + "description": "Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateImages requests. It does not work for AsyncBatchAnnotateImages requests.", "format": "byte", "type": "string" }, "source": { "$ref": "ImageSource", - "description": "Google Cloud Storage image location, or publicly-accessible image\nURL. If both `content` and `source` are provided for an image, `content`\ntakes precedence and is used to perform the image annotation request." + "description": "Google Cloud Storage image location, or publicly-accessible image URL. If both `content` and `source` are provided for an image, `content` takes precedence and is used to perform the image annotation request." } }, "type": "object" }, "ImageAnnotationContext": { - "description": "If an image was produced from a file (e.g. a PDF), this message gives\ninformation about the source of that image.", + "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "ImageAnnotationContext", "properties": { "pageNumber": { - "description": "If the file was a PDF or TIFF, this field gives the page number within\nthe file used to produce the image.", + "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" }, @@ -8132,7 +8132,7 @@ "description": "Parameters for crop hints annotation request." }, "languageHints": { - "description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value\nyields the best results since it enables automatic language detection. For\nlanguages based on the Latin alphabet, setting `language_hints` is not\nneeded. In rare cases, when the language of the text in the image is known,\nsetting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong). Text detection returns an\nerror if one or more of the specified languages is not one of the\n[supported languages](https://cloud.google.com/vision/docs/languages).", + "description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](https://cloud.google.com/vision/docs/languages).", "items": { "type": "string" }, @@ -8169,22 +8169,22 @@ "id": "ImageSource", "properties": { "gcsImageUri": { - "description": "**Use `image_uri` instead.**\n\nThe Google Cloud Storage URI of the form\n`gs://bucket_name/object_name`. Object versioning is not supported. See\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris) for more info.", + "description": "**Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.", "type": "string" }, "imageUri": { - "description": "The URI of the source image. Can be either:\n\n1. A Google Cloud Storage URI of the form\n `gs://bucket_name/object_name`. Object versioning is not supported. See\n [Google Cloud Storage Request\n URIs](https://cloud.google.com/storage/docs/reference-uris) for more\n info.\n\n2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from\n HTTP/HTTPS URLs, Google cannot guarantee that the request will be\n completed. Your request may fail if the specified host denies the\n request (e.g. due to request throttling or DOS prevention), or if Google\n throttles requests to the site for abuse prevention. You should not\n depend on externally-hosted images for production applications.\n\nWhen both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes\nprecedence.", + "description": "The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence.", "type": "string" } }, "type": "object" }, "ImportProductSetsGcsSource": { - "description": "The Google Cloud Storage location for a csv file which preserves a list of\nImportProductSetRequests in each line.", + "description": "The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line.", "id": "ImportProductSetsGcsSource", "properties": { "csvFileUri": { - "description": "The Google Cloud Storage URI of the input csv file.\n\nThe URI must start with `gs://`.\n\nThe format of the input csv file should be one image per line.\nIn each line, there are 8 columns.\n\n1. image-uri\n2. image-id\n3. product-set-id\n4. product-id\n5. product-category\n6. product-display-name\n7. labels\n8. bounding-poly\n\nThe `image-uri`, `product-set-id`, `product-id`, and `product-category`\ncolumns are required. All other columns are optional.\n\nIf the `ProductSet` or `Product` specified by the `product-set-id` and\n`product-id` values does not exist, then the system will create a new\n`ProductSet` or `Product` for the image. In this case, the\n`product-display-name` column refers to\ndisplay_name, the\n`product-category` column refers to\nproduct_category, and the\n`labels` column refers to product_labels.\n\nThe `image-id` column is optional but must be unique if provided. If it is\nempty, the system will automatically assign a unique id to the image.\n\nThe `product-display-name` column is optional. If it is empty, the system\nsets the display_name field for the product to a\nspace (\" \"). You can update the `display_name` later by using the API.\n\nIf a `Product` with the specified `product-id` already exists, then the\nsystem ignores the `product-display-name`, `product-category`, and `labels`\ncolumns.\n\nThe `labels` column (optional) is a line containing a list of\ncomma-separated key-value pairs, in the following format:\n\n \"key_1=value_1,key_2=value_2,...,key_n=value_n\"\n\nThe `bounding-poly` column (optional) identifies one region of\ninterest from the image in the same manner as `CreateReferenceImage`. If\nyou do not specify the `bounding-poly` column, then the system will try to\ndetect regions of interest automatically.\n\nAt most one `bounding-poly` column is allowed per line. If the image\ncontains multiple regions of interest, add a line to the CSV file that\nincludes the same product information, and the `bounding-poly` values for\neach region of interest.\n\nThe `bounding-poly` column must contain an even number of comma-separated\nnumbers, in the format \"p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y\". Use\nnon-negative integers for absolute bounding polygons, and float values\nin [0, 1] for normalized bounding polygons.\n\nThe system will resize the image if the image resolution is too\nlarge to process (larger than 20MP).", + "description": "The Google Cloud Storage URI of the input csv file. The URI must start with `gs://`. The format of the input csv file should be one image per line. In each line, there are 8 columns. 1. image-uri 2. image-id 3. product-set-id 4. product-id 5. product-category 6. product-display-name 7. labels 8. bounding-poly The `image-uri`, `product-set-id`, `product-id`, and `product-category` columns are required. All other columns are optional. If the `ProductSet` or `Product` specified by the `product-set-id` and `product-id` values does not exist, then the system will create a new `ProductSet` or `Product` for the image. In this case, the `product-display-name` column refers to display_name, the `product-category` column refers to product_category, and the `labels` column refers to product_labels. The `image-id` column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image. The `product-display-name` column is optional. If it is empty, the system sets the display_name field for the product to a space (\" \"). You can update the `display_name` later by using the API. If a `Product` with the specified `product-id` already exists, then the system ignores the `product-display-name`, `product-category`, and `labels` columns. The `labels` column (optional) is a line containing a list of comma-separated key-value pairs, in the following format: \"key_1=value_1,key_2=value_2,...,key_n=value_n\" The `bounding-poly` column (optional) identifies one region of interest from the image in the same manner as `CreateReferenceImage`. If you do not specify the `bounding-poly` column, then the system will try to detect regions of interest automatically. At most one `bounding-poly` column is allowed per line. If the image contains multiple regions of interest, add a line to the CSV file that includes the same product information, and the `bounding-poly` values for each region of interest. The `bounding-poly` column must contain an even number of comma-separated numbers, in the format \"p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y\". Use non-negative integers for absolute bounding polygons, and float values in [0, 1] for normalized bounding polygons. The system will resize the image if the image resolution is too large to process (larger than 20MP).", "type": "string" } }, @@ -8196,7 +8196,7 @@ "properties": { "gcsSource": { "$ref": "ImportProductSetsGcsSource", - "description": "The Google Cloud Storage location for a csv file which preserves a list\nof ImportProductSetRequests in each line." + "description": "The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line." } }, "type": "object" @@ -8213,7 +8213,7 @@ "type": "object" }, "ImportProductSetsResponse": { - "description": "Response message for the `ImportProductSets` method.\n\nThis message is returned by the\ngoogle.longrunning.Operations.GetOperation method in the returned\ngoogle.longrunning.Operation.response field.", + "description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.", "id": "ImportProductSetsResponse", "properties": { "referenceImages": { @@ -8224,7 +8224,7 @@ "type": "array" }, "statuses": { - "description": "The rpc status for each ImportProductSet request, including both successes\nand errors.\n\nThe number of statuses here matches the number of lines in the csv file,\nand statuses[i] stores the success or failure status of processing the i-th\nline of the csv, starting from line 0.", + "description": "The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.", "items": { "$ref": "Status" }, @@ -8238,7 +8238,7 @@ "id": "InputConfig", "properties": { "content": { - "description": "File content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateFiles requests. It does\nnot work for AsyncBatchAnnotateFiles requests.", + "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "format": "byte", "type": "string" }, @@ -8247,7 +8247,7 @@ "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { - "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and\n\"image/gif\" are supported. Wildcards are not supported.", + "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } }, @@ -8258,11 +8258,11 @@ "id": "KeyValue", "properties": { "key": { - "description": "The key of the label attached to the product. Cannot be empty and cannot\nexceed 128 bytes.", + "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { - "description": "The value of the label attached to the product. Cannot be empty and\ncannot exceed 128 bytes.", + "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, @@ -8358,7 +8358,7 @@ "type": "object" }, "LatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\nWGS84\nstandard. Values must be within normalized ranges.", + "description": "An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", "id": "LatLng", "properties": { "latitude": { @@ -8412,7 +8412,7 @@ "id": "ListProductSetsResponse", "properties": { "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "productSets": { @@ -8430,7 +8430,7 @@ "id": "ListProductsInProductSetResponse", "properties": { "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "products": { @@ -8448,7 +8448,7 @@ "id": "ListProductsResponse", "properties": { "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "products": { @@ -8493,7 +8493,7 @@ "description": "Image region to which this object belongs. This must be populated." }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -8524,7 +8524,7 @@ "type": "object" }, "NormalizedVertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the normalized vertex coordinates are relative to the original image\nand range from 0 to 1.", + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "NormalizedVertex", "properties": { "x": { @@ -8545,7 +8545,7 @@ "id": "ObjectAnnotation", "properties": { "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -8565,11 +8565,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": { @@ -8581,11 +8581,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": { @@ -8593,7 +8593,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" } }, @@ -8639,7 +8639,7 @@ "id": "OutputConfig", "properties": { "batchSize": { - "description": "The max number of response protos to put into each output JSON file on\nGoogle Cloud Storage.\nThe valid range is [1, 100]. If not specified, the default value is 20.\n\nFor example, for one pdf file with 100 pages, 100 response protos will\nbe generated. If `batch_size` = 20, then 5 json files each\ncontaining 20 response protos will be written under the prefix\n`gcs_destination`.`uri`.\n\nCurrently, batch_size only applies to GcsDestination, with potential future\nsupport for other output configurations.", + "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, @@ -8667,7 +8667,7 @@ "type": "number" }, "height": { - "description": "Page height. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, @@ -8676,7 +8676,7 @@ "description": "Additional information detected on the page." }, "width": { - "description": "Page width. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" } @@ -8689,7 +8689,7 @@ "properties": { "boundingBox": { "$ref": "BoundingPoly", - "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", @@ -8711,7 +8711,7 @@ "type": "object" }, "Position": { - "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", + "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "Position", "properties": { "x": { @@ -8737,23 +8737,23 @@ "id": "Product", "properties": { "description": { - "description": "User-provided metadata to be stored with this product. Must be at most 4096\ncharacters long.", + "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "displayName": { - "description": "The user-provided name for this Product. Must not be empty. Must be at most\n4096 characters long.", + "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { - "description": "The resource name of the product.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.\n\nThis field is ignored when creating a product.", + "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "productCategory": { - "description": "Immutable. The category for the product identified by the reference image. This should\nbe either \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\". The legacy categories\n\"homegoods\", \"apparel\", and \"toys\" are still supported, but these should\nnot be used for new products.", + "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { - "description": "Key-value pairs that can be attached to a product. At query time,\nconstraints can be specified based on the product_labels.\n\nNote that integer values can be provided as strings, e.g. \"1199\". Only\nstrings with integer values can match a range-based restriction which is\nto be supported soon.\n\nMultiple values can be assigned to the same key. One product may have up to\n500 product_labels.\n\nNotice that the total number of distinct product_labels over all products\nin one ProductSet cannot exceed 1M, otherwise the product search pipeline\nwill refuse to work for that ProductSet.", + "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.", "items": { "$ref": "KeyValue" }, @@ -8768,21 +8768,21 @@ "properties": { "boundingPoly": { "$ref": "BoundingPoly", - "description": "The bounding polygon around the area of interest in the image.\nIf it is not specified, system discretion will be applied." + "description": "The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied." }, "filter": { - "description": "The filtering expression. This can be used to restrict search results based\non Product labels. We currently support an AND of OR of key-value\nexpressions, where each expression within an OR must have the same key. An\n'=' should be used to connect the key and value.\n\nFor example, \"(color = red OR color = blue) AND brand = Google\" is\nacceptable, but \"(color = red OR brand = Google)\" is not acceptable.\n\"color: red\" is not acceptable because it uses a ':' instead of an '='.", + "description": "The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, \"(color = red OR color = blue) AND brand = Google\" is acceptable, but \"(color = red OR brand = Google)\" is not acceptable. \"color: red\" is not acceptable because it uses a ':' instead of an '='.", "type": "string" }, "productCategories": { - "description": "The list of product categories to search in. Currently, we only consider\nthe first category, and either \"homegoods-v2\", \"apparel-v2\", \"toys-v2\",\n\"packagedgoods-v1\", or \"general-v1\" should be specified. The legacy\ncategories \"homegoods\", \"apparel\", and \"toys\" are still supported but will\nbe deprecated. For new products, please use \"homegoods-v2\", \"apparel-v2\",\nor \"toys-v2\" for better product search accuracy. It is recommended to\nmigrate existing products to these categories as well.", + "description": "The list of product categories to search in. Currently, we only consider the first category, and either \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\", or \"general-v1\" should be specified. The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported but will be deprecated. For new products, please use \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\" for better product search accuracy. It is recommended to migrate existing products to these categories as well.", "items": { "type": "string" }, "type": "array" }, "productSet": { - "description": "The resource name of a ProductSet to be searched for similar images.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.", + "description": "The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.", "type": "string" } }, @@ -8793,12 +8793,12 @@ "id": "ProductSearchResults", "properties": { "indexTime": { - "description": "Timestamp of the index which provided these results. Products added to the\nproduct set and products removed from the product set after this time are\nnot reflected in the current results.", + "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime", "type": "string" }, "productGroupedResults": { - "description": "List of results grouped by products detected in the query image. Each entry\ncorresponds to one bounding polygon in the query image, and contains the\nmatching products specific to that region. There may be duplicate product\nmatches in the union of all the per-product results.", + "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "items": { "$ref": "GroupedResult" }, @@ -8815,24 +8815,26 @@ "type": "object" }, "ProductSet": { - "description": "A ProductSet contains Products. A ProductSet can contain a maximum of 1\nmillion reference images. If the limit is exceeded, periodic indexing will\nfail.", + "description": "A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail.", "id": "ProductSet", "properties": { "displayName": { - "description": "The user-provided name for this ProductSet. Must not be empty. Must be at\nmost 4096 characters long.", + "description": "The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "indexError": { "$ref": "Status", - "description": "Output only. If there was an error with indexing the product set, the field\nis populated.\n\nThis field is ignored when creating a ProductSet." + "description": "Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.", + "readOnly": true }, "indexTime": { - "description": "Output only. The time at which this ProductSet was last indexed. Query\nresults will reflect all updates before this time. If this ProductSet has\nnever been indexed, this timestamp is the default value\n\"1970-01-01T00:00:00Z\".\n\nThis field is ignored when creating a ProductSet.", + "description": "Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value \"1970-01-01T00:00:00Z\". This field is ignored when creating a ProductSet.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "name": { - "description": "The resource name of the ProductSet.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.\n\nThis field is ignored when creating a ProductSet.", + "description": "The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet.", "type": "string" } }, @@ -8843,7 +8845,7 @@ "id": "ProductSetPurgeConfig", "properties": { "productSetId": { - "description": "The ProductSet that contains the Products to delete. If a Product is a\nmember of product_set_id in addition to other ProductSets, the Product will\nstill be deleted.", + "description": "The ProductSet that contains the Products to delete. If a Product is a member of product_set_id in addition to other ProductSets, the Product will still be deleted.", "type": "string" } }, @@ -8874,11 +8876,11 @@ "id": "PurgeProductsRequest", "properties": { "deleteOrphanProducts": { - "description": "If delete_orphan_products is true, all Products that are not in any\nProductSet will be deleted.", + "description": "If delete_orphan_products is true, all Products that are not in any ProductSet will be deleted.", "type": "boolean" }, "force": { - "description": "The default value is false. Override this value to true to actually perform\nthe purge.", + "description": "The default value is false. Override this value to true to actually perform the purge.", "type": "boolean" }, "productSetPurgeConfig": { @@ -8889,22 +8891,22 @@ "type": "object" }, "ReferenceImage": { - "description": "A `ReferenceImage` represents a product image and its associated metadata,\nsuch as bounding boxes.", + "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.", "id": "ReferenceImage", "properties": { "boundingPolys": { - "description": "Optional. Bounding polygons around the areas of interest in the reference image.\nIf this field is empty, the system will try to detect regions of\ninterest. At most 10 bounding polygons will be used.\n\nThe provided shape is converted into a non-rotated rectangle. Once\nconverted, the small edge of the rectangle must be greater than or equal\nto 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5\nis not).", + "description": "Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).", "items": { "$ref": "BoundingPoly" }, "type": "array" }, "name": { - "description": "The resource name of the reference image.\n\nFormat is:\n\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.\n\nThis field is ignored when creating a reference image.", + "description": "The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.", "type": "string" }, "uri": { - "description": "Required. The Google Cloud Storage URI of the reference image.\n\nThe URI must start with `gs://`.", + "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`.", "type": "string" } }, @@ -8915,7 +8917,7 @@ "id": "RemoveProductFromProductSetRequest", "properties": { "product": { - "description": "Required. The resource name for the Product to be removed from this ProductSet.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`", + "description": "Required. The resource name for the Product to be removed from this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`", "type": "string" } }, @@ -8926,7 +8928,7 @@ "id": "Result", "properties": { "image": { - "description": "The resource name of the image from the product that is the closest match\nto the query.", + "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { @@ -8934,7 +8936,7 @@ "description": "The Product." }, "score": { - "description": "A confidence level on the match, ranging from 0 (no confidence) to\n1 (full confidence).", + "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" } @@ -8942,11 +8944,11 @@ "type": "object" }, "SafeSearchAnnotation": { - "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", + "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "SafeSearchAnnotation", "properties": { "adult": { - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -8986,7 +8988,7 @@ "type": "string" }, "racy": { - "description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.", + "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -9006,7 +9008,7 @@ "type": "string" }, "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -9049,7 +9051,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": { @@ -9058,7 +9060,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.", @@ -9069,7 +9071,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" } }, @@ -9081,7 +9083,7 @@ "properties": { "boundingBox": { "$ref": "BoundingPoly", - "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", @@ -9100,7 +9102,7 @@ "type": "object" }, "TextAnnotation": { - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", + "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "TextAnnotation", "properties": { "pages": { @@ -9136,7 +9138,7 @@ "type": "object" }, "Vertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "Vertex", "properties": { "x": { @@ -9157,14 +9159,14 @@ "id": "WebDetection", "properties": { "bestGuessLabels": { - "description": "The service's best guess as to the topic of the request image.\nInferred from similar images on the open web.", + "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "WebLabel" }, "type": "array" }, "fullMatchingImages": { - "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", + "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "WebImage" }, @@ -9178,7 +9180,7 @@ "type": "array" }, "partialMatchingImages": { - "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", + "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "WebImage" }, @@ -9225,7 +9227,7 @@ "type": "string" }, "score": { - "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", + "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } @@ -9257,7 +9259,7 @@ "type": "string" }, "languageCode": { - "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -9268,7 +9270,7 @@ "id": "WebPage", "properties": { "fullMatchingImages": { - "description": "Fully matching images on the page.\nCan include resized copies of the query image.", + "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "WebImage" }, @@ -9279,7 +9281,7 @@ "type": "string" }, "partialMatchingImages": { - "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", + "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "WebImage" }, @@ -9303,7 +9305,7 @@ "properties": { "boundingBox": { "$ref": "BoundingPoly", - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", @@ -9315,7 +9317,7 @@ "description": "Additional information detected for the word." }, "symbols": { - "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", + "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "Symbol" }, diff --git a/discovery/vision-v1p1beta1.json b/discovery/vision-v1p1beta1.json index ea2ed2ae55..217af2275c 100644 --- a/discovery/vision-v1p1beta1.json +++ b/discovery/vision-v1p1beta1.json @@ -111,7 +111,7 @@ "files": { "methods": { "annotate": { - "description": "Service that performs image detection and annotation for a batch of files.\nNow only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported.\n\nThis service will extract at most 5 (customers can specify which 5 in\nAnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each\nfile provided and perform detection and annotation for each image\nextracted.", + "description": "Service that performs image detection and annotation for a batch of files. Now only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.", "flatPath": "v1p1beta1/files:annotate", "httpMethod": "POST", "id": "vision.files.annotate", @@ -130,7 +130,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of generic\nfiles, such as PDF files, which may contain multiple pages and multiple\nimages per page. Progress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", + "description": "Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", "flatPath": "v1p1beta1/files:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.files.asyncBatchAnnotate", @@ -172,7 +172,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of images.\n\nProgress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results).\n\nThis service will write image annotation outputs to json files in customer\nGCS bucket, each json file containing BatchAnnotateImagesResponse proto.", + "description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.", "flatPath": "v1p1beta1/images:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.images.asyncBatchAnnotate", @@ -197,7 +197,7 @@ "files": { "methods": { "annotate": { - "description": "Service that performs image detection and annotation for a batch of files.\nNow only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported.\n\nThis service will extract at most 5 (customers can specify which 5 in\nAnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each\nfile provided and perform detection and annotation for each image\nextracted.", + "description": "Service that performs image detection and annotation for a batch of files. Now only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.", "flatPath": "v1p1beta1/projects/{projectsId}/files:annotate", "httpMethod": "POST", "id": "vision.projects.files.annotate", @@ -206,7 +206,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -226,7 +226,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of generic\nfiles, such as PDF files, which may contain multiple pages and multiple\nimages per page. Progress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", + "description": "Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", "flatPath": "v1p1beta1/projects/{projectsId}/files:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.projects.files.asyncBatchAnnotate", @@ -235,7 +235,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -268,7 +268,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -288,7 +288,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of images.\n\nProgress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results).\n\nThis service will write image annotation outputs to json files in customer\nGCS bucket, each json file containing BatchAnnotateImagesResponse proto.", + "description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.", "flatPath": "v1p1beta1/projects/{projectsId}/images:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.projects.images.asyncBatchAnnotate", @@ -297,7 +297,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -323,7 +323,7 @@ "files": { "methods": { "annotate": { - "description": "Service that performs image detection and annotation for a batch of files.\nNow only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported.\n\nThis service will extract at most 5 (customers can specify which 5 in\nAnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each\nfile provided and perform detection and annotation for each image\nextracted.", + "description": "Service that performs image detection and annotation for a batch of files. Now only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.", "flatPath": "v1p1beta1/projects/{projectsId}/locations/{locationsId}/files:annotate", "httpMethod": "POST", "id": "vision.projects.locations.files.annotate", @@ -332,7 +332,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -352,7 +352,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of generic\nfiles, such as PDF files, which may contain multiple pages and multiple\nimages per page. Progress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", + "description": "Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", "flatPath": "v1p1beta1/projects/{projectsId}/locations/{locationsId}/files:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.projects.locations.files.asyncBatchAnnotate", @@ -361,7 +361,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -394,7 +394,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -414,7 +414,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of images.\n\nProgress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results).\n\nThis service will write image annotation outputs to json files in customer\nGCS bucket, each json file containing BatchAnnotateImagesResponse proto.", + "description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.", "flatPath": "v1p1beta1/projects/{projectsId}/locations/{locationsId}/images:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.projects.locations.images.asyncBatchAnnotate", @@ -423,7 +423,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -449,23 +449,23 @@ } } }, - "revision": "20200710", + "revision": "20200801", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AnnotateFileResponse": { - "description": "Response to a single file annotation request. A file may contain one or more\nimages, which individually have their own responses.", + "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "AnnotateFileResponse", "properties": { "error": { "$ref": "Status", - "description": "If set, represents the error message for the failed request. The\n`responses` field will not be set in this case." + "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." }, "inputConfig": { "$ref": "InputConfig", "description": "Information about the file for which this response is generated." }, "responses": { - "description": "Individual responses to images found within the file. This field will be\nempty if the `error` field is set.", + "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "AnnotateImageResponse" }, @@ -485,7 +485,7 @@ "properties": { "context": { "$ref": "ImageAnnotationContext", - "description": "If present, contextual information is needed to understand where this image\ncomes from." + "description": "If present, contextual information is needed to understand where this image comes from." }, "cropHintsAnnotation": { "$ref": "CropHintsAnnotation", @@ -493,7 +493,7 @@ }, "error": { "$ref": "Status", - "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." + "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set." }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", @@ -504,7 +504,7 @@ }, "fullTextAnnotation": { "$ref": "TextAnnotation", - "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." + "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." }, "imagePropertiesAnnotation": { "$ref": "ImageProperties", @@ -525,7 +525,7 @@ "type": "array" }, "localizedObjectAnnotations": { - "description": "If present, localized object detection has completed successfully.\nThis will be sorted descending by confidence score.", + "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "LocalizedObjectAnnotation" }, @@ -576,7 +576,7 @@ "id": "AsyncBatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, one for each request in\nAsyncBatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "items": { "$ref": "AsyncAnnotateFileResponse" }, @@ -601,7 +601,7 @@ "id": "BatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, each response corresponding to each\nAnnotateFileRequest in BatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.", "items": { "$ref": "AnnotateFileResponse" }, @@ -611,11 +611,11 @@ "type": "object" }, "BatchOperationMetadata": { - "description": "Metadata for the batch operations such as the current state.\n\nThis is included in the `metadata` field of the `Operation` returned by the\n`GetOperation` call of the `google::longrunning::Operations` service.", + "description": "Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.", "id": "BatchOperationMetadata", "properties": { "endTime": { - "description": "The time when the batch request is finished and\ngoogle.longrunning.Operation.done is set to true.", + "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.", "format": "google-datetime", "type": "string" }, @@ -631,9 +631,9 @@ "enumDescriptions": [ "Invalid.", "Request is actively being processed.", - "The request is done and at least one item has been successfully\nprocessed.", + "The request is done and at least one item has been successfully processed.", "The request is done and no item has been successfully processed.", - "The request is done after the longrunning.Operations.CancelOperation has\nbeen called by the user. Any records that were processed before the\ncancel command are output as specified in the request." + "The request is done after the longrunning.Operations.CancelOperation has been called by the user. Any records that were processed before the cancel command are output as specified in the request." ], "type": "string" }, @@ -671,7 +671,7 @@ }, "boundingBox": { "$ref": "BoundingPoly", - "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", @@ -714,11 +714,11 @@ "type": "object" }, "Color": { - "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well.\n\nNote: this proto does not carry information about the absolute color space\nthat should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,\nDCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color\nspace.\n\nNote: when color equality needs to be decided, implementations, unless\ndocumented otherwise, will treat two colors to be equal if all their red,\ngreen, blue and alpha values each differ by at most 1e-5.\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [[Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha <= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red << 16) | (green << 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i < missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...", + "description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of \"java.awt.Color\" in Java; it can also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\" method in iOS; and, with just a little work, it can be easily formatted into a CSS \"rgba()\" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be equal if all their red, green, blue and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...", "id": "Color", "properties": { "alpha": { - "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).", + "description": "The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0).", "format": "float", "type": "number" }, @@ -741,7 +741,7 @@ "type": "object" }, "ColorInfo": { - "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", + "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "ColorInfo", "properties": { "color": { @@ -749,7 +749,7 @@ "description": "RGB components of the color." }, "pixelFraction": { - "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", + "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" }, @@ -767,15 +767,15 @@ "properties": { "boundingPoly": { "$ref": "BoundingPoly", - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale." + "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { - "description": "Confidence of this being a salient region. Range [0, 1].", + "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { - "description": "Fraction of importance of this salient region with respect to the original\nimage.", + "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } @@ -819,7 +819,7 @@ "Regular space.", "Sure space (very wide).", "Line-wrapping break.", - "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", + "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" @@ -837,7 +837,7 @@ "type": "number" }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -863,10 +863,10 @@ "properties": { "boundingPoly": { "$ref": "BoundingPoly", - "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." + "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "confidence": { - "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", + "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float", "type": "number" }, @@ -875,22 +875,22 @@ "type": "string" }, "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", + "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "locations": { - "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", + "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "LocationInfo" }, "type": "array" }, "mid": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", + "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "properties": { - "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", + "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "items": { "$ref": "Property" }, @@ -902,7 +902,7 @@ "type": "number" }, "topicality": { - "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", + "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float", "type": "number" } @@ -955,7 +955,7 @@ }, "boundingPoly": { "$ref": "BoundingPoly", - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." + "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", @@ -964,7 +964,7 @@ }, "fdBoundingPoly": { "$ref": "BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe fd (face detection) prefix." + "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." }, "headwearLikelihood": { "description": "Headwear likelihood.", @@ -1019,12 +1019,12 @@ "type": "array" }, "panAngle": { - "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", + "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "rollAngle": { - "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", + "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "format": "float", "type": "number" }, @@ -1069,7 +1069,7 @@ "type": "string" }, "tiltAngle": { - "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", + "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, @@ -1101,7 +1101,7 @@ "id": "GcsDestination", "properties": { "uri": { - "description": "Google Cloud Storage URI prefix where the results will be stored. Results\nwill be in JSON format and preceded by its corresponding input URI prefix.\nThis field can either represent a gcs file prefix or gcs directory. In\neither case, the uri should be unique because in order to get all of the\noutput files, you will need to do a wildcard gcs search on the uri prefix\nyou provide.\n\nExamples:\n\n* File Prefix: gs://bucket-name/here/filenameprefix The output files\nwill be created in gs://bucket-name/here/ and the names of the\noutput files will begin with \"filenameprefix\".\n\n* Directory Prefix: gs://bucket-name/some/location/ The output files\nwill be created in gs://bucket-name/some/location/ and the names of the\noutput files could be anything because there was no filename prefix\nspecified.\n\nIf multiple outputs, each response is still AnnotateFileResponse, each of\nwhich contains some subset of the full list of AnnotateImageResponse.\nMultiple outputs can happen if, for example, the output JSON is too large\nand overflows into multiple sharded files.", + "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, @@ -1112,7 +1112,7 @@ "id": "GcsSource", "properties": { "uri": { - "description": "Google Cloud Storage URI for the input file. This must only be a\nGoogle Cloud Storage object. Wildcards are not currently supported.", + "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, @@ -1138,7 +1138,7 @@ "description": "Required. Information about the input file." }, "pages": { - "description": "Pages of the file to perform image annotation.\n\nPages starts from 1, we assume the first page of the file is page 1.\nAt most 5 pages are supported per request. Pages can be negative.\n\nPage 1 means the first page.\nPage 2 means the second page.\nPage -1 means the last page.\nPage -2 means the second to the last page.\n\nIf the file is GIF instead of PDF or TIFF, page refers to GIF frames.\n\nIf this field is empty, by default the service performs image annotation\nfor the first 5 pages of the file.", + "description": "Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file.", "items": { "format": "int32", "type": "integer" @@ -1149,19 +1149,19 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1AnnotateFileResponse": { - "description": "Response to a single file annotation request. A file may contain one or more\nimages, which individually have their own responses.", + "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "GoogleCloudVisionV1p1beta1AnnotateFileResponse", "properties": { "error": { "$ref": "Status", - "description": "If set, represents the error message for the failed request. The\n`responses` field will not be set in this case." + "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." }, "inputConfig": { "$ref": "GoogleCloudVisionV1p1beta1InputConfig", "description": "Information about the file for which this response is generated." }, "responses": { - "description": "Individual responses to images found within the file. This field will be\nempty if the `error` field is set.", + "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "GoogleCloudVisionV1p1beta1AnnotateImageResponse" }, @@ -1176,7 +1176,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1AnnotateImageRequest": { - "description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features, and with context information.", + "description": "Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information.", "id": "GoogleCloudVisionV1p1beta1AnnotateImageRequest", "properties": { "features": { @@ -1203,7 +1203,7 @@ "properties": { "context": { "$ref": "GoogleCloudVisionV1p1beta1ImageAnnotationContext", - "description": "If present, contextual information is needed to understand where this image\ncomes from." + "description": "If present, contextual information is needed to understand where this image comes from." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p1beta1CropHintsAnnotation", @@ -1211,7 +1211,7 @@ }, "error": { "$ref": "Status", - "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." + "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set." }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", @@ -1222,7 +1222,7 @@ }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p1beta1TextAnnotation", - "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." + "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." }, "imagePropertiesAnnotation": { "$ref": "GoogleCloudVisionV1p1beta1ImageProperties", @@ -1243,7 +1243,7 @@ "type": "array" }, "localizedObjectAnnotations": { - "description": "If present, localized object detection has completed successfully.\nThis will be sorted descending by confidence score.", + "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation" }, @@ -1316,11 +1316,11 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest": { - "description": "Multiple async file annotation requests are batched into a single service\ncall.", + "description": "Multiple async file annotation requests are batched into a single service call.", "id": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest", "properties": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "requests": { @@ -1338,7 +1338,7 @@ "id": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, one for each request in\nAsyncBatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse" }, @@ -1356,7 +1356,7 @@ "description": "Required. The desired output location and metadata (e.g. format)." }, "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "requests": { @@ -1374,11 +1374,11 @@ "id": "GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest", "properties": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "requests": { - "description": "Required. The list of file annotation requests. Right now we support only one\nAnnotateFileRequest in BatchAnnotateFilesRequest.", + "description": "Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p1beta1AnnotateFileRequest" }, @@ -1392,7 +1392,7 @@ "id": "GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, each response corresponding to each\nAnnotateFileRequest in BatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p1beta1AnnotateFileResponse" }, @@ -1406,7 +1406,7 @@ "id": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest", "properties": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "requests": { @@ -1459,7 +1459,7 @@ }, "boundingBox": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", @@ -1502,7 +1502,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1ColorInfo": { - "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", + "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "GoogleCloudVisionV1p1beta1ColorInfo", "properties": { "color": { @@ -1510,7 +1510,7 @@ "description": "RGB components of the color." }, "pixelFraction": { - "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", + "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" }, @@ -1528,15 +1528,15 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale." + "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { - "description": "Confidence of this being a salient region. Range [0, 1].", + "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { - "description": "Fraction of importance of this salient region with respect to the original\nimage.", + "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } @@ -1562,7 +1562,7 @@ "id": "GoogleCloudVisionV1p1beta1CropHintsParams", "properties": { "aspectRatios": { - "description": "Aspect ratios in floats, representing the ratio of the width to the height\nof the image. For example, if the desired aspect ratio is 4/3, the\ncorresponding float value should be 1.33333. If not specified, the\nbest possible crop is returned. The number of provided aspect ratios is\nlimited to a maximum of 16; any aspect ratios provided after the 16th are\nignored.", + "description": "Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored.", "items": { "format": "float", "type": "number" @@ -1592,10 +1592,10 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." + "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "confidence": { - "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", + "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float", "type": "number" }, @@ -1604,22 +1604,22 @@ "type": "string" }, "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", + "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "locations": { - "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", + "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "GoogleCloudVisionV1p1beta1LocationInfo" }, "type": "array" }, "mid": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", + "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "properties": { - "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", + "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "items": { "$ref": "GoogleCloudVisionV1p1beta1Property" }, @@ -1631,7 +1631,7 @@ "type": "number" }, "topicality": { - "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", + "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float", "type": "number" } @@ -1684,7 +1684,7 @@ }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." + "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", @@ -1693,7 +1693,7 @@ }, "fdBoundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe fd (face detection) prefix." + "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." }, "headwearLikelihood": { "description": "Headwear likelihood.", @@ -1748,12 +1748,12 @@ "type": "array" }, "panAngle": { - "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", + "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "rollAngle": { - "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", + "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "format": "float", "type": "number" }, @@ -1798,7 +1798,7 @@ "type": "string" }, "tiltAngle": { - "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", + "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, @@ -1915,16 +1915,16 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1Feature": { - "description": "The type of Google Cloud Vision API detection to perform, and the maximum\nnumber of results to return for that type. Multiple `Feature` objects can\nbe specified in the `features` list.", + "description": "The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list.", "id": "GoogleCloudVisionV1p1beta1Feature", "properties": { "maxResults": { - "description": "Maximum number of results of this type. Does not apply to\n`TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.", + "description": "Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.", "format": "int32", "type": "integer" }, "model": { - "description": "Model to use for the feature.\nSupported values: \"builtin/stable\" (the default if unset) and\n\"builtin/latest\".", + "description": "Model to use for the feature. Supported values: \"builtin/stable\" (the default if unset) and \"builtin/latest\".", "type": "string" }, "type": { @@ -1950,10 +1950,10 @@ "Run landmark detection.", "Run logo detection.", "Run label detection.", - "Run text detection / optical character recognition (OCR). Text detection\nis optimized for areas of text within a larger image; if the image is\na document, use `DOCUMENT_TEXT_DETECTION` instead.", - "Run dense text document OCR. Takes precedence when both\n`DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present.", - "Run Safe Search to detect potentially unsafe\nor undesirable content.", - "Compute a set of image properties, such as the\nimage's dominant colors.", + "Run text detection / optical character recognition (OCR). Text detection is optimized for areas of text within a larger image; if the image is a document, use `DOCUMENT_TEXT_DETECTION` instead.", + "Run dense text document OCR. Takes precedence when both `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present.", + "Run Safe Search to detect potentially unsafe or undesirable content.", + "Compute a set of image properties, such as the image's dominant colors.", "Run crop hints.", "Run web detection.", "Run Product Search.", @@ -1969,7 +1969,7 @@ "id": "GoogleCloudVisionV1p1beta1GcsDestination", "properties": { "uri": { - "description": "Google Cloud Storage URI prefix where the results will be stored. Results\nwill be in JSON format and preceded by its corresponding input URI prefix.\nThis field can either represent a gcs file prefix or gcs directory. In\neither case, the uri should be unique because in order to get all of the\noutput files, you will need to do a wildcard gcs search on the uri prefix\nyou provide.\n\nExamples:\n\n* File Prefix: gs://bucket-name/here/filenameprefix The output files\nwill be created in gs://bucket-name/here/ and the names of the\noutput files will begin with \"filenameprefix\".\n\n* Directory Prefix: gs://bucket-name/some/location/ The output files\nwill be created in gs://bucket-name/some/location/ and the names of the\noutput files could be anything because there was no filename prefix\nspecified.\n\nIf multiple outputs, each response is still AnnotateFileResponse, each of\nwhich contains some subset of the full list of AnnotateImageResponse.\nMultiple outputs can happen if, for example, the output JSON is too large\nand overflows into multiple sharded files.", + "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, @@ -1980,7 +1980,7 @@ "id": "GoogleCloudVisionV1p1beta1GcsSource", "properties": { "uri": { - "description": "Google Cloud Storage URI for the input file. This must only be a\nGoogle Cloud Storage object. Wildcards are not currently supported.", + "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, @@ -1991,23 +1991,23 @@ "id": "GoogleCloudVisionV1p1beta1Image", "properties": { "content": { - "description": "Image content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateImages requests. It does\nnot work for AsyncBatchAnnotateImages requests.", + "description": "Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateImages requests. It does not work for AsyncBatchAnnotateImages requests.", "format": "byte", "type": "string" }, "source": { "$ref": "GoogleCloudVisionV1p1beta1ImageSource", - "description": "Google Cloud Storage image location, or publicly-accessible image\nURL. If both `content` and `source` are provided for an image, `content`\ntakes precedence and is used to perform the image annotation request." + "description": "Google Cloud Storage image location, or publicly-accessible image URL. If both `content` and `source` are provided for an image, `content` takes precedence and is used to perform the image annotation request." } }, "type": "object" }, "GoogleCloudVisionV1p1beta1ImageAnnotationContext": { - "description": "If an image was produced from a file (e.g. a PDF), this message gives\ninformation about the source of that image.", + "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "GoogleCloudVisionV1p1beta1ImageAnnotationContext", "properties": { "pageNumber": { - "description": "If the file was a PDF or TIFF, this field gives the page number within\nthe file used to produce the image.", + "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" }, @@ -2027,7 +2027,7 @@ "description": "Parameters for crop hints annotation request." }, "languageHints": { - "description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value\nyields the best results since it enables automatic language detection. For\nlanguages based on the Latin alphabet, setting `language_hints` is not\nneeded. In rare cases, when the language of the text in the image is known,\nsetting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong). Text detection returns an\nerror if one or more of the specified languages is not one of the\n[supported languages](https://cloud.google.com/vision/docs/languages).", + "description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](https://cloud.google.com/vision/docs/languages).", "items": { "type": "string" }, @@ -2064,11 +2064,11 @@ "id": "GoogleCloudVisionV1p1beta1ImageSource", "properties": { "gcsImageUri": { - "description": "**Use `image_uri` instead.**\n\nThe Google Cloud Storage URI of the form\n`gs://bucket_name/object_name`. Object versioning is not supported. See\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris) for more info.", + "description": "**Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.", "type": "string" }, "imageUri": { - "description": "The URI of the source image. Can be either:\n\n1. A Google Cloud Storage URI of the form\n `gs://bucket_name/object_name`. Object versioning is not supported. See\n [Google Cloud Storage Request\n URIs](https://cloud.google.com/storage/docs/reference-uris) for more\n info.\n\n2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from\n HTTP/HTTPS URLs, Google cannot guarantee that the request will be\n completed. Your request may fail if the specified host denies the\n request (e.g. due to request throttling or DOS prevention), or if Google\n throttles requests to the site for abuse prevention. You should not\n depend on externally-hosted images for production applications.\n\nWhen both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes\nprecedence.", + "description": "The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence.", "type": "string" } }, @@ -2079,7 +2079,7 @@ "id": "GoogleCloudVisionV1p1beta1InputConfig", "properties": { "content": { - "description": "File content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateFiles requests. It does\nnot work for AsyncBatchAnnotateFiles requests.", + "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "format": "byte", "type": "string" }, @@ -2088,7 +2088,7 @@ "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { - "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and\n\"image/gif\" are supported. Wildcards are not supported.", + "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } }, @@ -2118,7 +2118,7 @@ "description": "Image region to which this object belongs. This must be populated." }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -2149,7 +2149,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1NormalizedVertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the normalized vertex coordinates are relative to the original image\nand range from 0 to 1.", + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudVisionV1p1beta1NormalizedVertex", "properties": { "x": { @@ -2205,7 +2205,7 @@ "id": "GoogleCloudVisionV1p1beta1OutputConfig", "properties": { "batchSize": { - "description": "The max number of response protos to put into each output JSON file on\nGoogle Cloud Storage.\nThe valid range is [1, 100]. If not specified, the default value is 20.\n\nFor example, for one pdf file with 100 pages, 100 response protos will\nbe generated. If `batch_size` = 20, then 5 json files each\ncontaining 20 response protos will be written under the prefix\n`gcs_destination`.`uri`.\n\nCurrently, batch_size only applies to GcsDestination, with potential future\nsupport for other output configurations.", + "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, @@ -2233,7 +2233,7 @@ "type": "number" }, "height": { - "description": "Page height. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, @@ -2242,7 +2242,7 @@ "description": "Additional information detected on the page." }, "width": { - "description": "Page width. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" } @@ -2255,7 +2255,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", @@ -2277,7 +2277,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1Position": { - "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", + "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p1beta1Position", "properties": { "x": { @@ -2303,23 +2303,23 @@ "id": "GoogleCloudVisionV1p1beta1Product", "properties": { "description": { - "description": "User-provided metadata to be stored with this product. Must be at most 4096\ncharacters long.", + "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "displayName": { - "description": "The user-provided name for this Product. Must not be empty. Must be at most\n4096 characters long.", + "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { - "description": "The resource name of the product.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.\n\nThis field is ignored when creating a product.", + "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "productCategory": { - "description": "Immutable. The category for the product identified by the reference image. This should\nbe either \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\". The legacy categories\n\"homegoods\", \"apparel\", and \"toys\" are still supported, but these should\nnot be used for new products.", + "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { - "description": "Key-value pairs that can be attached to a product. At query time,\nconstraints can be specified based on the product_labels.\n\nNote that integer values can be provided as strings, e.g. \"1199\". Only\nstrings with integer values can match a range-based restriction which is\nto be supported soon.\n\nMultiple values can be assigned to the same key. One product may have up to\n500 product_labels.\n\nNotice that the total number of distinct product_labels over all products\nin one ProductSet cannot exceed 1M, otherwise the product search pipeline\nwill refuse to work for that ProductSet.", + "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.", "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductKeyValue" }, @@ -2333,11 +2333,11 @@ "id": "GoogleCloudVisionV1p1beta1ProductKeyValue", "properties": { "key": { - "description": "The key of the label attached to the product. Cannot be empty and cannot\nexceed 128 bytes.", + "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { - "description": "The value of the label attached to the product. Cannot be empty and\ncannot exceed 128 bytes.", + "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, @@ -2349,21 +2349,21 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding polygon around the area of interest in the image.\nIf it is not specified, system discretion will be applied." + "description": "The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied." }, "filter": { - "description": "The filtering expression. This can be used to restrict search results based\non Product labels. We currently support an AND of OR of key-value\nexpressions, where each expression within an OR must have the same key. An\n'=' should be used to connect the key and value.\n\nFor example, \"(color = red OR color = blue) AND brand = Google\" is\nacceptable, but \"(color = red OR brand = Google)\" is not acceptable.\n\"color: red\" is not acceptable because it uses a ':' instead of an '='.", + "description": "The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, \"(color = red OR color = blue) AND brand = Google\" is acceptable, but \"(color = red OR brand = Google)\" is not acceptable. \"color: red\" is not acceptable because it uses a ':' instead of an '='.", "type": "string" }, "productCategories": { - "description": "The list of product categories to search in. Currently, we only consider\nthe first category, and either \"homegoods-v2\", \"apparel-v2\", \"toys-v2\",\n\"packagedgoods-v1\", or \"general-v1\" should be specified. The legacy\ncategories \"homegoods\", \"apparel\", and \"toys\" are still supported but will\nbe deprecated. For new products, please use \"homegoods-v2\", \"apparel-v2\",\nor \"toys-v2\" for better product search accuracy. It is recommended to\nmigrate existing products to these categories as well.", + "description": "The list of product categories to search in. Currently, we only consider the first category, and either \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\", or \"general-v1\" should be specified. The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported but will be deprecated. For new products, please use \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\" for better product search accuracy. It is recommended to migrate existing products to these categories as well.", "items": { "type": "string" }, "type": "array" }, "productSet": { - "description": "The resource name of a ProductSet to be searched for similar images.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.", + "description": "The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.", "type": "string" } }, @@ -2374,12 +2374,12 @@ "id": "GoogleCloudVisionV1p1beta1ProductSearchResults", "properties": { "indexTime": { - "description": "Timestamp of the index which provided these results. Products added to the\nproduct set and products removed from the product set after this time are\nnot reflected in the current results.", + "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime", "type": "string" }, "productGroupedResults": { - "description": "List of results grouped by products detected in the query image. Each entry\ncorresponds to one bounding polygon in the query image, and contains the\nmatching products specific to that region. There may be duplicate product\nmatches in the union of all the per-product results.", + "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult" }, @@ -2396,7 +2396,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult": { - "description": "Information about the products similar to a single product in a query\nimage.", + "description": "Information about the products similar to a single product in a query image.", "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult", "properties": { "boundingPoly": { @@ -2425,7 +2425,7 @@ "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation", "properties": { "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -2449,7 +2449,7 @@ "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult", "properties": { "image": { - "description": "The resource name of the image from the product that is the closest match\nto the query.", + "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { @@ -2457,7 +2457,7 @@ "description": "The Product." }, "score": { - "description": "A confidence level on the match, ranging from 0 (no confidence) to\n1 (full confidence).", + "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" } @@ -2485,11 +2485,11 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1SafeSearchAnnotation": { - "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", + "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation", "properties": { "adult": { - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -2529,7 +2529,7 @@ "type": "string" }, "racy": { - "description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.", + "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -2549,7 +2549,7 @@ "type": "string" }, "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -2597,7 +2597,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", @@ -2616,7 +2616,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1TextAnnotation": { - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", + "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "GoogleCloudVisionV1p1beta1TextAnnotation", "properties": { "pages": { @@ -2656,7 +2656,7 @@ "Regular space.", "Sure space (very wide).", "Line-wrapping break.", - "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", + "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" @@ -2674,7 +2674,7 @@ "type": "number" }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -2699,7 +2699,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1Vertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p1beta1Vertex", "properties": { "x": { @@ -2720,14 +2720,14 @@ "id": "GoogleCloudVisionV1p1beta1WebDetection", "properties": { "bestGuessLabels": { - "description": "The service's best guess as to the topic of the request image.\nInferred from similar images on the open web.", + "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel" }, "type": "array" }, "fullMatchingImages": { - "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", + "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, @@ -2741,7 +2741,7 @@ "type": "array" }, "partialMatchingImages": { - "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", + "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, @@ -2788,7 +2788,7 @@ "type": "string" }, "score": { - "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", + "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } @@ -2820,7 +2820,7 @@ "type": "string" }, "languageCode": { - "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -2831,7 +2831,7 @@ "id": "GoogleCloudVisionV1p1beta1WebDetectionWebPage", "properties": { "fullMatchingImages": { - "description": "Fully matching images on the page.\nCan include resized copies of the query image.", + "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, @@ -2842,7 +2842,7 @@ "type": "string" }, "partialMatchingImages": { - "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", + "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, @@ -2866,7 +2866,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", @@ -2878,7 +2878,7 @@ "description": "Additional information detected for the word." }, "symbols": { - "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", + "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "GoogleCloudVisionV1p1beta1Symbol" }, @@ -2888,19 +2888,19 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1AnnotateFileResponse": { - "description": "Response to a single file annotation request. A file may contain one or more\nimages, which individually have their own responses.", + "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "GoogleCloudVisionV1p2beta1AnnotateFileResponse", "properties": { "error": { "$ref": "Status", - "description": "If set, represents the error message for the failed request. The\n`responses` field will not be set in this case." + "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." }, "inputConfig": { "$ref": "GoogleCloudVisionV1p2beta1InputConfig", "description": "Information about the file for which this response is generated." }, "responses": { - "description": "Individual responses to images found within the file. This field will be\nempty if the `error` field is set.", + "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "GoogleCloudVisionV1p2beta1AnnotateImageResponse" }, @@ -2920,7 +2920,7 @@ "properties": { "context": { "$ref": "GoogleCloudVisionV1p2beta1ImageAnnotationContext", - "description": "If present, contextual information is needed to understand where this image\ncomes from." + "description": "If present, contextual information is needed to understand where this image comes from." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p2beta1CropHintsAnnotation", @@ -2928,7 +2928,7 @@ }, "error": { "$ref": "Status", - "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." + "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set." }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", @@ -2939,7 +2939,7 @@ }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p2beta1TextAnnotation", - "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." + "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." }, "imagePropertiesAnnotation": { "$ref": "GoogleCloudVisionV1p2beta1ImageProperties", @@ -2960,7 +2960,7 @@ "type": "array" }, "localizedObjectAnnotations": { - "description": "If present, localized object detection has completed successfully.\nThis will be sorted descending by confidence score.", + "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation" }, @@ -3011,7 +3011,7 @@ "id": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, one for each request in\nAsyncBatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse" }, @@ -3046,7 +3046,7 @@ }, "boundingBox": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", @@ -3089,7 +3089,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1ColorInfo": { - "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", + "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "GoogleCloudVisionV1p2beta1ColorInfo", "properties": { "color": { @@ -3097,7 +3097,7 @@ "description": "RGB components of the color." }, "pixelFraction": { - "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", + "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" }, @@ -3115,15 +3115,15 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale." + "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { - "description": "Confidence of this being a salient region. Range [0, 1].", + "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { - "description": "Fraction of importance of this salient region with respect to the original\nimage.", + "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } @@ -3164,10 +3164,10 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." + "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "confidence": { - "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", + "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float", "type": "number" }, @@ -3176,22 +3176,22 @@ "type": "string" }, "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", + "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "locations": { - "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", + "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "GoogleCloudVisionV1p2beta1LocationInfo" }, "type": "array" }, "mid": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", + "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "properties": { - "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", + "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "items": { "$ref": "GoogleCloudVisionV1p2beta1Property" }, @@ -3203,7 +3203,7 @@ "type": "number" }, "topicality": { - "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", + "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float", "type": "number" } @@ -3256,7 +3256,7 @@ }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." + "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", @@ -3265,7 +3265,7 @@ }, "fdBoundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe fd (face detection) prefix." + "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." }, "headwearLikelihood": { "description": "Headwear likelihood.", @@ -3320,12 +3320,12 @@ "type": "array" }, "panAngle": { - "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", + "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "rollAngle": { - "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", + "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "format": "float", "type": "number" }, @@ -3370,7 +3370,7 @@ "type": "string" }, "tiltAngle": { - "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", + "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, @@ -3491,7 +3491,7 @@ "id": "GoogleCloudVisionV1p2beta1GcsDestination", "properties": { "uri": { - "description": "Google Cloud Storage URI prefix where the results will be stored. Results\nwill be in JSON format and preceded by its corresponding input URI prefix.\nThis field can either represent a gcs file prefix or gcs directory. In\neither case, the uri should be unique because in order to get all of the\noutput files, you will need to do a wildcard gcs search on the uri prefix\nyou provide.\n\nExamples:\n\n* File Prefix: gs://bucket-name/here/filenameprefix The output files\nwill be created in gs://bucket-name/here/ and the names of the\noutput files will begin with \"filenameprefix\".\n\n* Directory Prefix: gs://bucket-name/some/location/ The output files\nwill be created in gs://bucket-name/some/location/ and the names of the\noutput files could be anything because there was no filename prefix\nspecified.\n\nIf multiple outputs, each response is still AnnotateFileResponse, each of\nwhich contains some subset of the full list of AnnotateImageResponse.\nMultiple outputs can happen if, for example, the output JSON is too large\nand overflows into multiple sharded files.", + "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, @@ -3502,18 +3502,18 @@ "id": "GoogleCloudVisionV1p2beta1GcsSource", "properties": { "uri": { - "description": "Google Cloud Storage URI for the input file. This must only be a\nGoogle Cloud Storage object. Wildcards are not currently supported.", + "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1ImageAnnotationContext": { - "description": "If an image was produced from a file (e.g. a PDF), this message gives\ninformation about the source of that image.", + "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "GoogleCloudVisionV1p2beta1ImageAnnotationContext", "properties": { "pageNumber": { - "description": "If the file was a PDF or TIFF, this field gives the page number within\nthe file used to produce the image.", + "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" }, @@ -3540,7 +3540,7 @@ "id": "GoogleCloudVisionV1p2beta1InputConfig", "properties": { "content": { - "description": "File content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateFiles requests. It does\nnot work for AsyncBatchAnnotateFiles requests.", + "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "format": "byte", "type": "string" }, @@ -3549,7 +3549,7 @@ "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { - "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and\n\"image/gif\" are supported. Wildcards are not supported.", + "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } }, @@ -3564,7 +3564,7 @@ "description": "Image region to which this object belongs. This must be populated." }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -3595,7 +3595,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1NormalizedVertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the normalized vertex coordinates are relative to the original image\nand range from 0 to 1.", + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudVisionV1p2beta1NormalizedVertex", "properties": { "x": { @@ -3651,7 +3651,7 @@ "id": "GoogleCloudVisionV1p2beta1OutputConfig", "properties": { "batchSize": { - "description": "The max number of response protos to put into each output JSON file on\nGoogle Cloud Storage.\nThe valid range is [1, 100]. If not specified, the default value is 20.\n\nFor example, for one pdf file with 100 pages, 100 response protos will\nbe generated. If `batch_size` = 20, then 5 json files each\ncontaining 20 response protos will be written under the prefix\n`gcs_destination`.`uri`.\n\nCurrently, batch_size only applies to GcsDestination, with potential future\nsupport for other output configurations.", + "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, @@ -3679,7 +3679,7 @@ "type": "number" }, "height": { - "description": "Page height. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, @@ -3688,7 +3688,7 @@ "description": "Additional information detected on the page." }, "width": { - "description": "Page width. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" } @@ -3701,7 +3701,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", @@ -3723,7 +3723,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1Position": { - "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", + "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p2beta1Position", "properties": { "x": { @@ -3749,23 +3749,23 @@ "id": "GoogleCloudVisionV1p2beta1Product", "properties": { "description": { - "description": "User-provided metadata to be stored with this product. Must be at most 4096\ncharacters long.", + "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "displayName": { - "description": "The user-provided name for this Product. Must not be empty. Must be at most\n4096 characters long.", + "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { - "description": "The resource name of the product.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.\n\nThis field is ignored when creating a product.", + "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "productCategory": { - "description": "Immutable. The category for the product identified by the reference image. This should\nbe either \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\". The legacy categories\n\"homegoods\", \"apparel\", and \"toys\" are still supported, but these should\nnot be used for new products.", + "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { - "description": "Key-value pairs that can be attached to a product. At query time,\nconstraints can be specified based on the product_labels.\n\nNote that integer values can be provided as strings, e.g. \"1199\". Only\nstrings with integer values can match a range-based restriction which is\nto be supported soon.\n\nMultiple values can be assigned to the same key. One product may have up to\n500 product_labels.\n\nNotice that the total number of distinct product_labels over all products\nin one ProductSet cannot exceed 1M, otherwise the product search pipeline\nwill refuse to work for that ProductSet.", + "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.", "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductKeyValue" }, @@ -3779,11 +3779,11 @@ "id": "GoogleCloudVisionV1p2beta1ProductKeyValue", "properties": { "key": { - "description": "The key of the label attached to the product. Cannot be empty and cannot\nexceed 128 bytes.", + "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { - "description": "The value of the label attached to the product. Cannot be empty and\ncannot exceed 128 bytes.", + "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, @@ -3794,12 +3794,12 @@ "id": "GoogleCloudVisionV1p2beta1ProductSearchResults", "properties": { "indexTime": { - "description": "Timestamp of the index which provided these results. Products added to the\nproduct set and products removed from the product set after this time are\nnot reflected in the current results.", + "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime", "type": "string" }, "productGroupedResults": { - "description": "List of results grouped by products detected in the query image. Each entry\ncorresponds to one bounding polygon in the query image, and contains the\nmatching products specific to that region. There may be duplicate product\nmatches in the union of all the per-product results.", + "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult" }, @@ -3816,7 +3816,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult": { - "description": "Information about the products similar to a single product in a query\nimage.", + "description": "Information about the products similar to a single product in a query image.", "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult", "properties": { "boundingPoly": { @@ -3845,7 +3845,7 @@ "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation", "properties": { "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -3869,7 +3869,7 @@ "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsResult", "properties": { "image": { - "description": "The resource name of the image from the product that is the closest match\nto the query.", + "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { @@ -3877,7 +3877,7 @@ "description": "The Product." }, "score": { - "description": "A confidence level on the match, ranging from 0 (no confidence) to\n1 (full confidence).", + "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" } @@ -3905,11 +3905,11 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1SafeSearchAnnotation": { - "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", + "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "GoogleCloudVisionV1p2beta1SafeSearchAnnotation", "properties": { "adult": { - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -3949,7 +3949,7 @@ "type": "string" }, "racy": { - "description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.", + "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -3969,7 +3969,7 @@ "type": "string" }, "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -4017,7 +4017,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", @@ -4036,7 +4036,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1TextAnnotation": { - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", + "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "GoogleCloudVisionV1p2beta1TextAnnotation", "properties": { "pages": { @@ -4076,7 +4076,7 @@ "Regular space.", "Sure space (very wide).", "Line-wrapping break.", - "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", + "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" @@ -4094,7 +4094,7 @@ "type": "number" }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -4119,7 +4119,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1Vertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p2beta1Vertex", "properties": { "x": { @@ -4140,14 +4140,14 @@ "id": "GoogleCloudVisionV1p2beta1WebDetection", "properties": { "bestGuessLabels": { - "description": "The service's best guess as to the topic of the request image.\nInferred from similar images on the open web.", + "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebLabel" }, "type": "array" }, "fullMatchingImages": { - "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", + "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, @@ -4161,7 +4161,7 @@ "type": "array" }, "partialMatchingImages": { - "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", + "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, @@ -4197,7 +4197,7 @@ "type": "string" }, "score": { - "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", + "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } @@ -4229,7 +4229,7 @@ "type": "string" }, "languageCode": { - "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -4240,7 +4240,7 @@ "id": "GoogleCloudVisionV1p2beta1WebDetectionWebPage", "properties": { "fullMatchingImages": { - "description": "Fully matching images on the page.\nCan include resized copies of the query image.", + "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, @@ -4251,7 +4251,7 @@ "type": "string" }, "partialMatchingImages": { - "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", + "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, @@ -4275,7 +4275,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", @@ -4287,7 +4287,7 @@ "description": "Additional information detected for the word." }, "symbols": { - "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", + "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "GoogleCloudVisionV1p2beta1Symbol" }, @@ -4297,19 +4297,19 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1AnnotateFileResponse": { - "description": "Response to a single file annotation request. A file may contain one or more\nimages, which individually have their own responses.", + "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "GoogleCloudVisionV1p3beta1AnnotateFileResponse", "properties": { "error": { "$ref": "Status", - "description": "If set, represents the error message for the failed request. The\n`responses` field will not be set in this case." + "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." }, "inputConfig": { "$ref": "GoogleCloudVisionV1p3beta1InputConfig", "description": "Information about the file for which this response is generated." }, "responses": { - "description": "Individual responses to images found within the file. This field will be\nempty if the `error` field is set.", + "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "GoogleCloudVisionV1p3beta1AnnotateImageResponse" }, @@ -4329,7 +4329,7 @@ "properties": { "context": { "$ref": "GoogleCloudVisionV1p3beta1ImageAnnotationContext", - "description": "If present, contextual information is needed to understand where this image\ncomes from." + "description": "If present, contextual information is needed to understand where this image comes from." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p3beta1CropHintsAnnotation", @@ -4337,7 +4337,7 @@ }, "error": { "$ref": "Status", - "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." + "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set." }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", @@ -4348,7 +4348,7 @@ }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p3beta1TextAnnotation", - "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." + "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." }, "imagePropertiesAnnotation": { "$ref": "GoogleCloudVisionV1p3beta1ImageProperties", @@ -4369,7 +4369,7 @@ "type": "array" }, "localizedObjectAnnotations": { - "description": "If present, localized object detection has completed successfully.\nThis will be sorted descending by confidence score.", + "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation" }, @@ -4420,7 +4420,7 @@ "id": "GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, one for each request in\nAsyncBatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse" }, @@ -4430,11 +4430,11 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1BatchOperationMetadata": { - "description": "Metadata for the batch operations such as the current state.\n\nThis is included in the `metadata` field of the `Operation` returned by the\n`GetOperation` call of the `google::longrunning::Operations` service.", + "description": "Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.", "id": "GoogleCloudVisionV1p3beta1BatchOperationMetadata", "properties": { "endTime": { - "description": "The time when the batch request is finished and\ngoogle.longrunning.Operation.done is set to true.", + "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.", "format": "google-datetime", "type": "string" }, @@ -4450,9 +4450,9 @@ "enumDescriptions": [ "Invalid.", "Request is actively being processed.", - "The request is done and at least one item has been successfully\nprocessed.", + "The request is done and at least one item has been successfully processed.", "The request is done and no item has been successfully processed.", - "The request is done after the longrunning.Operations.CancelOperation has\nbeen called by the user. Any records that were processed before the\ncancel command are output as specified in the request." + "The request is done after the longrunning.Operations.CancelOperation has been called by the user. Any records that were processed before the cancel command are output as specified in the request." ], "type": "string" }, @@ -4490,7 +4490,7 @@ }, "boundingBox": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", @@ -4533,7 +4533,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1ColorInfo": { - "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", + "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "GoogleCloudVisionV1p3beta1ColorInfo", "properties": { "color": { @@ -4541,7 +4541,7 @@ "description": "RGB components of the color." }, "pixelFraction": { - "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", + "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" }, @@ -4559,15 +4559,15 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale." + "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { - "description": "Confidence of this being a salient region. Range [0, 1].", + "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { - "description": "Fraction of importance of this salient region with respect to the original\nimage.", + "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } @@ -4608,10 +4608,10 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." + "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "confidence": { - "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", + "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float", "type": "number" }, @@ -4620,22 +4620,22 @@ "type": "string" }, "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", + "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "locations": { - "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", + "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "GoogleCloudVisionV1p3beta1LocationInfo" }, "type": "array" }, "mid": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", + "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "properties": { - "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", + "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "items": { "$ref": "GoogleCloudVisionV1p3beta1Property" }, @@ -4647,7 +4647,7 @@ "type": "number" }, "topicality": { - "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", + "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float", "type": "number" } @@ -4700,7 +4700,7 @@ }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." + "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", @@ -4709,7 +4709,7 @@ }, "fdBoundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe fd (face detection) prefix." + "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." }, "headwearLikelihood": { "description": "Headwear likelihood.", @@ -4764,12 +4764,12 @@ "type": "array" }, "panAngle": { - "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", + "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "rollAngle": { - "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", + "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "format": "float", "type": "number" }, @@ -4814,7 +4814,7 @@ "type": "string" }, "tiltAngle": { - "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", + "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, @@ -4935,7 +4935,7 @@ "id": "GoogleCloudVisionV1p3beta1GcsDestination", "properties": { "uri": { - "description": "Google Cloud Storage URI prefix where the results will be stored. Results\nwill be in JSON format and preceded by its corresponding input URI prefix.\nThis field can either represent a gcs file prefix or gcs directory. In\neither case, the uri should be unique because in order to get all of the\noutput files, you will need to do a wildcard gcs search on the uri prefix\nyou provide.\n\nExamples:\n\n* File Prefix: gs://bucket-name/here/filenameprefix The output files\nwill be created in gs://bucket-name/here/ and the names of the\noutput files will begin with \"filenameprefix\".\n\n* Directory Prefix: gs://bucket-name/some/location/ The output files\nwill be created in gs://bucket-name/some/location/ and the names of the\noutput files could be anything because there was no filename prefix\nspecified.\n\nIf multiple outputs, each response is still AnnotateFileResponse, each of\nwhich contains some subset of the full list of AnnotateImageResponse.\nMultiple outputs can happen if, for example, the output JSON is too large\nand overflows into multiple sharded files.", + "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, @@ -4946,18 +4946,18 @@ "id": "GoogleCloudVisionV1p3beta1GcsSource", "properties": { "uri": { - "description": "Google Cloud Storage URI for the input file. This must only be a\nGoogle Cloud Storage object. Wildcards are not currently supported.", + "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p3beta1ImageAnnotationContext": { - "description": "If an image was produced from a file (e.g. a PDF), this message gives\ninformation about the source of that image.", + "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "GoogleCloudVisionV1p3beta1ImageAnnotationContext", "properties": { "pageNumber": { - "description": "If the file was a PDF or TIFF, this field gives the page number within\nthe file used to produce the image.", + "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" }, @@ -4980,7 +4980,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1ImportProductSetsResponse": { - "description": "Response message for the `ImportProductSets` method.\n\nThis message is returned by the\ngoogle.longrunning.Operations.GetOperation method in the returned\ngoogle.longrunning.Operation.response field.", + "description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.", "id": "GoogleCloudVisionV1p3beta1ImportProductSetsResponse", "properties": { "referenceImages": { @@ -4991,7 +4991,7 @@ "type": "array" }, "statuses": { - "description": "The rpc status for each ImportProductSet request, including both successes\nand errors.\n\nThe number of statuses here matches the number of lines in the csv file,\nand statuses[i] stores the success or failure status of processing the i-th\nline of the csv, starting from line 0.", + "description": "The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.", "items": { "$ref": "Status" }, @@ -5005,7 +5005,7 @@ "id": "GoogleCloudVisionV1p3beta1InputConfig", "properties": { "content": { - "description": "File content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateFiles requests. It does\nnot work for AsyncBatchAnnotateFiles requests.", + "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "format": "byte", "type": "string" }, @@ -5014,7 +5014,7 @@ "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { - "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and\n\"image/gif\" are supported. Wildcards are not supported.", + "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } }, @@ -5029,7 +5029,7 @@ "description": "Image region to which this object belongs. This must be populated." }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -5060,7 +5060,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1NormalizedVertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the normalized vertex coordinates are relative to the original image\nand range from 0 to 1.", + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudVisionV1p3beta1NormalizedVertex", "properties": { "x": { @@ -5116,7 +5116,7 @@ "id": "GoogleCloudVisionV1p3beta1OutputConfig", "properties": { "batchSize": { - "description": "The max number of response protos to put into each output JSON file on\nGoogle Cloud Storage.\nThe valid range is [1, 100]. If not specified, the default value is 20.\n\nFor example, for one pdf file with 100 pages, 100 response protos will\nbe generated. If `batch_size` = 20, then 5 json files each\ncontaining 20 response protos will be written under the prefix\n`gcs_destination`.`uri`.\n\nCurrently, batch_size only applies to GcsDestination, with potential future\nsupport for other output configurations.", + "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, @@ -5144,7 +5144,7 @@ "type": "number" }, "height": { - "description": "Page height. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, @@ -5153,7 +5153,7 @@ "description": "Additional information detected on the page." }, "width": { - "description": "Page width. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" } @@ -5166,7 +5166,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", @@ -5188,7 +5188,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1Position": { - "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", + "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p3beta1Position", "properties": { "x": { @@ -5214,23 +5214,23 @@ "id": "GoogleCloudVisionV1p3beta1Product", "properties": { "description": { - "description": "User-provided metadata to be stored with this product. Must be at most 4096\ncharacters long.", + "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "displayName": { - "description": "The user-provided name for this Product. Must not be empty. Must be at most\n4096 characters long.", + "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { - "description": "The resource name of the product.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.\n\nThis field is ignored when creating a product.", + "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "productCategory": { - "description": "Immutable. The category for the product identified by the reference image. This should\nbe either \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\". The legacy categories\n\"homegoods\", \"apparel\", and \"toys\" are still supported, but these should\nnot be used for new products.", + "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { - "description": "Key-value pairs that can be attached to a product. At query time,\nconstraints can be specified based on the product_labels.\n\nNote that integer values can be provided as strings, e.g. \"1199\". Only\nstrings with integer values can match a range-based restriction which is\nto be supported soon.\n\nMultiple values can be assigned to the same key. One product may have up to\n500 product_labels.\n\nNotice that the total number of distinct product_labels over all products\nin one ProductSet cannot exceed 1M, otherwise the product search pipeline\nwill refuse to work for that ProductSet.", + "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.", "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductKeyValue" }, @@ -5244,11 +5244,11 @@ "id": "GoogleCloudVisionV1p3beta1ProductKeyValue", "properties": { "key": { - "description": "The key of the label attached to the product. Cannot be empty and cannot\nexceed 128 bytes.", + "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { - "description": "The value of the label attached to the product. Cannot be empty and\ncannot exceed 128 bytes.", + "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, @@ -5259,12 +5259,12 @@ "id": "GoogleCloudVisionV1p3beta1ProductSearchResults", "properties": { "indexTime": { - "description": "Timestamp of the index which provided these results. Products added to the\nproduct set and products removed from the product set after this time are\nnot reflected in the current results.", + "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime", "type": "string" }, "productGroupedResults": { - "description": "List of results grouped by products detected in the query image. Each entry\ncorresponds to one bounding polygon in the query image, and contains the\nmatching products specific to that region. There may be duplicate product\nmatches in the union of all the per-product results.", + "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult" }, @@ -5281,7 +5281,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult": { - "description": "Information about the products similar to a single product in a query\nimage.", + "description": "Information about the products similar to a single product in a query image.", "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult", "properties": { "boundingPoly": { @@ -5310,7 +5310,7 @@ "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation", "properties": { "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -5334,7 +5334,7 @@ "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsResult", "properties": { "image": { - "description": "The resource name of the image from the product that is the closest match\nto the query.", + "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { @@ -5342,7 +5342,7 @@ "description": "The Product." }, "score": { - "description": "A confidence level on the match, ranging from 0 (no confidence) to\n1 (full confidence).", + "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" } @@ -5370,33 +5370,33 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1ReferenceImage": { - "description": "A `ReferenceImage` represents a product image and its associated metadata,\nsuch as bounding boxes.", + "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.", "id": "GoogleCloudVisionV1p3beta1ReferenceImage", "properties": { "boundingPolys": { - "description": "Optional. Bounding polygons around the areas of interest in the reference image.\nIf this field is empty, the system will try to detect regions of\ninterest. At most 10 bounding polygons will be used.\n\nThe provided shape is converted into a non-rotated rectangle. Once\nconverted, the small edge of the rectangle must be greater than or equal\nto 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5\nis not).", + "description": "Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).", "items": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "type": "array" }, "name": { - "description": "The resource name of the reference image.\n\nFormat is:\n\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.\n\nThis field is ignored when creating a reference image.", + "description": "The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.", "type": "string" }, "uri": { - "description": "Required. The Google Cloud Storage URI of the reference image.\n\nThe URI must start with `gs://`.", + "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p3beta1SafeSearchAnnotation": { - "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", + "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "GoogleCloudVisionV1p3beta1SafeSearchAnnotation", "properties": { "adult": { - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -5436,7 +5436,7 @@ "type": "string" }, "racy": { - "description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.", + "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -5456,7 +5456,7 @@ "type": "string" }, "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -5504,7 +5504,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", @@ -5523,7 +5523,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1TextAnnotation": { - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", + "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "GoogleCloudVisionV1p3beta1TextAnnotation", "properties": { "pages": { @@ -5563,7 +5563,7 @@ "Regular space.", "Sure space (very wide).", "Line-wrapping break.", - "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", + "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" @@ -5581,7 +5581,7 @@ "type": "number" }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -5606,7 +5606,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1Vertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p3beta1Vertex", "properties": { "x": { @@ -5627,14 +5627,14 @@ "id": "GoogleCloudVisionV1p3beta1WebDetection", "properties": { "bestGuessLabels": { - "description": "The service's best guess as to the topic of the request image.\nInferred from similar images on the open web.", + "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebLabel" }, "type": "array" }, "fullMatchingImages": { - "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", + "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, @@ -5648,7 +5648,7 @@ "type": "array" }, "partialMatchingImages": { - "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", + "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, @@ -5684,7 +5684,7 @@ "type": "string" }, "score": { - "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", + "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } @@ -5716,7 +5716,7 @@ "type": "string" }, "languageCode": { - "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -5727,7 +5727,7 @@ "id": "GoogleCloudVisionV1p3beta1WebDetectionWebPage", "properties": { "fullMatchingImages": { - "description": "Fully matching images on the page.\nCan include resized copies of the query image.", + "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, @@ -5738,7 +5738,7 @@ "type": "string" }, "partialMatchingImages": { - "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", + "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, @@ -5762,7 +5762,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", @@ -5774,7 +5774,7 @@ "description": "Additional information detected for the word." }, "symbols": { - "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", + "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "GoogleCloudVisionV1p3beta1Symbol" }, @@ -5784,19 +5784,19 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1AnnotateFileResponse": { - "description": "Response to a single file annotation request. A file may contain one or more\nimages, which individually have their own responses.", + "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "GoogleCloudVisionV1p4beta1AnnotateFileResponse", "properties": { "error": { "$ref": "Status", - "description": "If set, represents the error message for the failed request. The\n`responses` field will not be set in this case." + "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." }, "inputConfig": { "$ref": "GoogleCloudVisionV1p4beta1InputConfig", "description": "Information about the file for which this response is generated." }, "responses": { - "description": "Individual responses to images found within the file. This field will be\nempty if the `error` field is set.", + "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "GoogleCloudVisionV1p4beta1AnnotateImageResponse" }, @@ -5816,7 +5816,7 @@ "properties": { "context": { "$ref": "GoogleCloudVisionV1p4beta1ImageAnnotationContext", - "description": "If present, contextual information is needed to understand where this image\ncomes from." + "description": "If present, contextual information is needed to understand where this image comes from." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p4beta1CropHintsAnnotation", @@ -5824,7 +5824,7 @@ }, "error": { "$ref": "Status", - "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." + "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set." }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", @@ -5835,7 +5835,7 @@ }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p4beta1TextAnnotation", - "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." + "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." }, "imagePropertiesAnnotation": { "$ref": "GoogleCloudVisionV1p4beta1ImageProperties", @@ -5856,7 +5856,7 @@ "type": "array" }, "localizedObjectAnnotations": { - "description": "If present, localized object detection has completed successfully.\nThis will be sorted descending by confidence score.", + "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation" }, @@ -5907,7 +5907,7 @@ "id": "GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, one for each request in\nAsyncBatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse" }, @@ -5932,7 +5932,7 @@ "id": "GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, each response corresponding to each\nAnnotateFileRequest in BatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p4beta1AnnotateFileResponse" }, @@ -5942,11 +5942,11 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1BatchOperationMetadata": { - "description": "Metadata for the batch operations such as the current state.\n\nThis is included in the `metadata` field of the `Operation` returned by the\n`GetOperation` call of the `google::longrunning::Operations` service.", + "description": "Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.", "id": "GoogleCloudVisionV1p4beta1BatchOperationMetadata", "properties": { "endTime": { - "description": "The time when the batch request is finished and\ngoogle.longrunning.Operation.done is set to true.", + "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.", "format": "google-datetime", "type": "string" }, @@ -5962,9 +5962,9 @@ "enumDescriptions": [ "Invalid.", "Request is actively being processed.", - "The request is done and at least one item has been successfully\nprocessed.", + "The request is done and at least one item has been successfully processed.", "The request is done and no item has been successfully processed.", - "The request is done after the longrunning.Operations.CancelOperation has\nbeen called by the user. Any records that were processed before the\ncancel command are output as specified in the request." + "The request is done after the longrunning.Operations.CancelOperation has been called by the user. Any records that were processed before the cancel command are output as specified in the request." ], "type": "string" }, @@ -6002,7 +6002,7 @@ }, "boundingBox": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", @@ -6057,14 +6057,14 @@ "type": "string" }, "name": { - "description": "The resource name of the preloaded Celebrity. Has the format\n`builtin/{mid}`.", + "description": "The resource name of the preloaded Celebrity. Has the format `builtin/{mid}`.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1ColorInfo": { - "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", + "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "GoogleCloudVisionV1p4beta1ColorInfo", "properties": { "color": { @@ -6072,7 +6072,7 @@ "description": "RGB components of the color." }, "pixelFraction": { - "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", + "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" }, @@ -6090,15 +6090,15 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale." + "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { - "description": "Confidence of this being a salient region. Range [0, 1].", + "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { - "description": "Fraction of importance of this salient region with respect to the original\nimage.", + "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } @@ -6139,10 +6139,10 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." + "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "confidence": { - "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", + "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float", "type": "number" }, @@ -6151,22 +6151,22 @@ "type": "string" }, "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", + "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "locations": { - "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", + "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "GoogleCloudVisionV1p4beta1LocationInfo" }, "type": "array" }, "mid": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", + "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "properties": { - "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", + "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "items": { "$ref": "GoogleCloudVisionV1p4beta1Property" }, @@ -6178,7 +6178,7 @@ "type": "number" }, "topicality": { - "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", + "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float", "type": "number" } @@ -6231,7 +6231,7 @@ }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." + "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", @@ -6240,7 +6240,7 @@ }, "fdBoundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe fd (face detection) prefix." + "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." }, "headwearLikelihood": { "description": "Headwear likelihood.", @@ -6295,19 +6295,19 @@ "type": "array" }, "panAngle": { - "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", + "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "recognitionResult": { - "description": "Additional recognition information. Only computed if\nimage_context.face_recognition_params is provided, **and** a match is found\nto a Celebrity in the input CelebritySet. This field is\nsorted in order of decreasing confidence values.", + "description": "Additional recognition information. Only computed if image_context.face_recognition_params is provided, **and** a match is found to a Celebrity in the input CelebritySet. This field is sorted in order of decreasing confidence values.", "items": { "$ref": "GoogleCloudVisionV1p4beta1FaceRecognitionResult" }, "type": "array" }, "rollAngle": { - "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", + "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "format": "float", "type": "number" }, @@ -6352,7 +6352,7 @@ "type": "string" }, "tiltAngle": { - "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", + "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, @@ -6489,7 +6489,7 @@ "id": "GoogleCloudVisionV1p4beta1GcsDestination", "properties": { "uri": { - "description": "Google Cloud Storage URI prefix where the results will be stored. Results\nwill be in JSON format and preceded by its corresponding input URI prefix.\nThis field can either represent a gcs file prefix or gcs directory. In\neither case, the uri should be unique because in order to get all of the\noutput files, you will need to do a wildcard gcs search on the uri prefix\nyou provide.\n\nExamples:\n\n* File Prefix: gs://bucket-name/here/filenameprefix The output files\nwill be created in gs://bucket-name/here/ and the names of the\noutput files will begin with \"filenameprefix\".\n\n* Directory Prefix: gs://bucket-name/some/location/ The output files\nwill be created in gs://bucket-name/some/location/ and the names of the\noutput files could be anything because there was no filename prefix\nspecified.\n\nIf multiple outputs, each response is still AnnotateFileResponse, each of\nwhich contains some subset of the full list of AnnotateImageResponse.\nMultiple outputs can happen if, for example, the output JSON is too large\nand overflows into multiple sharded files.", + "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, @@ -6500,18 +6500,18 @@ "id": "GoogleCloudVisionV1p4beta1GcsSource", "properties": { "uri": { - "description": "Google Cloud Storage URI for the input file. This must only be a\nGoogle Cloud Storage object. Wildcards are not currently supported.", + "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1ImageAnnotationContext": { - "description": "If an image was produced from a file (e.g. a PDF), this message gives\ninformation about the source of that image.", + "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "GoogleCloudVisionV1p4beta1ImageAnnotationContext", "properties": { "pageNumber": { - "description": "If the file was a PDF or TIFF, this field gives the page number within\nthe file used to produce the image.", + "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" }, @@ -6534,7 +6534,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1ImportProductSetsResponse": { - "description": "Response message for the `ImportProductSets` method.\n\nThis message is returned by the\ngoogle.longrunning.Operations.GetOperation method in the returned\ngoogle.longrunning.Operation.response field.", + "description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.", "id": "GoogleCloudVisionV1p4beta1ImportProductSetsResponse", "properties": { "referenceImages": { @@ -6545,7 +6545,7 @@ "type": "array" }, "statuses": { - "description": "The rpc status for each ImportProductSet request, including both successes\nand errors.\n\nThe number of statuses here matches the number of lines in the csv file,\nand statuses[i] stores the success or failure status of processing the i-th\nline of the csv, starting from line 0.", + "description": "The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.", "items": { "$ref": "Status" }, @@ -6559,7 +6559,7 @@ "id": "GoogleCloudVisionV1p4beta1InputConfig", "properties": { "content": { - "description": "File content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateFiles requests. It does\nnot work for AsyncBatchAnnotateFiles requests.", + "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "format": "byte", "type": "string" }, @@ -6568,7 +6568,7 @@ "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { - "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and\n\"image/gif\" are supported. Wildcards are not supported.", + "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } }, @@ -6583,7 +6583,7 @@ "description": "Image region to which this object belongs. This must be populated." }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -6614,7 +6614,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1NormalizedVertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the normalized vertex coordinates are relative to the original image\nand range from 0 to 1.", + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudVisionV1p4beta1NormalizedVertex", "properties": { "x": { @@ -6670,7 +6670,7 @@ "id": "GoogleCloudVisionV1p4beta1OutputConfig", "properties": { "batchSize": { - "description": "The max number of response protos to put into each output JSON file on\nGoogle Cloud Storage.\nThe valid range is [1, 100]. If not specified, the default value is 20.\n\nFor example, for one pdf file with 100 pages, 100 response protos will\nbe generated. If `batch_size` = 20, then 5 json files each\ncontaining 20 response protos will be written under the prefix\n`gcs_destination`.`uri`.\n\nCurrently, batch_size only applies to GcsDestination, with potential future\nsupport for other output configurations.", + "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, @@ -6698,7 +6698,7 @@ "type": "number" }, "height": { - "description": "Page height. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, @@ -6707,7 +6707,7 @@ "description": "Additional information detected on the page." }, "width": { - "description": "Page width. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" } @@ -6720,7 +6720,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", @@ -6742,7 +6742,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1Position": { - "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", + "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p4beta1Position", "properties": { "x": { @@ -6768,23 +6768,23 @@ "id": "GoogleCloudVisionV1p4beta1Product", "properties": { "description": { - "description": "User-provided metadata to be stored with this product. Must be at most 4096\ncharacters long.", + "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "displayName": { - "description": "The user-provided name for this Product. Must not be empty. Must be at most\n4096 characters long.", + "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { - "description": "The resource name of the product.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.\n\nThis field is ignored when creating a product.", + "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "productCategory": { - "description": "Immutable. The category for the product identified by the reference image. This should\nbe either \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\". The legacy categories\n\"homegoods\", \"apparel\", and \"toys\" are still supported, but these should\nnot be used for new products.", + "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { - "description": "Key-value pairs that can be attached to a product. At query time,\nconstraints can be specified based on the product_labels.\n\nNote that integer values can be provided as strings, e.g. \"1199\". Only\nstrings with integer values can match a range-based restriction which is\nto be supported soon.\n\nMultiple values can be assigned to the same key. One product may have up to\n500 product_labels.\n\nNotice that the total number of distinct product_labels over all products\nin one ProductSet cannot exceed 1M, otherwise the product search pipeline\nwill refuse to work for that ProductSet.", + "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductKeyValue" }, @@ -6798,11 +6798,11 @@ "id": "GoogleCloudVisionV1p4beta1ProductKeyValue", "properties": { "key": { - "description": "The key of the label attached to the product. Cannot be empty and cannot\nexceed 128 bytes.", + "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { - "description": "The value of the label attached to the product. Cannot be empty and\ncannot exceed 128 bytes.", + "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, @@ -6813,12 +6813,12 @@ "id": "GoogleCloudVisionV1p4beta1ProductSearchResults", "properties": { "indexTime": { - "description": "Timestamp of the index which provided these results. Products added to the\nproduct set and products removed from the product set after this time are\nnot reflected in the current results.", + "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime", "type": "string" }, "productGroupedResults": { - "description": "List of results grouped by products detected in the query image. Each entry\ncorresponds to one bounding polygon in the query image, and contains the\nmatching products specific to that region. There may be duplicate product\nmatches in the union of all the per-product results.", + "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult" }, @@ -6835,7 +6835,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult": { - "description": "Information about the products similar to a single product in a query\nimage.", + "description": "Information about the products similar to a single product in a query image.", "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult", "properties": { "boundingPoly": { @@ -6864,7 +6864,7 @@ "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation", "properties": { "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -6888,7 +6888,7 @@ "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsResult", "properties": { "image": { - "description": "The resource name of the image from the product that is the closest match\nto the query.", + "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { @@ -6896,7 +6896,7 @@ "description": "The Product." }, "score": { - "description": "A confidence level on the match, ranging from 0 (no confidence) to\n1 (full confidence).", + "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" } @@ -6924,33 +6924,33 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1ReferenceImage": { - "description": "A `ReferenceImage` represents a product image and its associated metadata,\nsuch as bounding boxes.", + "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.", "id": "GoogleCloudVisionV1p4beta1ReferenceImage", "properties": { "boundingPolys": { - "description": "Optional. Bounding polygons around the areas of interest in the reference image.\nIf this field is empty, the system will try to detect regions of\ninterest. At most 10 bounding polygons will be used.\n\nThe provided shape is converted into a non-rotated rectangle. Once\nconverted, the small edge of the rectangle must be greater than or equal\nto 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5\nis not).", + "description": "Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).", "items": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "type": "array" }, "name": { - "description": "The resource name of the reference image.\n\nFormat is:\n\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.\n\nThis field is ignored when creating a reference image.", + "description": "The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.", "type": "string" }, "uri": { - "description": "Required. The Google Cloud Storage URI of the reference image.\n\nThe URI must start with `gs://`.", + "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1SafeSearchAnnotation": { - "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", + "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "GoogleCloudVisionV1p4beta1SafeSearchAnnotation", "properties": { "adult": { - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -6990,7 +6990,7 @@ "type": "string" }, "racy": { - "description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.", + "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -7010,7 +7010,7 @@ "type": "string" }, "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -7058,7 +7058,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", @@ -7077,7 +7077,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1TextAnnotation": { - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", + "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "GoogleCloudVisionV1p4beta1TextAnnotation", "properties": { "pages": { @@ -7117,7 +7117,7 @@ "Regular space.", "Sure space (very wide).", "Line-wrapping break.", - "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", + "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" @@ -7135,7 +7135,7 @@ "type": "number" }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -7160,7 +7160,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1Vertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p4beta1Vertex", "properties": { "x": { @@ -7181,14 +7181,14 @@ "id": "GoogleCloudVisionV1p4beta1WebDetection", "properties": { "bestGuessLabels": { - "description": "The service's best guess as to the topic of the request image.\nInferred from similar images on the open web.", + "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebLabel" }, "type": "array" }, "fullMatchingImages": { - "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", + "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, @@ -7202,7 +7202,7 @@ "type": "array" }, "partialMatchingImages": { - "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", + "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, @@ -7238,7 +7238,7 @@ "type": "string" }, "score": { - "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", + "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } @@ -7270,7 +7270,7 @@ "type": "string" }, "languageCode": { - "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -7281,7 +7281,7 @@ "id": "GoogleCloudVisionV1p4beta1WebDetectionWebPage", "properties": { "fullMatchingImages": { - "description": "Fully matching images on the page.\nCan include resized copies of the query image.", + "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, @@ -7292,7 +7292,7 @@ "type": "string" }, "partialMatchingImages": { - "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", + "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, @@ -7316,7 +7316,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", @@ -7328,7 +7328,7 @@ "description": "Additional information detected for the word." }, "symbols": { - "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", + "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "GoogleCloudVisionV1p4beta1Symbol" }, @@ -7338,7 +7338,7 @@ "type": "object" }, "GroupedResult": { - "description": "Information about the products similar to a single product in a query\nimage.", + "description": "Information about the products similar to a single product in a query image.", "id": "GroupedResult", "properties": { "boundingPoly": { @@ -7363,11 +7363,11 @@ "type": "object" }, "ImageAnnotationContext": { - "description": "If an image was produced from a file (e.g. a PDF), this message gives\ninformation about the source of that image.", + "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "ImageAnnotationContext", "properties": { "pageNumber": { - "description": "If the file was a PDF or TIFF, this field gives the page number within\nthe file used to produce the image.", + "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" }, @@ -7390,7 +7390,7 @@ "type": "object" }, "ImportProductSetsResponse": { - "description": "Response message for the `ImportProductSets` method.\n\nThis message is returned by the\ngoogle.longrunning.Operations.GetOperation method in the returned\ngoogle.longrunning.Operation.response field.", + "description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.", "id": "ImportProductSetsResponse", "properties": { "referenceImages": { @@ -7401,7 +7401,7 @@ "type": "array" }, "statuses": { - "description": "The rpc status for each ImportProductSet request, including both successes\nand errors.\n\nThe number of statuses here matches the number of lines in the csv file,\nand statuses[i] stores the success or failure status of processing the i-th\nline of the csv, starting from line 0.", + "description": "The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.", "items": { "$ref": "Status" }, @@ -7415,7 +7415,7 @@ "id": "InputConfig", "properties": { "content": { - "description": "File content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateFiles requests. It does\nnot work for AsyncBatchAnnotateFiles requests.", + "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "format": "byte", "type": "string" }, @@ -7424,7 +7424,7 @@ "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { - "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and\n\"image/gif\" are supported. Wildcards are not supported.", + "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } }, @@ -7435,11 +7435,11 @@ "id": "KeyValue", "properties": { "key": { - "description": "The key of the label attached to the product. Cannot be empty and cannot\nexceed 128 bytes.", + "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { - "description": "The value of the label attached to the product. Cannot be empty and\ncannot exceed 128 bytes.", + "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, @@ -7535,7 +7535,7 @@ "type": "object" }, "LatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\nWGS84\nstandard. Values must be within normalized ranges.", + "description": "An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", "id": "LatLng", "properties": { "latitude": { @@ -7560,7 +7560,7 @@ "description": "Image region to which this object belongs. This must be populated." }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -7591,7 +7591,7 @@ "type": "object" }, "NormalizedVertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the normalized vertex coordinates are relative to the original image\nand range from 0 to 1.", + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "NormalizedVertex", "properties": { "x": { @@ -7612,7 +7612,7 @@ "id": "ObjectAnnotation", "properties": { "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -7632,11 +7632,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": { @@ -7648,11 +7648,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": { @@ -7660,7 +7660,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" } }, @@ -7706,7 +7706,7 @@ "id": "OutputConfig", "properties": { "batchSize": { - "description": "The max number of response protos to put into each output JSON file on\nGoogle Cloud Storage.\nThe valid range is [1, 100]. If not specified, the default value is 20.\n\nFor example, for one pdf file with 100 pages, 100 response protos will\nbe generated. If `batch_size` = 20, then 5 json files each\ncontaining 20 response protos will be written under the prefix\n`gcs_destination`.`uri`.\n\nCurrently, batch_size only applies to GcsDestination, with potential future\nsupport for other output configurations.", + "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, @@ -7734,7 +7734,7 @@ "type": "number" }, "height": { - "description": "Page height. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, @@ -7743,7 +7743,7 @@ "description": "Additional information detected on the page." }, "width": { - "description": "Page width. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" } @@ -7756,7 +7756,7 @@ "properties": { "boundingBox": { "$ref": "BoundingPoly", - "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", @@ -7778,7 +7778,7 @@ "type": "object" }, "Position": { - "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", + "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "Position", "properties": { "x": { @@ -7804,23 +7804,23 @@ "id": "Product", "properties": { "description": { - "description": "User-provided metadata to be stored with this product. Must be at most 4096\ncharacters long.", + "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "displayName": { - "description": "The user-provided name for this Product. Must not be empty. Must be at most\n4096 characters long.", + "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { - "description": "The resource name of the product.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.\n\nThis field is ignored when creating a product.", + "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "productCategory": { - "description": "Immutable. The category for the product identified by the reference image. This should\nbe either \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\". The legacy categories\n\"homegoods\", \"apparel\", and \"toys\" are still supported, but these should\nnot be used for new products.", + "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { - "description": "Key-value pairs that can be attached to a product. At query time,\nconstraints can be specified based on the product_labels.\n\nNote that integer values can be provided as strings, e.g. \"1199\". Only\nstrings with integer values can match a range-based restriction which is\nto be supported soon.\n\nMultiple values can be assigned to the same key. One product may have up to\n500 product_labels.\n\nNotice that the total number of distinct product_labels over all products\nin one ProductSet cannot exceed 1M, otherwise the product search pipeline\nwill refuse to work for that ProductSet.", + "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.", "items": { "$ref": "KeyValue" }, @@ -7834,12 +7834,12 @@ "id": "ProductSearchResults", "properties": { "indexTime": { - "description": "Timestamp of the index which provided these results. Products added to the\nproduct set and products removed from the product set after this time are\nnot reflected in the current results.", + "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime", "type": "string" }, "productGroupedResults": { - "description": "List of results grouped by products detected in the query image. Each entry\ncorresponds to one bounding polygon in the query image, and contains the\nmatching products specific to that region. There may be duplicate product\nmatches in the union of all the per-product results.", + "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "items": { "$ref": "GroupedResult" }, @@ -7876,22 +7876,22 @@ "type": "object" }, "ReferenceImage": { - "description": "A `ReferenceImage` represents a product image and its associated metadata,\nsuch as bounding boxes.", + "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.", "id": "ReferenceImage", "properties": { "boundingPolys": { - "description": "Optional. Bounding polygons around the areas of interest in the reference image.\nIf this field is empty, the system will try to detect regions of\ninterest. At most 10 bounding polygons will be used.\n\nThe provided shape is converted into a non-rotated rectangle. Once\nconverted, the small edge of the rectangle must be greater than or equal\nto 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5\nis not).", + "description": "Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).", "items": { "$ref": "BoundingPoly" }, "type": "array" }, "name": { - "description": "The resource name of the reference image.\n\nFormat is:\n\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.\n\nThis field is ignored when creating a reference image.", + "description": "The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.", "type": "string" }, "uri": { - "description": "Required. The Google Cloud Storage URI of the reference image.\n\nThe URI must start with `gs://`.", + "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`.", "type": "string" } }, @@ -7902,7 +7902,7 @@ "id": "Result", "properties": { "image": { - "description": "The resource name of the image from the product that is the closest match\nto the query.", + "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { @@ -7910,7 +7910,7 @@ "description": "The Product." }, "score": { - "description": "A confidence level on the match, ranging from 0 (no confidence) to\n1 (full confidence).", + "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" } @@ -7918,11 +7918,11 @@ "type": "object" }, "SafeSearchAnnotation": { - "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", + "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "SafeSearchAnnotation", "properties": { "adult": { - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -7962,7 +7962,7 @@ "type": "string" }, "racy": { - "description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.", + "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -7982,7 +7982,7 @@ "type": "string" }, "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -8025,7 +8025,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": { @@ -8034,7 +8034,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.", @@ -8045,7 +8045,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" } }, @@ -8057,7 +8057,7 @@ "properties": { "boundingBox": { "$ref": "BoundingPoly", - "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", @@ -8076,7 +8076,7 @@ "type": "object" }, "TextAnnotation": { - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", + "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "TextAnnotation", "properties": { "pages": { @@ -8112,7 +8112,7 @@ "type": "object" }, "Vertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "Vertex", "properties": { "x": { @@ -8133,14 +8133,14 @@ "id": "WebDetection", "properties": { "bestGuessLabels": { - "description": "The service's best guess as to the topic of the request image.\nInferred from similar images on the open web.", + "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "WebLabel" }, "type": "array" }, "fullMatchingImages": { - "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", + "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "WebImage" }, @@ -8154,7 +8154,7 @@ "type": "array" }, "partialMatchingImages": { - "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", + "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "WebImage" }, @@ -8190,7 +8190,7 @@ "type": "string" }, "score": { - "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", + "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } @@ -8222,7 +8222,7 @@ "type": "string" }, "languageCode": { - "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -8233,7 +8233,7 @@ "id": "WebPage", "properties": { "fullMatchingImages": { - "description": "Fully matching images on the page.\nCan include resized copies of the query image.", + "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "WebImage" }, @@ -8244,7 +8244,7 @@ "type": "string" }, "partialMatchingImages": { - "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", + "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "WebImage" }, @@ -8268,7 +8268,7 @@ "properties": { "boundingBox": { "$ref": "BoundingPoly", - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", @@ -8280,7 +8280,7 @@ "description": "Additional information detected for the word." }, "symbols": { - "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", + "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "Symbol" }, diff --git a/discovery/vision-v1p2beta1.json b/discovery/vision-v1p2beta1.json index 45d70b2c3d..9ffe8cbb36 100644 --- a/discovery/vision-v1p2beta1.json +++ b/discovery/vision-v1p2beta1.json @@ -111,7 +111,7 @@ "files": { "methods": { "annotate": { - "description": "Service that performs image detection and annotation for a batch of files.\nNow only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported.\n\nThis service will extract at most 5 (customers can specify which 5 in\nAnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each\nfile provided and perform detection and annotation for each image\nextracted.", + "description": "Service that performs image detection and annotation for a batch of files. Now only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.", "flatPath": "v1p2beta1/files:annotate", "httpMethod": "POST", "id": "vision.files.annotate", @@ -130,7 +130,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of generic\nfiles, such as PDF files, which may contain multiple pages and multiple\nimages per page. Progress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", + "description": "Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", "flatPath": "v1p2beta1/files:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.files.asyncBatchAnnotate", @@ -172,7 +172,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of images.\n\nProgress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results).\n\nThis service will write image annotation outputs to json files in customer\nGCS bucket, each json file containing BatchAnnotateImagesResponse proto.", + "description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.", "flatPath": "v1p2beta1/images:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.images.asyncBatchAnnotate", @@ -197,7 +197,7 @@ "files": { "methods": { "annotate": { - "description": "Service that performs image detection and annotation for a batch of files.\nNow only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported.\n\nThis service will extract at most 5 (customers can specify which 5 in\nAnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each\nfile provided and perform detection and annotation for each image\nextracted.", + "description": "Service that performs image detection and annotation for a batch of files. Now only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.", "flatPath": "v1p2beta1/projects/{projectsId}/files:annotate", "httpMethod": "POST", "id": "vision.projects.files.annotate", @@ -206,7 +206,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -226,7 +226,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of generic\nfiles, such as PDF files, which may contain multiple pages and multiple\nimages per page. Progress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", + "description": "Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", "flatPath": "v1p2beta1/projects/{projectsId}/files:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.projects.files.asyncBatchAnnotate", @@ -235,7 +235,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -268,7 +268,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -288,7 +288,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of images.\n\nProgress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results).\n\nThis service will write image annotation outputs to json files in customer\nGCS bucket, each json file containing BatchAnnotateImagesResponse proto.", + "description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.", "flatPath": "v1p2beta1/projects/{projectsId}/images:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.projects.images.asyncBatchAnnotate", @@ -297,7 +297,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -323,7 +323,7 @@ "files": { "methods": { "annotate": { - "description": "Service that performs image detection and annotation for a batch of files.\nNow only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported.\n\nThis service will extract at most 5 (customers can specify which 5 in\nAnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each\nfile provided and perform detection and annotation for each image\nextracted.", + "description": "Service that performs image detection and annotation for a batch of files. Now only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.", "flatPath": "v1p2beta1/projects/{projectsId}/locations/{locationsId}/files:annotate", "httpMethod": "POST", "id": "vision.projects.locations.files.annotate", @@ -332,7 +332,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -352,7 +352,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of generic\nfiles, such as PDF files, which may contain multiple pages and multiple\nimages per page. Progress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", + "description": "Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", "flatPath": "v1p2beta1/projects/{projectsId}/locations/{locationsId}/files:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.projects.locations.files.asyncBatchAnnotate", @@ -361,7 +361,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -394,7 +394,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -414,7 +414,7 @@ ] }, "asyncBatchAnnotate": { - "description": "Run asynchronous image detection and annotation for a list of images.\n\nProgress and results can be retrieved through the\n`google.longrunning.Operations` interface.\n`Operation.metadata` contains `OperationMetadata` (metadata).\n`Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results).\n\nThis service will write image annotation outputs to json files in customer\nGCS bucket, each json file containing BatchAnnotateImagesResponse proto.", + "description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.", "flatPath": "v1p2beta1/projects/{projectsId}/locations/{locationsId}/images:asyncBatchAnnotate", "httpMethod": "POST", "id": "vision.projects.locations.images.asyncBatchAnnotate", @@ -423,7 +423,7 @@ ], "parameters": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -449,23 +449,23 @@ } } }, - "revision": "20200710", + "revision": "20200801", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AnnotateFileResponse": { - "description": "Response to a single file annotation request. A file may contain one or more\nimages, which individually have their own responses.", + "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "AnnotateFileResponse", "properties": { "error": { "$ref": "Status", - "description": "If set, represents the error message for the failed request. The\n`responses` field will not be set in this case." + "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." }, "inputConfig": { "$ref": "InputConfig", "description": "Information about the file for which this response is generated." }, "responses": { - "description": "Individual responses to images found within the file. This field will be\nempty if the `error` field is set.", + "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "AnnotateImageResponse" }, @@ -485,7 +485,7 @@ "properties": { "context": { "$ref": "ImageAnnotationContext", - "description": "If present, contextual information is needed to understand where this image\ncomes from." + "description": "If present, contextual information is needed to understand where this image comes from." }, "cropHintsAnnotation": { "$ref": "CropHintsAnnotation", @@ -493,7 +493,7 @@ }, "error": { "$ref": "Status", - "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." + "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set." }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", @@ -504,7 +504,7 @@ }, "fullTextAnnotation": { "$ref": "TextAnnotation", - "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." + "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." }, "imagePropertiesAnnotation": { "$ref": "ImageProperties", @@ -525,7 +525,7 @@ "type": "array" }, "localizedObjectAnnotations": { - "description": "If present, localized object detection has completed successfully.\nThis will be sorted descending by confidence score.", + "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "LocalizedObjectAnnotation" }, @@ -576,7 +576,7 @@ "id": "AsyncBatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, one for each request in\nAsyncBatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "items": { "$ref": "AsyncAnnotateFileResponse" }, @@ -601,7 +601,7 @@ "id": "BatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, each response corresponding to each\nAnnotateFileRequest in BatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.", "items": { "$ref": "AnnotateFileResponse" }, @@ -611,11 +611,11 @@ "type": "object" }, "BatchOperationMetadata": { - "description": "Metadata for the batch operations such as the current state.\n\nThis is included in the `metadata` field of the `Operation` returned by the\n`GetOperation` call of the `google::longrunning::Operations` service.", + "description": "Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.", "id": "BatchOperationMetadata", "properties": { "endTime": { - "description": "The time when the batch request is finished and\ngoogle.longrunning.Operation.done is set to true.", + "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.", "format": "google-datetime", "type": "string" }, @@ -631,9 +631,9 @@ "enumDescriptions": [ "Invalid.", "Request is actively being processed.", - "The request is done and at least one item has been successfully\nprocessed.", + "The request is done and at least one item has been successfully processed.", "The request is done and no item has been successfully processed.", - "The request is done after the longrunning.Operations.CancelOperation has\nbeen called by the user. Any records that were processed before the\ncancel command are output as specified in the request." + "The request is done after the longrunning.Operations.CancelOperation has been called by the user. Any records that were processed before the cancel command are output as specified in the request." ], "type": "string" }, @@ -671,7 +671,7 @@ }, "boundingBox": { "$ref": "BoundingPoly", - "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", @@ -714,11 +714,11 @@ "type": "object" }, "Color": { - "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well.\n\nNote: this proto does not carry information about the absolute color space\nthat should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,\nDCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color\nspace.\n\nNote: when color equality needs to be decided, implementations, unless\ndocumented otherwise, will treat two colors to be equal if all their red,\ngreen, blue and alpha values each differ by at most 1e-5.\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [[Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha <= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red << 16) | (green << 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i < missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...", + "description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of \"java.awt.Color\" in Java; it can also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\" method in iOS; and, with just a little work, it can be easily formatted into a CSS \"rgba()\" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be equal if all their red, green, blue and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...", "id": "Color", "properties": { "alpha": { - "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).", + "description": "The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0).", "format": "float", "type": "number" }, @@ -741,7 +741,7 @@ "type": "object" }, "ColorInfo": { - "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", + "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "ColorInfo", "properties": { "color": { @@ -749,7 +749,7 @@ "description": "RGB components of the color." }, "pixelFraction": { - "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", + "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" }, @@ -767,15 +767,15 @@ "properties": { "boundingPoly": { "$ref": "BoundingPoly", - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale." + "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { - "description": "Confidence of this being a salient region. Range [0, 1].", + "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { - "description": "Fraction of importance of this salient region with respect to the original\nimage.", + "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } @@ -819,7 +819,7 @@ "Regular space.", "Sure space (very wide).", "Line-wrapping break.", - "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", + "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" @@ -837,7 +837,7 @@ "type": "number" }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -863,10 +863,10 @@ "properties": { "boundingPoly": { "$ref": "BoundingPoly", - "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." + "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "confidence": { - "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", + "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float", "type": "number" }, @@ -875,22 +875,22 @@ "type": "string" }, "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", + "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "locations": { - "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", + "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "LocationInfo" }, "type": "array" }, "mid": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", + "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "properties": { - "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", + "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "items": { "$ref": "Property" }, @@ -902,7 +902,7 @@ "type": "number" }, "topicality": { - "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", + "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float", "type": "number" } @@ -955,7 +955,7 @@ }, "boundingPoly": { "$ref": "BoundingPoly", - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." + "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", @@ -964,7 +964,7 @@ }, "fdBoundingPoly": { "$ref": "BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe fd (face detection) prefix." + "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." }, "headwearLikelihood": { "description": "Headwear likelihood.", @@ -1019,12 +1019,12 @@ "type": "array" }, "panAngle": { - "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", + "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "rollAngle": { - "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", + "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "format": "float", "type": "number" }, @@ -1069,7 +1069,7 @@ "type": "string" }, "tiltAngle": { - "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", + "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, @@ -1101,7 +1101,7 @@ "id": "GcsDestination", "properties": { "uri": { - "description": "Google Cloud Storage URI prefix where the results will be stored. Results\nwill be in JSON format and preceded by its corresponding input URI prefix.\nThis field can either represent a gcs file prefix or gcs directory. In\neither case, the uri should be unique because in order to get all of the\noutput files, you will need to do a wildcard gcs search on the uri prefix\nyou provide.\n\nExamples:\n\n* File Prefix: gs://bucket-name/here/filenameprefix The output files\nwill be created in gs://bucket-name/here/ and the names of the\noutput files will begin with \"filenameprefix\".\n\n* Directory Prefix: gs://bucket-name/some/location/ The output files\nwill be created in gs://bucket-name/some/location/ and the names of the\noutput files could be anything because there was no filename prefix\nspecified.\n\nIf multiple outputs, each response is still AnnotateFileResponse, each of\nwhich contains some subset of the full list of AnnotateImageResponse.\nMultiple outputs can happen if, for example, the output JSON is too large\nand overflows into multiple sharded files.", + "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, @@ -1112,26 +1112,26 @@ "id": "GcsSource", "properties": { "uri": { - "description": "Google Cloud Storage URI for the input file. This must only be a\nGoogle Cloud Storage object. Wildcards are not currently supported.", + "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p1beta1AnnotateFileResponse": { - "description": "Response to a single file annotation request. A file may contain one or more\nimages, which individually have their own responses.", + "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "GoogleCloudVisionV1p1beta1AnnotateFileResponse", "properties": { "error": { "$ref": "Status", - "description": "If set, represents the error message for the failed request. The\n`responses` field will not be set in this case." + "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." }, "inputConfig": { "$ref": "GoogleCloudVisionV1p1beta1InputConfig", "description": "Information about the file for which this response is generated." }, "responses": { - "description": "Individual responses to images found within the file. This field will be\nempty if the `error` field is set.", + "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "GoogleCloudVisionV1p1beta1AnnotateImageResponse" }, @@ -1151,7 +1151,7 @@ "properties": { "context": { "$ref": "GoogleCloudVisionV1p1beta1ImageAnnotationContext", - "description": "If present, contextual information is needed to understand where this image\ncomes from." + "description": "If present, contextual information is needed to understand where this image comes from." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p1beta1CropHintsAnnotation", @@ -1159,7 +1159,7 @@ }, "error": { "$ref": "Status", - "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." + "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set." }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", @@ -1170,7 +1170,7 @@ }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p1beta1TextAnnotation", - "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." + "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." }, "imagePropertiesAnnotation": { "$ref": "GoogleCloudVisionV1p1beta1ImageProperties", @@ -1191,7 +1191,7 @@ "type": "array" }, "localizedObjectAnnotations": { - "description": "If present, localized object detection has completed successfully.\nThis will be sorted descending by confidence score.", + "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation" }, @@ -1242,7 +1242,7 @@ "id": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, one for each request in\nAsyncBatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse" }, @@ -1277,7 +1277,7 @@ }, "boundingBox": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", @@ -1320,7 +1320,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1ColorInfo": { - "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", + "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "GoogleCloudVisionV1p1beta1ColorInfo", "properties": { "color": { @@ -1328,7 +1328,7 @@ "description": "RGB components of the color." }, "pixelFraction": { - "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", + "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" }, @@ -1346,15 +1346,15 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale." + "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { - "description": "Confidence of this being a salient region. Range [0, 1].", + "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { - "description": "Fraction of importance of this salient region with respect to the original\nimage.", + "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } @@ -1395,10 +1395,10 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." + "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "confidence": { - "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", + "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float", "type": "number" }, @@ -1407,22 +1407,22 @@ "type": "string" }, "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", + "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "locations": { - "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", + "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "GoogleCloudVisionV1p1beta1LocationInfo" }, "type": "array" }, "mid": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", + "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "properties": { - "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", + "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "items": { "$ref": "GoogleCloudVisionV1p1beta1Property" }, @@ -1434,7 +1434,7 @@ "type": "number" }, "topicality": { - "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", + "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float", "type": "number" } @@ -1487,7 +1487,7 @@ }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." + "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", @@ -1496,7 +1496,7 @@ }, "fdBoundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe fd (face detection) prefix." + "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." }, "headwearLikelihood": { "description": "Headwear likelihood.", @@ -1551,12 +1551,12 @@ "type": "array" }, "panAngle": { - "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", + "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "rollAngle": { - "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", + "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "format": "float", "type": "number" }, @@ -1601,7 +1601,7 @@ "type": "string" }, "tiltAngle": { - "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", + "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, @@ -1722,7 +1722,7 @@ "id": "GoogleCloudVisionV1p1beta1GcsDestination", "properties": { "uri": { - "description": "Google Cloud Storage URI prefix where the results will be stored. Results\nwill be in JSON format and preceded by its corresponding input URI prefix.\nThis field can either represent a gcs file prefix or gcs directory. In\neither case, the uri should be unique because in order to get all of the\noutput files, you will need to do a wildcard gcs search on the uri prefix\nyou provide.\n\nExamples:\n\n* File Prefix: gs://bucket-name/here/filenameprefix The output files\nwill be created in gs://bucket-name/here/ and the names of the\noutput files will begin with \"filenameprefix\".\n\n* Directory Prefix: gs://bucket-name/some/location/ The output files\nwill be created in gs://bucket-name/some/location/ and the names of the\noutput files could be anything because there was no filename prefix\nspecified.\n\nIf multiple outputs, each response is still AnnotateFileResponse, each of\nwhich contains some subset of the full list of AnnotateImageResponse.\nMultiple outputs can happen if, for example, the output JSON is too large\nand overflows into multiple sharded files.", + "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, @@ -1733,18 +1733,18 @@ "id": "GoogleCloudVisionV1p1beta1GcsSource", "properties": { "uri": { - "description": "Google Cloud Storage URI for the input file. This must only be a\nGoogle Cloud Storage object. Wildcards are not currently supported.", + "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p1beta1ImageAnnotationContext": { - "description": "If an image was produced from a file (e.g. a PDF), this message gives\ninformation about the source of that image.", + "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "GoogleCloudVisionV1p1beta1ImageAnnotationContext", "properties": { "pageNumber": { - "description": "If the file was a PDF or TIFF, this field gives the page number within\nthe file used to produce the image.", + "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" }, @@ -1771,7 +1771,7 @@ "id": "GoogleCloudVisionV1p1beta1InputConfig", "properties": { "content": { - "description": "File content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateFiles requests. It does\nnot work for AsyncBatchAnnotateFiles requests.", + "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "format": "byte", "type": "string" }, @@ -1780,7 +1780,7 @@ "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { - "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and\n\"image/gif\" are supported. Wildcards are not supported.", + "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } }, @@ -1795,7 +1795,7 @@ "description": "Image region to which this object belongs. This must be populated." }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -1826,7 +1826,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1NormalizedVertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the normalized vertex coordinates are relative to the original image\nand range from 0 to 1.", + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudVisionV1p1beta1NormalizedVertex", "properties": { "x": { @@ -1882,7 +1882,7 @@ "id": "GoogleCloudVisionV1p1beta1OutputConfig", "properties": { "batchSize": { - "description": "The max number of response protos to put into each output JSON file on\nGoogle Cloud Storage.\nThe valid range is [1, 100]. If not specified, the default value is 20.\n\nFor example, for one pdf file with 100 pages, 100 response protos will\nbe generated. If `batch_size` = 20, then 5 json files each\ncontaining 20 response protos will be written under the prefix\n`gcs_destination`.`uri`.\n\nCurrently, batch_size only applies to GcsDestination, with potential future\nsupport for other output configurations.", + "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, @@ -1910,7 +1910,7 @@ "type": "number" }, "height": { - "description": "Page height. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, @@ -1919,7 +1919,7 @@ "description": "Additional information detected on the page." }, "width": { - "description": "Page width. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" } @@ -1932,7 +1932,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", @@ -1954,7 +1954,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1Position": { - "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", + "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p1beta1Position", "properties": { "x": { @@ -1980,23 +1980,23 @@ "id": "GoogleCloudVisionV1p1beta1Product", "properties": { "description": { - "description": "User-provided metadata to be stored with this product. Must be at most 4096\ncharacters long.", + "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "displayName": { - "description": "The user-provided name for this Product. Must not be empty. Must be at most\n4096 characters long.", + "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { - "description": "The resource name of the product.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.\n\nThis field is ignored when creating a product.", + "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "productCategory": { - "description": "Immutable. The category for the product identified by the reference image. This should\nbe either \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\". The legacy categories\n\"homegoods\", \"apparel\", and \"toys\" are still supported, but these should\nnot be used for new products.", + "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { - "description": "Key-value pairs that can be attached to a product. At query time,\nconstraints can be specified based on the product_labels.\n\nNote that integer values can be provided as strings, e.g. \"1199\". Only\nstrings with integer values can match a range-based restriction which is\nto be supported soon.\n\nMultiple values can be assigned to the same key. One product may have up to\n500 product_labels.\n\nNotice that the total number of distinct product_labels over all products\nin one ProductSet cannot exceed 1M, otherwise the product search pipeline\nwill refuse to work for that ProductSet.", + "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.", "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductKeyValue" }, @@ -2010,11 +2010,11 @@ "id": "GoogleCloudVisionV1p1beta1ProductKeyValue", "properties": { "key": { - "description": "The key of the label attached to the product. Cannot be empty and cannot\nexceed 128 bytes.", + "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { - "description": "The value of the label attached to the product. Cannot be empty and\ncannot exceed 128 bytes.", + "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, @@ -2025,12 +2025,12 @@ "id": "GoogleCloudVisionV1p1beta1ProductSearchResults", "properties": { "indexTime": { - "description": "Timestamp of the index which provided these results. Products added to the\nproduct set and products removed from the product set after this time are\nnot reflected in the current results.", + "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime", "type": "string" }, "productGroupedResults": { - "description": "List of results grouped by products detected in the query image. Each entry\ncorresponds to one bounding polygon in the query image, and contains the\nmatching products specific to that region. There may be duplicate product\nmatches in the union of all the per-product results.", + "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult" }, @@ -2047,7 +2047,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult": { - "description": "Information about the products similar to a single product in a query\nimage.", + "description": "Information about the products similar to a single product in a query image.", "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult", "properties": { "boundingPoly": { @@ -2076,7 +2076,7 @@ "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation", "properties": { "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -2100,7 +2100,7 @@ "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult", "properties": { "image": { - "description": "The resource name of the image from the product that is the closest match\nto the query.", + "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { @@ -2108,7 +2108,7 @@ "description": "The Product." }, "score": { - "description": "A confidence level on the match, ranging from 0 (no confidence) to\n1 (full confidence).", + "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" } @@ -2136,11 +2136,11 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1SafeSearchAnnotation": { - "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", + "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation", "properties": { "adult": { - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -2180,7 +2180,7 @@ "type": "string" }, "racy": { - "description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.", + "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -2200,7 +2200,7 @@ "type": "string" }, "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -2248,7 +2248,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", @@ -2267,7 +2267,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1TextAnnotation": { - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", + "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "GoogleCloudVisionV1p1beta1TextAnnotation", "properties": { "pages": { @@ -2307,7 +2307,7 @@ "Regular space.", "Sure space (very wide).", "Line-wrapping break.", - "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", + "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" @@ -2325,7 +2325,7 @@ "type": "number" }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -2350,7 +2350,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1Vertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p1beta1Vertex", "properties": { "x": { @@ -2371,14 +2371,14 @@ "id": "GoogleCloudVisionV1p1beta1WebDetection", "properties": { "bestGuessLabels": { - "description": "The service's best guess as to the topic of the request image.\nInferred from similar images on the open web.", + "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel" }, "type": "array" }, "fullMatchingImages": { - "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", + "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, @@ -2392,7 +2392,7 @@ "type": "array" }, "partialMatchingImages": { - "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", + "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, @@ -2428,7 +2428,7 @@ "type": "string" }, "score": { - "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", + "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } @@ -2460,7 +2460,7 @@ "type": "string" }, "languageCode": { - "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -2471,7 +2471,7 @@ "id": "GoogleCloudVisionV1p1beta1WebDetectionWebPage", "properties": { "fullMatchingImages": { - "description": "Fully matching images on the page.\nCan include resized copies of the query image.", + "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, @@ -2482,7 +2482,7 @@ "type": "string" }, "partialMatchingImages": { - "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", + "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, @@ -2506,7 +2506,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", @@ -2518,7 +2518,7 @@ "description": "Additional information detected for the word." }, "symbols": { - "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", + "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "GoogleCloudVisionV1p1beta1Symbol" }, @@ -2547,7 +2547,7 @@ "description": "Required. Information about the input file." }, "pages": { - "description": "Pages of the file to perform image annotation.\n\nPages starts from 1, we assume the first page of the file is page 1.\nAt most 5 pages are supported per request. Pages can be negative.\n\nPage 1 means the first page.\nPage 2 means the second page.\nPage -1 means the last page.\nPage -2 means the second to the last page.\n\nIf the file is GIF instead of PDF or TIFF, page refers to GIF frames.\n\nIf this field is empty, by default the service performs image annotation\nfor the first 5 pages of the file.", + "description": "Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file.", "items": { "format": "int32", "type": "integer" @@ -2558,19 +2558,19 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1AnnotateFileResponse": { - "description": "Response to a single file annotation request. A file may contain one or more\nimages, which individually have their own responses.", + "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "GoogleCloudVisionV1p2beta1AnnotateFileResponse", "properties": { "error": { "$ref": "Status", - "description": "If set, represents the error message for the failed request. The\n`responses` field will not be set in this case." + "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." }, "inputConfig": { "$ref": "GoogleCloudVisionV1p2beta1InputConfig", "description": "Information about the file for which this response is generated." }, "responses": { - "description": "Individual responses to images found within the file. This field will be\nempty if the `error` field is set.", + "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "GoogleCloudVisionV1p2beta1AnnotateImageResponse" }, @@ -2585,7 +2585,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1AnnotateImageRequest": { - "description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features, and with context information.", + "description": "Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information.", "id": "GoogleCloudVisionV1p2beta1AnnotateImageRequest", "properties": { "features": { @@ -2612,7 +2612,7 @@ "properties": { "context": { "$ref": "GoogleCloudVisionV1p2beta1ImageAnnotationContext", - "description": "If present, contextual information is needed to understand where this image\ncomes from." + "description": "If present, contextual information is needed to understand where this image comes from." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p2beta1CropHintsAnnotation", @@ -2620,7 +2620,7 @@ }, "error": { "$ref": "Status", - "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." + "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set." }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", @@ -2631,7 +2631,7 @@ }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p2beta1TextAnnotation", - "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." + "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." }, "imagePropertiesAnnotation": { "$ref": "GoogleCloudVisionV1p2beta1ImageProperties", @@ -2652,7 +2652,7 @@ "type": "array" }, "localizedObjectAnnotations": { - "description": "If present, localized object detection has completed successfully.\nThis will be sorted descending by confidence score.", + "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation" }, @@ -2725,11 +2725,11 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest": { - "description": "Multiple async file annotation requests are batched into a single service\ncall.", + "description": "Multiple async file annotation requests are batched into a single service call.", "id": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest", "properties": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "requests": { @@ -2747,7 +2747,7 @@ "id": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, one for each request in\nAsyncBatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse" }, @@ -2765,7 +2765,7 @@ "description": "Required. The desired output location and metadata (e.g. format)." }, "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "requests": { @@ -2783,11 +2783,11 @@ "id": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest", "properties": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "requests": { - "description": "Required. The list of file annotation requests. Right now we support only one\nAnnotateFileRequest in BatchAnnotateFilesRequest.", + "description": "Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p2beta1AnnotateFileRequest" }, @@ -2801,7 +2801,7 @@ "id": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, each response corresponding to each\nAnnotateFileRequest in BatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p2beta1AnnotateFileResponse" }, @@ -2815,7 +2815,7 @@ "id": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest", "properties": { "parent": { - "description": "Optional. Target project and location to make a call.\n\nFormat: `projects/{project-id}/locations/{location-id}`.\n\nIf no parent is specified, a region will be chosen automatically.\n\nSupported location-ids:\n `us`: USA country only,\n `asia`: East asia areas, like Japan, Taiwan,\n `eu`: The European Union.\n\nExample: `projects/project-A/locations/eu`.", + "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "requests": { @@ -2868,7 +2868,7 @@ }, "boundingBox": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", @@ -2911,7 +2911,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1ColorInfo": { - "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", + "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "GoogleCloudVisionV1p2beta1ColorInfo", "properties": { "color": { @@ -2919,7 +2919,7 @@ "description": "RGB components of the color." }, "pixelFraction": { - "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", + "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" }, @@ -2937,15 +2937,15 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale." + "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { - "description": "Confidence of this being a salient region. Range [0, 1].", + "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { - "description": "Fraction of importance of this salient region with respect to the original\nimage.", + "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } @@ -2971,7 +2971,7 @@ "id": "GoogleCloudVisionV1p2beta1CropHintsParams", "properties": { "aspectRatios": { - "description": "Aspect ratios in floats, representing the ratio of the width to the height\nof the image. For example, if the desired aspect ratio is 4/3, the\ncorresponding float value should be 1.33333. If not specified, the\nbest possible crop is returned. The number of provided aspect ratios is\nlimited to a maximum of 16; any aspect ratios provided after the 16th are\nignored.", + "description": "Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored.", "items": { "format": "float", "type": "number" @@ -3001,10 +3001,10 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." + "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "confidence": { - "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", + "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float", "type": "number" }, @@ -3013,22 +3013,22 @@ "type": "string" }, "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", + "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "locations": { - "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", + "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "GoogleCloudVisionV1p2beta1LocationInfo" }, "type": "array" }, "mid": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", + "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "properties": { - "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", + "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "items": { "$ref": "GoogleCloudVisionV1p2beta1Property" }, @@ -3040,7 +3040,7 @@ "type": "number" }, "topicality": { - "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", + "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float", "type": "number" } @@ -3093,7 +3093,7 @@ }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." + "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", @@ -3102,7 +3102,7 @@ }, "fdBoundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe fd (face detection) prefix." + "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." }, "headwearLikelihood": { "description": "Headwear likelihood.", @@ -3157,12 +3157,12 @@ "type": "array" }, "panAngle": { - "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", + "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "rollAngle": { - "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", + "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "format": "float", "type": "number" }, @@ -3207,7 +3207,7 @@ "type": "string" }, "tiltAngle": { - "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", + "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, @@ -3324,16 +3324,16 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1Feature": { - "description": "The type of Google Cloud Vision API detection to perform, and the maximum\nnumber of results to return for that type. Multiple `Feature` objects can\nbe specified in the `features` list.", + "description": "The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list.", "id": "GoogleCloudVisionV1p2beta1Feature", "properties": { "maxResults": { - "description": "Maximum number of results of this type. Does not apply to\n`TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.", + "description": "Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.", "format": "int32", "type": "integer" }, "model": { - "description": "Model to use for the feature.\nSupported values: \"builtin/stable\" (the default if unset) and\n\"builtin/latest\".", + "description": "Model to use for the feature. Supported values: \"builtin/stable\" (the default if unset) and \"builtin/latest\".", "type": "string" }, "type": { @@ -3359,10 +3359,10 @@ "Run landmark detection.", "Run logo detection.", "Run label detection.", - "Run text detection / optical character recognition (OCR). Text detection\nis optimized for areas of text within a larger image; if the image is\na document, use `DOCUMENT_TEXT_DETECTION` instead.", - "Run dense text document OCR. Takes precedence when both\n`DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present.", - "Run Safe Search to detect potentially unsafe\nor undesirable content.", - "Compute a set of image properties, such as the\nimage's dominant colors.", + "Run text detection / optical character recognition (OCR). Text detection is optimized for areas of text within a larger image; if the image is a document, use `DOCUMENT_TEXT_DETECTION` instead.", + "Run dense text document OCR. Takes precedence when both `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present.", + "Run Safe Search to detect potentially unsafe or undesirable content.", + "Compute a set of image properties, such as the image's dominant colors.", "Run crop hints.", "Run web detection.", "Run Product Search.", @@ -3378,7 +3378,7 @@ "id": "GoogleCloudVisionV1p2beta1GcsDestination", "properties": { "uri": { - "description": "Google Cloud Storage URI prefix where the results will be stored. Results\nwill be in JSON format and preceded by its corresponding input URI prefix.\nThis field can either represent a gcs file prefix or gcs directory. In\neither case, the uri should be unique because in order to get all of the\noutput files, you will need to do a wildcard gcs search on the uri prefix\nyou provide.\n\nExamples:\n\n* File Prefix: gs://bucket-name/here/filenameprefix The output files\nwill be created in gs://bucket-name/here/ and the names of the\noutput files will begin with \"filenameprefix\".\n\n* Directory Prefix: gs://bucket-name/some/location/ The output files\nwill be created in gs://bucket-name/some/location/ and the names of the\noutput files could be anything because there was no filename prefix\nspecified.\n\nIf multiple outputs, each response is still AnnotateFileResponse, each of\nwhich contains some subset of the full list of AnnotateImageResponse.\nMultiple outputs can happen if, for example, the output JSON is too large\nand overflows into multiple sharded files.", + "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, @@ -3389,7 +3389,7 @@ "id": "GoogleCloudVisionV1p2beta1GcsSource", "properties": { "uri": { - "description": "Google Cloud Storage URI for the input file. This must only be a\nGoogle Cloud Storage object. Wildcards are not currently supported.", + "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, @@ -3400,23 +3400,23 @@ "id": "GoogleCloudVisionV1p2beta1Image", "properties": { "content": { - "description": "Image content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateImages requests. It does\nnot work for AsyncBatchAnnotateImages requests.", + "description": "Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateImages requests. It does not work for AsyncBatchAnnotateImages requests.", "format": "byte", "type": "string" }, "source": { "$ref": "GoogleCloudVisionV1p2beta1ImageSource", - "description": "Google Cloud Storage image location, or publicly-accessible image\nURL. If both `content` and `source` are provided for an image, `content`\ntakes precedence and is used to perform the image annotation request." + "description": "Google Cloud Storage image location, or publicly-accessible image URL. If both `content` and `source` are provided for an image, `content` takes precedence and is used to perform the image annotation request." } }, "type": "object" }, "GoogleCloudVisionV1p2beta1ImageAnnotationContext": { - "description": "If an image was produced from a file (e.g. a PDF), this message gives\ninformation about the source of that image.", + "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "GoogleCloudVisionV1p2beta1ImageAnnotationContext", "properties": { "pageNumber": { - "description": "If the file was a PDF or TIFF, this field gives the page number within\nthe file used to produce the image.", + "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" }, @@ -3436,7 +3436,7 @@ "description": "Parameters for crop hints annotation request." }, "languageHints": { - "description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value\nyields the best results since it enables automatic language detection. For\nlanguages based on the Latin alphabet, setting `language_hints` is not\nneeded. In rare cases, when the language of the text in the image is known,\nsetting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong). Text detection returns an\nerror if one or more of the specified languages is not one of the\n[supported languages](https://cloud.google.com/vision/docs/languages).", + "description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](https://cloud.google.com/vision/docs/languages).", "items": { "type": "string" }, @@ -3473,11 +3473,11 @@ "id": "GoogleCloudVisionV1p2beta1ImageSource", "properties": { "gcsImageUri": { - "description": "**Use `image_uri` instead.**\n\nThe Google Cloud Storage URI of the form\n`gs://bucket_name/object_name`. Object versioning is not supported. See\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris) for more info.", + "description": "**Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.", "type": "string" }, "imageUri": { - "description": "The URI of the source image. Can be either:\n\n1. A Google Cloud Storage URI of the form\n `gs://bucket_name/object_name`. Object versioning is not supported. See\n [Google Cloud Storage Request\n URIs](https://cloud.google.com/storage/docs/reference-uris) for more\n info.\n\n2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from\n HTTP/HTTPS URLs, Google cannot guarantee that the request will be\n completed. Your request may fail if the specified host denies the\n request (e.g. due to request throttling or DOS prevention), or if Google\n throttles requests to the site for abuse prevention. You should not\n depend on externally-hosted images for production applications.\n\nWhen both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes\nprecedence.", + "description": "The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence.", "type": "string" } }, @@ -3488,7 +3488,7 @@ "id": "GoogleCloudVisionV1p2beta1InputConfig", "properties": { "content": { - "description": "File content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateFiles requests. It does\nnot work for AsyncBatchAnnotateFiles requests.", + "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "format": "byte", "type": "string" }, @@ -3497,7 +3497,7 @@ "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { - "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and\n\"image/gif\" are supported. Wildcards are not supported.", + "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } }, @@ -3527,7 +3527,7 @@ "description": "Image region to which this object belongs. This must be populated." }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -3558,7 +3558,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1NormalizedVertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the normalized vertex coordinates are relative to the original image\nand range from 0 to 1.", + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudVisionV1p2beta1NormalizedVertex", "properties": { "x": { @@ -3614,7 +3614,7 @@ "id": "GoogleCloudVisionV1p2beta1OutputConfig", "properties": { "batchSize": { - "description": "The max number of response protos to put into each output JSON file on\nGoogle Cloud Storage.\nThe valid range is [1, 100]. If not specified, the default value is 20.\n\nFor example, for one pdf file with 100 pages, 100 response protos will\nbe generated. If `batch_size` = 20, then 5 json files each\ncontaining 20 response protos will be written under the prefix\n`gcs_destination`.`uri`.\n\nCurrently, batch_size only applies to GcsDestination, with potential future\nsupport for other output configurations.", + "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, @@ -3642,7 +3642,7 @@ "type": "number" }, "height": { - "description": "Page height. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, @@ -3651,7 +3651,7 @@ "description": "Additional information detected on the page." }, "width": { - "description": "Page width. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" } @@ -3664,7 +3664,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", @@ -3686,7 +3686,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1Position": { - "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", + "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p2beta1Position", "properties": { "x": { @@ -3712,23 +3712,23 @@ "id": "GoogleCloudVisionV1p2beta1Product", "properties": { "description": { - "description": "User-provided metadata to be stored with this product. Must be at most 4096\ncharacters long.", + "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "displayName": { - "description": "The user-provided name for this Product. Must not be empty. Must be at most\n4096 characters long.", + "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { - "description": "The resource name of the product.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.\n\nThis field is ignored when creating a product.", + "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "productCategory": { - "description": "Immutable. The category for the product identified by the reference image. This should\nbe either \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\". The legacy categories\n\"homegoods\", \"apparel\", and \"toys\" are still supported, but these should\nnot be used for new products.", + "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { - "description": "Key-value pairs that can be attached to a product. At query time,\nconstraints can be specified based on the product_labels.\n\nNote that integer values can be provided as strings, e.g. \"1199\". Only\nstrings with integer values can match a range-based restriction which is\nto be supported soon.\n\nMultiple values can be assigned to the same key. One product may have up to\n500 product_labels.\n\nNotice that the total number of distinct product_labels over all products\nin one ProductSet cannot exceed 1M, otherwise the product search pipeline\nwill refuse to work for that ProductSet.", + "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.", "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductKeyValue" }, @@ -3742,11 +3742,11 @@ "id": "GoogleCloudVisionV1p2beta1ProductKeyValue", "properties": { "key": { - "description": "The key of the label attached to the product. Cannot be empty and cannot\nexceed 128 bytes.", + "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { - "description": "The value of the label attached to the product. Cannot be empty and\ncannot exceed 128 bytes.", + "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, @@ -3758,21 +3758,21 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding polygon around the area of interest in the image.\nIf it is not specified, system discretion will be applied." + "description": "The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied." }, "filter": { - "description": "The filtering expression. This can be used to restrict search results based\non Product labels. We currently support an AND of OR of key-value\nexpressions, where each expression within an OR must have the same key. An\n'=' should be used to connect the key and value.\n\nFor example, \"(color = red OR color = blue) AND brand = Google\" is\nacceptable, but \"(color = red OR brand = Google)\" is not acceptable.\n\"color: red\" is not acceptable because it uses a ':' instead of an '='.", + "description": "The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, \"(color = red OR color = blue) AND brand = Google\" is acceptable, but \"(color = red OR brand = Google)\" is not acceptable. \"color: red\" is not acceptable because it uses a ':' instead of an '='.", "type": "string" }, "productCategories": { - "description": "The list of product categories to search in. Currently, we only consider\nthe first category, and either \"homegoods-v2\", \"apparel-v2\", \"toys-v2\",\n\"packagedgoods-v1\", or \"general-v1\" should be specified. The legacy\ncategories \"homegoods\", \"apparel\", and \"toys\" are still supported but will\nbe deprecated. For new products, please use \"homegoods-v2\", \"apparel-v2\",\nor \"toys-v2\" for better product search accuracy. It is recommended to\nmigrate existing products to these categories as well.", + "description": "The list of product categories to search in. Currently, we only consider the first category, and either \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\", or \"general-v1\" should be specified. The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported but will be deprecated. For new products, please use \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\" for better product search accuracy. It is recommended to migrate existing products to these categories as well.", "items": { "type": "string" }, "type": "array" }, "productSet": { - "description": "The resource name of a ProductSet to be searched for similar images.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.", + "description": "The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.", "type": "string" } }, @@ -3783,12 +3783,12 @@ "id": "GoogleCloudVisionV1p2beta1ProductSearchResults", "properties": { "indexTime": { - "description": "Timestamp of the index which provided these results. Products added to the\nproduct set and products removed from the product set after this time are\nnot reflected in the current results.", + "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime", "type": "string" }, "productGroupedResults": { - "description": "List of results grouped by products detected in the query image. Each entry\ncorresponds to one bounding polygon in the query image, and contains the\nmatching products specific to that region. There may be duplicate product\nmatches in the union of all the per-product results.", + "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult" }, @@ -3805,7 +3805,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult": { - "description": "Information about the products similar to a single product in a query\nimage.", + "description": "Information about the products similar to a single product in a query image.", "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult", "properties": { "boundingPoly": { @@ -3834,7 +3834,7 @@ "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation", "properties": { "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -3858,7 +3858,7 @@ "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsResult", "properties": { "image": { - "description": "The resource name of the image from the product that is the closest match\nto the query.", + "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { @@ -3866,7 +3866,7 @@ "description": "The Product." }, "score": { - "description": "A confidence level on the match, ranging from 0 (no confidence) to\n1 (full confidence).", + "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" } @@ -3894,11 +3894,11 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1SafeSearchAnnotation": { - "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", + "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "GoogleCloudVisionV1p2beta1SafeSearchAnnotation", "properties": { "adult": { - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -3938,7 +3938,7 @@ "type": "string" }, "racy": { - "description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.", + "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -3958,7 +3958,7 @@ "type": "string" }, "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -4006,7 +4006,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", @@ -4025,7 +4025,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1TextAnnotation": { - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", + "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "GoogleCloudVisionV1p2beta1TextAnnotation", "properties": { "pages": { @@ -4065,7 +4065,7 @@ "Regular space.", "Sure space (very wide).", "Line-wrapping break.", - "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", + "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" @@ -4083,7 +4083,7 @@ "type": "number" }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -4108,7 +4108,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1Vertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p2beta1Vertex", "properties": { "x": { @@ -4129,14 +4129,14 @@ "id": "GoogleCloudVisionV1p2beta1WebDetection", "properties": { "bestGuessLabels": { - "description": "The service's best guess as to the topic of the request image.\nInferred from similar images on the open web.", + "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebLabel" }, "type": "array" }, "fullMatchingImages": { - "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", + "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, @@ -4150,7 +4150,7 @@ "type": "array" }, "partialMatchingImages": { - "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", + "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, @@ -4197,7 +4197,7 @@ "type": "string" }, "score": { - "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", + "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } @@ -4229,7 +4229,7 @@ "type": "string" }, "languageCode": { - "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -4240,7 +4240,7 @@ "id": "GoogleCloudVisionV1p2beta1WebDetectionWebPage", "properties": { "fullMatchingImages": { - "description": "Fully matching images on the page.\nCan include resized copies of the query image.", + "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, @@ -4251,7 +4251,7 @@ "type": "string" }, "partialMatchingImages": { - "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", + "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, @@ -4275,7 +4275,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", @@ -4287,7 +4287,7 @@ "description": "Additional information detected for the word." }, "symbols": { - "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", + "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "GoogleCloudVisionV1p2beta1Symbol" }, @@ -4297,19 +4297,19 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1AnnotateFileResponse": { - "description": "Response to a single file annotation request. A file may contain one or more\nimages, which individually have their own responses.", + "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "GoogleCloudVisionV1p3beta1AnnotateFileResponse", "properties": { "error": { "$ref": "Status", - "description": "If set, represents the error message for the failed request. The\n`responses` field will not be set in this case." + "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." }, "inputConfig": { "$ref": "GoogleCloudVisionV1p3beta1InputConfig", "description": "Information about the file for which this response is generated." }, "responses": { - "description": "Individual responses to images found within the file. This field will be\nempty if the `error` field is set.", + "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "GoogleCloudVisionV1p3beta1AnnotateImageResponse" }, @@ -4329,7 +4329,7 @@ "properties": { "context": { "$ref": "GoogleCloudVisionV1p3beta1ImageAnnotationContext", - "description": "If present, contextual information is needed to understand where this image\ncomes from." + "description": "If present, contextual information is needed to understand where this image comes from." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p3beta1CropHintsAnnotation", @@ -4337,7 +4337,7 @@ }, "error": { "$ref": "Status", - "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." + "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set." }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", @@ -4348,7 +4348,7 @@ }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p3beta1TextAnnotation", - "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." + "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." }, "imagePropertiesAnnotation": { "$ref": "GoogleCloudVisionV1p3beta1ImageProperties", @@ -4369,7 +4369,7 @@ "type": "array" }, "localizedObjectAnnotations": { - "description": "If present, localized object detection has completed successfully.\nThis will be sorted descending by confidence score.", + "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation" }, @@ -4420,7 +4420,7 @@ "id": "GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, one for each request in\nAsyncBatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse" }, @@ -4430,11 +4430,11 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1BatchOperationMetadata": { - "description": "Metadata for the batch operations such as the current state.\n\nThis is included in the `metadata` field of the `Operation` returned by the\n`GetOperation` call of the `google::longrunning::Operations` service.", + "description": "Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.", "id": "GoogleCloudVisionV1p3beta1BatchOperationMetadata", "properties": { "endTime": { - "description": "The time when the batch request is finished and\ngoogle.longrunning.Operation.done is set to true.", + "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.", "format": "google-datetime", "type": "string" }, @@ -4450,9 +4450,9 @@ "enumDescriptions": [ "Invalid.", "Request is actively being processed.", - "The request is done and at least one item has been successfully\nprocessed.", + "The request is done and at least one item has been successfully processed.", "The request is done and no item has been successfully processed.", - "The request is done after the longrunning.Operations.CancelOperation has\nbeen called by the user. Any records that were processed before the\ncancel command are output as specified in the request." + "The request is done after the longrunning.Operations.CancelOperation has been called by the user. Any records that were processed before the cancel command are output as specified in the request." ], "type": "string" }, @@ -4490,7 +4490,7 @@ }, "boundingBox": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", @@ -4533,7 +4533,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1ColorInfo": { - "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", + "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "GoogleCloudVisionV1p3beta1ColorInfo", "properties": { "color": { @@ -4541,7 +4541,7 @@ "description": "RGB components of the color." }, "pixelFraction": { - "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", + "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" }, @@ -4559,15 +4559,15 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale." + "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { - "description": "Confidence of this being a salient region. Range [0, 1].", + "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { - "description": "Fraction of importance of this salient region with respect to the original\nimage.", + "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } @@ -4608,10 +4608,10 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." + "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "confidence": { - "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", + "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float", "type": "number" }, @@ -4620,22 +4620,22 @@ "type": "string" }, "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", + "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "locations": { - "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", + "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "GoogleCloudVisionV1p3beta1LocationInfo" }, "type": "array" }, "mid": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", + "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "properties": { - "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", + "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "items": { "$ref": "GoogleCloudVisionV1p3beta1Property" }, @@ -4647,7 +4647,7 @@ "type": "number" }, "topicality": { - "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", + "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float", "type": "number" } @@ -4700,7 +4700,7 @@ }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." + "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", @@ -4709,7 +4709,7 @@ }, "fdBoundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe fd (face detection) prefix." + "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." }, "headwearLikelihood": { "description": "Headwear likelihood.", @@ -4764,12 +4764,12 @@ "type": "array" }, "panAngle": { - "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", + "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "rollAngle": { - "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", + "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "format": "float", "type": "number" }, @@ -4814,7 +4814,7 @@ "type": "string" }, "tiltAngle": { - "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", + "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, @@ -4935,7 +4935,7 @@ "id": "GoogleCloudVisionV1p3beta1GcsDestination", "properties": { "uri": { - "description": "Google Cloud Storage URI prefix where the results will be stored. Results\nwill be in JSON format and preceded by its corresponding input URI prefix.\nThis field can either represent a gcs file prefix or gcs directory. In\neither case, the uri should be unique because in order to get all of the\noutput files, you will need to do a wildcard gcs search on the uri prefix\nyou provide.\n\nExamples:\n\n* File Prefix: gs://bucket-name/here/filenameprefix The output files\nwill be created in gs://bucket-name/here/ and the names of the\noutput files will begin with \"filenameprefix\".\n\n* Directory Prefix: gs://bucket-name/some/location/ The output files\nwill be created in gs://bucket-name/some/location/ and the names of the\noutput files could be anything because there was no filename prefix\nspecified.\n\nIf multiple outputs, each response is still AnnotateFileResponse, each of\nwhich contains some subset of the full list of AnnotateImageResponse.\nMultiple outputs can happen if, for example, the output JSON is too large\nand overflows into multiple sharded files.", + "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, @@ -4946,18 +4946,18 @@ "id": "GoogleCloudVisionV1p3beta1GcsSource", "properties": { "uri": { - "description": "Google Cloud Storage URI for the input file. This must only be a\nGoogle Cloud Storage object. Wildcards are not currently supported.", + "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p3beta1ImageAnnotationContext": { - "description": "If an image was produced from a file (e.g. a PDF), this message gives\ninformation about the source of that image.", + "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "GoogleCloudVisionV1p3beta1ImageAnnotationContext", "properties": { "pageNumber": { - "description": "If the file was a PDF or TIFF, this field gives the page number within\nthe file used to produce the image.", + "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" }, @@ -4980,7 +4980,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1ImportProductSetsResponse": { - "description": "Response message for the `ImportProductSets` method.\n\nThis message is returned by the\ngoogle.longrunning.Operations.GetOperation method in the returned\ngoogle.longrunning.Operation.response field.", + "description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.", "id": "GoogleCloudVisionV1p3beta1ImportProductSetsResponse", "properties": { "referenceImages": { @@ -4991,7 +4991,7 @@ "type": "array" }, "statuses": { - "description": "The rpc status for each ImportProductSet request, including both successes\nand errors.\n\nThe number of statuses here matches the number of lines in the csv file,\nand statuses[i] stores the success or failure status of processing the i-th\nline of the csv, starting from line 0.", + "description": "The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.", "items": { "$ref": "Status" }, @@ -5005,7 +5005,7 @@ "id": "GoogleCloudVisionV1p3beta1InputConfig", "properties": { "content": { - "description": "File content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateFiles requests. It does\nnot work for AsyncBatchAnnotateFiles requests.", + "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "format": "byte", "type": "string" }, @@ -5014,7 +5014,7 @@ "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { - "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and\n\"image/gif\" are supported. Wildcards are not supported.", + "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } }, @@ -5029,7 +5029,7 @@ "description": "Image region to which this object belongs. This must be populated." }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -5060,7 +5060,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1NormalizedVertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the normalized vertex coordinates are relative to the original image\nand range from 0 to 1.", + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudVisionV1p3beta1NormalizedVertex", "properties": { "x": { @@ -5116,7 +5116,7 @@ "id": "GoogleCloudVisionV1p3beta1OutputConfig", "properties": { "batchSize": { - "description": "The max number of response protos to put into each output JSON file on\nGoogle Cloud Storage.\nThe valid range is [1, 100]. If not specified, the default value is 20.\n\nFor example, for one pdf file with 100 pages, 100 response protos will\nbe generated. If `batch_size` = 20, then 5 json files each\ncontaining 20 response protos will be written under the prefix\n`gcs_destination`.`uri`.\n\nCurrently, batch_size only applies to GcsDestination, with potential future\nsupport for other output configurations.", + "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, @@ -5144,7 +5144,7 @@ "type": "number" }, "height": { - "description": "Page height. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, @@ -5153,7 +5153,7 @@ "description": "Additional information detected on the page." }, "width": { - "description": "Page width. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" } @@ -5166,7 +5166,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", @@ -5188,7 +5188,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1Position": { - "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", + "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p3beta1Position", "properties": { "x": { @@ -5214,23 +5214,23 @@ "id": "GoogleCloudVisionV1p3beta1Product", "properties": { "description": { - "description": "User-provided metadata to be stored with this product. Must be at most 4096\ncharacters long.", + "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "displayName": { - "description": "The user-provided name for this Product. Must not be empty. Must be at most\n4096 characters long.", + "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { - "description": "The resource name of the product.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.\n\nThis field is ignored when creating a product.", + "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "productCategory": { - "description": "Immutable. The category for the product identified by the reference image. This should\nbe either \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\". The legacy categories\n\"homegoods\", \"apparel\", and \"toys\" are still supported, but these should\nnot be used for new products.", + "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { - "description": "Key-value pairs that can be attached to a product. At query time,\nconstraints can be specified based on the product_labels.\n\nNote that integer values can be provided as strings, e.g. \"1199\". Only\nstrings with integer values can match a range-based restriction which is\nto be supported soon.\n\nMultiple values can be assigned to the same key. One product may have up to\n500 product_labels.\n\nNotice that the total number of distinct product_labels over all products\nin one ProductSet cannot exceed 1M, otherwise the product search pipeline\nwill refuse to work for that ProductSet.", + "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.", "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductKeyValue" }, @@ -5244,11 +5244,11 @@ "id": "GoogleCloudVisionV1p3beta1ProductKeyValue", "properties": { "key": { - "description": "The key of the label attached to the product. Cannot be empty and cannot\nexceed 128 bytes.", + "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { - "description": "The value of the label attached to the product. Cannot be empty and\ncannot exceed 128 bytes.", + "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, @@ -5259,12 +5259,12 @@ "id": "GoogleCloudVisionV1p3beta1ProductSearchResults", "properties": { "indexTime": { - "description": "Timestamp of the index which provided these results. Products added to the\nproduct set and products removed from the product set after this time are\nnot reflected in the current results.", + "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime", "type": "string" }, "productGroupedResults": { - "description": "List of results grouped by products detected in the query image. Each entry\ncorresponds to one bounding polygon in the query image, and contains the\nmatching products specific to that region. There may be duplicate product\nmatches in the union of all the per-product results.", + "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult" }, @@ -5281,7 +5281,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult": { - "description": "Information about the products similar to a single product in a query\nimage.", + "description": "Information about the products similar to a single product in a query image.", "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult", "properties": { "boundingPoly": { @@ -5310,7 +5310,7 @@ "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation", "properties": { "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -5334,7 +5334,7 @@ "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsResult", "properties": { "image": { - "description": "The resource name of the image from the product that is the closest match\nto the query.", + "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { @@ -5342,7 +5342,7 @@ "description": "The Product." }, "score": { - "description": "A confidence level on the match, ranging from 0 (no confidence) to\n1 (full confidence).", + "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" } @@ -5370,33 +5370,33 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1ReferenceImage": { - "description": "A `ReferenceImage` represents a product image and its associated metadata,\nsuch as bounding boxes.", + "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.", "id": "GoogleCloudVisionV1p3beta1ReferenceImage", "properties": { "boundingPolys": { - "description": "Optional. Bounding polygons around the areas of interest in the reference image.\nIf this field is empty, the system will try to detect regions of\ninterest. At most 10 bounding polygons will be used.\n\nThe provided shape is converted into a non-rotated rectangle. Once\nconverted, the small edge of the rectangle must be greater than or equal\nto 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5\nis not).", + "description": "Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).", "items": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "type": "array" }, "name": { - "description": "The resource name of the reference image.\n\nFormat is:\n\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.\n\nThis field is ignored when creating a reference image.", + "description": "The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.", "type": "string" }, "uri": { - "description": "Required. The Google Cloud Storage URI of the reference image.\n\nThe URI must start with `gs://`.", + "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p3beta1SafeSearchAnnotation": { - "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", + "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "GoogleCloudVisionV1p3beta1SafeSearchAnnotation", "properties": { "adult": { - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -5436,7 +5436,7 @@ "type": "string" }, "racy": { - "description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.", + "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -5456,7 +5456,7 @@ "type": "string" }, "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -5504,7 +5504,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", @@ -5523,7 +5523,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1TextAnnotation": { - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", + "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "GoogleCloudVisionV1p3beta1TextAnnotation", "properties": { "pages": { @@ -5563,7 +5563,7 @@ "Regular space.", "Sure space (very wide).", "Line-wrapping break.", - "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", + "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" @@ -5581,7 +5581,7 @@ "type": "number" }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -5606,7 +5606,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1Vertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p3beta1Vertex", "properties": { "x": { @@ -5627,14 +5627,14 @@ "id": "GoogleCloudVisionV1p3beta1WebDetection", "properties": { "bestGuessLabels": { - "description": "The service's best guess as to the topic of the request image.\nInferred from similar images on the open web.", + "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebLabel" }, "type": "array" }, "fullMatchingImages": { - "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", + "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, @@ -5648,7 +5648,7 @@ "type": "array" }, "partialMatchingImages": { - "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", + "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, @@ -5684,7 +5684,7 @@ "type": "string" }, "score": { - "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", + "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } @@ -5716,7 +5716,7 @@ "type": "string" }, "languageCode": { - "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -5727,7 +5727,7 @@ "id": "GoogleCloudVisionV1p3beta1WebDetectionWebPage", "properties": { "fullMatchingImages": { - "description": "Fully matching images on the page.\nCan include resized copies of the query image.", + "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, @@ -5738,7 +5738,7 @@ "type": "string" }, "partialMatchingImages": { - "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", + "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, @@ -5762,7 +5762,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", @@ -5774,7 +5774,7 @@ "description": "Additional information detected for the word." }, "symbols": { - "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", + "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "GoogleCloudVisionV1p3beta1Symbol" }, @@ -5784,19 +5784,19 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1AnnotateFileResponse": { - "description": "Response to a single file annotation request. A file may contain one or more\nimages, which individually have their own responses.", + "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "GoogleCloudVisionV1p4beta1AnnotateFileResponse", "properties": { "error": { "$ref": "Status", - "description": "If set, represents the error message for the failed request. The\n`responses` field will not be set in this case." + "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." }, "inputConfig": { "$ref": "GoogleCloudVisionV1p4beta1InputConfig", "description": "Information about the file for which this response is generated." }, "responses": { - "description": "Individual responses to images found within the file. This field will be\nempty if the `error` field is set.", + "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "GoogleCloudVisionV1p4beta1AnnotateImageResponse" }, @@ -5816,7 +5816,7 @@ "properties": { "context": { "$ref": "GoogleCloudVisionV1p4beta1ImageAnnotationContext", - "description": "If present, contextual information is needed to understand where this image\ncomes from." + "description": "If present, contextual information is needed to understand where this image comes from." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p4beta1CropHintsAnnotation", @@ -5824,7 +5824,7 @@ }, "error": { "$ref": "Status", - "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." + "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set." }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", @@ -5835,7 +5835,7 @@ }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p4beta1TextAnnotation", - "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." + "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." }, "imagePropertiesAnnotation": { "$ref": "GoogleCloudVisionV1p4beta1ImageProperties", @@ -5856,7 +5856,7 @@ "type": "array" }, "localizedObjectAnnotations": { - "description": "If present, localized object detection has completed successfully.\nThis will be sorted descending by confidence score.", + "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation" }, @@ -5907,7 +5907,7 @@ "id": "GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, one for each request in\nAsyncBatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse" }, @@ -5932,7 +5932,7 @@ "id": "GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse", "properties": { "responses": { - "description": "The list of file annotation responses, each response corresponding to each\nAnnotateFileRequest in BatchAnnotateFilesRequest.", + "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p4beta1AnnotateFileResponse" }, @@ -5942,11 +5942,11 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1BatchOperationMetadata": { - "description": "Metadata for the batch operations such as the current state.\n\nThis is included in the `metadata` field of the `Operation` returned by the\n`GetOperation` call of the `google::longrunning::Operations` service.", + "description": "Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.", "id": "GoogleCloudVisionV1p4beta1BatchOperationMetadata", "properties": { "endTime": { - "description": "The time when the batch request is finished and\ngoogle.longrunning.Operation.done is set to true.", + "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.", "format": "google-datetime", "type": "string" }, @@ -5962,9 +5962,9 @@ "enumDescriptions": [ "Invalid.", "Request is actively being processed.", - "The request is done and at least one item has been successfully\nprocessed.", + "The request is done and at least one item has been successfully processed.", "The request is done and no item has been successfully processed.", - "The request is done after the longrunning.Operations.CancelOperation has\nbeen called by the user. Any records that were processed before the\ncancel command are output as specified in the request." + "The request is done after the longrunning.Operations.CancelOperation has been called by the user. Any records that were processed before the cancel command are output as specified in the request." ], "type": "string" }, @@ -6002,7 +6002,7 @@ }, "boundingBox": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", @@ -6057,14 +6057,14 @@ "type": "string" }, "name": { - "description": "The resource name of the preloaded Celebrity. Has the format\n`builtin/{mid}`.", + "description": "The resource name of the preloaded Celebrity. Has the format `builtin/{mid}`.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1ColorInfo": { - "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", + "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "GoogleCloudVisionV1p4beta1ColorInfo", "properties": { "color": { @@ -6072,7 +6072,7 @@ "description": "RGB components of the color." }, "pixelFraction": { - "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", + "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" }, @@ -6090,15 +6090,15 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale." + "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { - "description": "Confidence of this being a salient region. Range [0, 1].", + "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { - "description": "Fraction of importance of this salient region with respect to the original\nimage.", + "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } @@ -6139,10 +6139,10 @@ "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." + "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "confidence": { - "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", + "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float", "type": "number" }, @@ -6151,22 +6151,22 @@ "type": "string" }, "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", + "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "locations": { - "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", + "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "GoogleCloudVisionV1p4beta1LocationInfo" }, "type": "array" }, "mid": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", + "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "properties": { - "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", + "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "items": { "$ref": "GoogleCloudVisionV1p4beta1Property" }, @@ -6178,7 +6178,7 @@ "type": "number" }, "topicality": { - "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", + "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float", "type": "number" } @@ -6231,7 +6231,7 @@ }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." + "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", @@ -6240,7 +6240,7 @@ }, "fdBoundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe fd (face detection) prefix." + "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." }, "headwearLikelihood": { "description": "Headwear likelihood.", @@ -6295,19 +6295,19 @@ "type": "array" }, "panAngle": { - "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", + "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "recognitionResult": { - "description": "Additional recognition information. Only computed if\nimage_context.face_recognition_params is provided, **and** a match is found\nto a Celebrity in the input CelebritySet. This field is\nsorted in order of decreasing confidence values.", + "description": "Additional recognition information. Only computed if image_context.face_recognition_params is provided, **and** a match is found to a Celebrity in the input CelebritySet. This field is sorted in order of decreasing confidence values.", "items": { "$ref": "GoogleCloudVisionV1p4beta1FaceRecognitionResult" }, "type": "array" }, "rollAngle": { - "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", + "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "format": "float", "type": "number" }, @@ -6352,7 +6352,7 @@ "type": "string" }, "tiltAngle": { - "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", + "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, @@ -6489,7 +6489,7 @@ "id": "GoogleCloudVisionV1p4beta1GcsDestination", "properties": { "uri": { - "description": "Google Cloud Storage URI prefix where the results will be stored. Results\nwill be in JSON format and preceded by its corresponding input URI prefix.\nThis field can either represent a gcs file prefix or gcs directory. In\neither case, the uri should be unique because in order to get all of the\noutput files, you will need to do a wildcard gcs search on the uri prefix\nyou provide.\n\nExamples:\n\n* File Prefix: gs://bucket-name/here/filenameprefix The output files\nwill be created in gs://bucket-name/here/ and the names of the\noutput files will begin with \"filenameprefix\".\n\n* Directory Prefix: gs://bucket-name/some/location/ The output files\nwill be created in gs://bucket-name/some/location/ and the names of the\noutput files could be anything because there was no filename prefix\nspecified.\n\nIf multiple outputs, each response is still AnnotateFileResponse, each of\nwhich contains some subset of the full list of AnnotateImageResponse.\nMultiple outputs can happen if, for example, the output JSON is too large\nand overflows into multiple sharded files.", + "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, @@ -6500,18 +6500,18 @@ "id": "GoogleCloudVisionV1p4beta1GcsSource", "properties": { "uri": { - "description": "Google Cloud Storage URI for the input file. This must only be a\nGoogle Cloud Storage object. Wildcards are not currently supported.", + "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1ImageAnnotationContext": { - "description": "If an image was produced from a file (e.g. a PDF), this message gives\ninformation about the source of that image.", + "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "GoogleCloudVisionV1p4beta1ImageAnnotationContext", "properties": { "pageNumber": { - "description": "If the file was a PDF or TIFF, this field gives the page number within\nthe file used to produce the image.", + "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" }, @@ -6534,7 +6534,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1ImportProductSetsResponse": { - "description": "Response message for the `ImportProductSets` method.\n\nThis message is returned by the\ngoogle.longrunning.Operations.GetOperation method in the returned\ngoogle.longrunning.Operation.response field.", + "description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.", "id": "GoogleCloudVisionV1p4beta1ImportProductSetsResponse", "properties": { "referenceImages": { @@ -6545,7 +6545,7 @@ "type": "array" }, "statuses": { - "description": "The rpc status for each ImportProductSet request, including both successes\nand errors.\n\nThe number of statuses here matches the number of lines in the csv file,\nand statuses[i] stores the success or failure status of processing the i-th\nline of the csv, starting from line 0.", + "description": "The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.", "items": { "$ref": "Status" }, @@ -6559,7 +6559,7 @@ "id": "GoogleCloudVisionV1p4beta1InputConfig", "properties": { "content": { - "description": "File content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateFiles requests. It does\nnot work for AsyncBatchAnnotateFiles requests.", + "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "format": "byte", "type": "string" }, @@ -6568,7 +6568,7 @@ "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { - "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and\n\"image/gif\" are supported. Wildcards are not supported.", + "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } }, @@ -6583,7 +6583,7 @@ "description": "Image region to which this object belongs. This must be populated." }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -6614,7 +6614,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1NormalizedVertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the normalized vertex coordinates are relative to the original image\nand range from 0 to 1.", + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudVisionV1p4beta1NormalizedVertex", "properties": { "x": { @@ -6670,7 +6670,7 @@ "id": "GoogleCloudVisionV1p4beta1OutputConfig", "properties": { "batchSize": { - "description": "The max number of response protos to put into each output JSON file on\nGoogle Cloud Storage.\nThe valid range is [1, 100]. If not specified, the default value is 20.\n\nFor example, for one pdf file with 100 pages, 100 response protos will\nbe generated. If `batch_size` = 20, then 5 json files each\ncontaining 20 response protos will be written under the prefix\n`gcs_destination`.`uri`.\n\nCurrently, batch_size only applies to GcsDestination, with potential future\nsupport for other output configurations.", + "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, @@ -6698,7 +6698,7 @@ "type": "number" }, "height": { - "description": "Page height. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, @@ -6707,7 +6707,7 @@ "description": "Additional information detected on the page." }, "width": { - "description": "Page width. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" } @@ -6720,7 +6720,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", @@ -6742,7 +6742,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1Position": { - "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", + "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p4beta1Position", "properties": { "x": { @@ -6768,23 +6768,23 @@ "id": "GoogleCloudVisionV1p4beta1Product", "properties": { "description": { - "description": "User-provided metadata to be stored with this product. Must be at most 4096\ncharacters long.", + "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "displayName": { - "description": "The user-provided name for this Product. Must not be empty. Must be at most\n4096 characters long.", + "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { - "description": "The resource name of the product.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.\n\nThis field is ignored when creating a product.", + "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "productCategory": { - "description": "Immutable. The category for the product identified by the reference image. This should\nbe either \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\". The legacy categories\n\"homegoods\", \"apparel\", and \"toys\" are still supported, but these should\nnot be used for new products.", + "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { - "description": "Key-value pairs that can be attached to a product. At query time,\nconstraints can be specified based on the product_labels.\n\nNote that integer values can be provided as strings, e.g. \"1199\". Only\nstrings with integer values can match a range-based restriction which is\nto be supported soon.\n\nMultiple values can be assigned to the same key. One product may have up to\n500 product_labels.\n\nNotice that the total number of distinct product_labels over all products\nin one ProductSet cannot exceed 1M, otherwise the product search pipeline\nwill refuse to work for that ProductSet.", + "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductKeyValue" }, @@ -6798,11 +6798,11 @@ "id": "GoogleCloudVisionV1p4beta1ProductKeyValue", "properties": { "key": { - "description": "The key of the label attached to the product. Cannot be empty and cannot\nexceed 128 bytes.", + "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { - "description": "The value of the label attached to the product. Cannot be empty and\ncannot exceed 128 bytes.", + "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, @@ -6813,12 +6813,12 @@ "id": "GoogleCloudVisionV1p4beta1ProductSearchResults", "properties": { "indexTime": { - "description": "Timestamp of the index which provided these results. Products added to the\nproduct set and products removed from the product set after this time are\nnot reflected in the current results.", + "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime", "type": "string" }, "productGroupedResults": { - "description": "List of results grouped by products detected in the query image. Each entry\ncorresponds to one bounding polygon in the query image, and contains the\nmatching products specific to that region. There may be duplicate product\nmatches in the union of all the per-product results.", + "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult" }, @@ -6835,7 +6835,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult": { - "description": "Information about the products similar to a single product in a query\nimage.", + "description": "Information about the products similar to a single product in a query image.", "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult", "properties": { "boundingPoly": { @@ -6864,7 +6864,7 @@ "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation", "properties": { "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -6888,7 +6888,7 @@ "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsResult", "properties": { "image": { - "description": "The resource name of the image from the product that is the closest match\nto the query.", + "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { @@ -6896,7 +6896,7 @@ "description": "The Product." }, "score": { - "description": "A confidence level on the match, ranging from 0 (no confidence) to\n1 (full confidence).", + "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" } @@ -6924,33 +6924,33 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1ReferenceImage": { - "description": "A `ReferenceImage` represents a product image and its associated metadata,\nsuch as bounding boxes.", + "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.", "id": "GoogleCloudVisionV1p4beta1ReferenceImage", "properties": { "boundingPolys": { - "description": "Optional. Bounding polygons around the areas of interest in the reference image.\nIf this field is empty, the system will try to detect regions of\ninterest. At most 10 bounding polygons will be used.\n\nThe provided shape is converted into a non-rotated rectangle. Once\nconverted, the small edge of the rectangle must be greater than or equal\nto 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5\nis not).", + "description": "Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).", "items": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "type": "array" }, "name": { - "description": "The resource name of the reference image.\n\nFormat is:\n\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.\n\nThis field is ignored when creating a reference image.", + "description": "The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.", "type": "string" }, "uri": { - "description": "Required. The Google Cloud Storage URI of the reference image.\n\nThe URI must start with `gs://`.", + "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1SafeSearchAnnotation": { - "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", + "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "GoogleCloudVisionV1p4beta1SafeSearchAnnotation", "properties": { "adult": { - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -6990,7 +6990,7 @@ "type": "string" }, "racy": { - "description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.", + "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -7010,7 +7010,7 @@ "type": "string" }, "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -7058,7 +7058,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", @@ -7077,7 +7077,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1TextAnnotation": { - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", + "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "GoogleCloudVisionV1p4beta1TextAnnotation", "properties": { "pages": { @@ -7117,7 +7117,7 @@ "Regular space.", "Sure space (very wide).", "Line-wrapping break.", - "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", + "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" @@ -7135,7 +7135,7 @@ "type": "number" }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -7160,7 +7160,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1Vertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p4beta1Vertex", "properties": { "x": { @@ -7181,14 +7181,14 @@ "id": "GoogleCloudVisionV1p4beta1WebDetection", "properties": { "bestGuessLabels": { - "description": "The service's best guess as to the topic of the request image.\nInferred from similar images on the open web.", + "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebLabel" }, "type": "array" }, "fullMatchingImages": { - "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", + "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, @@ -7202,7 +7202,7 @@ "type": "array" }, "partialMatchingImages": { - "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", + "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, @@ -7238,7 +7238,7 @@ "type": "string" }, "score": { - "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", + "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } @@ -7270,7 +7270,7 @@ "type": "string" }, "languageCode": { - "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -7281,7 +7281,7 @@ "id": "GoogleCloudVisionV1p4beta1WebDetectionWebPage", "properties": { "fullMatchingImages": { - "description": "Fully matching images on the page.\nCan include resized copies of the query image.", + "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, @@ -7292,7 +7292,7 @@ "type": "string" }, "partialMatchingImages": { - "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", + "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, @@ -7316,7 +7316,7 @@ "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", @@ -7328,7 +7328,7 @@ "description": "Additional information detected for the word." }, "symbols": { - "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", + "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "GoogleCloudVisionV1p4beta1Symbol" }, @@ -7338,7 +7338,7 @@ "type": "object" }, "GroupedResult": { - "description": "Information about the products similar to a single product in a query\nimage.", + "description": "Information about the products similar to a single product in a query image.", "id": "GroupedResult", "properties": { "boundingPoly": { @@ -7363,11 +7363,11 @@ "type": "object" }, "ImageAnnotationContext": { - "description": "If an image was produced from a file (e.g. a PDF), this message gives\ninformation about the source of that image.", + "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "ImageAnnotationContext", "properties": { "pageNumber": { - "description": "If the file was a PDF or TIFF, this field gives the page number within\nthe file used to produce the image.", + "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" }, @@ -7390,7 +7390,7 @@ "type": "object" }, "ImportProductSetsResponse": { - "description": "Response message for the `ImportProductSets` method.\n\nThis message is returned by the\ngoogle.longrunning.Operations.GetOperation method in the returned\ngoogle.longrunning.Operation.response field.", + "description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.", "id": "ImportProductSetsResponse", "properties": { "referenceImages": { @@ -7401,7 +7401,7 @@ "type": "array" }, "statuses": { - "description": "The rpc status for each ImportProductSet request, including both successes\nand errors.\n\nThe number of statuses here matches the number of lines in the csv file,\nand statuses[i] stores the success or failure status of processing the i-th\nline of the csv, starting from line 0.", + "description": "The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.", "items": { "$ref": "Status" }, @@ -7415,7 +7415,7 @@ "id": "InputConfig", "properties": { "content": { - "description": "File content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.\n\nCurrently, this field only works for BatchAnnotateFiles requests. It does\nnot work for AsyncBatchAnnotateFiles requests.", + "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "format": "byte", "type": "string" }, @@ -7424,7 +7424,7 @@ "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { - "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and\n\"image/gif\" are supported. Wildcards are not supported.", + "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } }, @@ -7435,11 +7435,11 @@ "id": "KeyValue", "properties": { "key": { - "description": "The key of the label attached to the product. Cannot be empty and cannot\nexceed 128 bytes.", + "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { - "description": "The value of the label attached to the product. Cannot be empty and\ncannot exceed 128 bytes.", + "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, @@ -7535,7 +7535,7 @@ "type": "object" }, "LatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\nWGS84\nstandard. Values must be within normalized ranges.", + "description": "An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", "id": "LatLng", "properties": { "latitude": { @@ -7560,7 +7560,7 @@ "description": "Image region to which this object belongs. This must be populated." }, "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -7591,7 +7591,7 @@ "type": "object" }, "NormalizedVertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the normalized vertex coordinates are relative to the original image\nand range from 0 to 1.", + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "NormalizedVertex", "properties": { "x": { @@ -7612,7 +7612,7 @@ "id": "ObjectAnnotation", "properties": { "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { @@ -7632,11 +7632,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": { @@ -7648,11 +7648,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": { @@ -7660,7 +7660,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" } }, @@ -7706,7 +7706,7 @@ "id": "OutputConfig", "properties": { "batchSize": { - "description": "The max number of response protos to put into each output JSON file on\nGoogle Cloud Storage.\nThe valid range is [1, 100]. If not specified, the default value is 20.\n\nFor example, for one pdf file with 100 pages, 100 response protos will\nbe generated. If `batch_size` = 20, then 5 json files each\ncontaining 20 response protos will be written under the prefix\n`gcs_destination`.`uri`.\n\nCurrently, batch_size only applies to GcsDestination, with potential future\nsupport for other output configurations.", + "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, @@ -7734,7 +7734,7 @@ "type": "number" }, "height": { - "description": "Page height. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, @@ -7743,7 +7743,7 @@ "description": "Additional information detected on the page." }, "width": { - "description": "Page width. For PDFs the unit is points. For images (including\nTIFFs) the unit is pixels.", + "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" } @@ -7756,7 +7756,7 @@ "properties": { "boundingBox": { "$ref": "BoundingPoly", - "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", @@ -7778,7 +7778,7 @@ "type": "object" }, "Position": { - "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", + "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "Position", "properties": { "x": { @@ -7804,23 +7804,23 @@ "id": "Product", "properties": { "description": { - "description": "User-provided metadata to be stored with this product. Must be at most 4096\ncharacters long.", + "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "displayName": { - "description": "The user-provided name for this Product. Must not be empty. Must be at most\n4096 characters long.", + "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { - "description": "The resource name of the product.\n\nFormat is:\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.\n\nThis field is ignored when creating a product.", + "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "productCategory": { - "description": "Immutable. The category for the product identified by the reference image. This should\nbe either \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\". The legacy categories\n\"homegoods\", \"apparel\", and \"toys\" are still supported, but these should\nnot be used for new products.", + "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { - "description": "Key-value pairs that can be attached to a product. At query time,\nconstraints can be specified based on the product_labels.\n\nNote that integer values can be provided as strings, e.g. \"1199\". Only\nstrings with integer values can match a range-based restriction which is\nto be supported soon.\n\nMultiple values can be assigned to the same key. One product may have up to\n500 product_labels.\n\nNotice that the total number of distinct product_labels over all products\nin one ProductSet cannot exceed 1M, otherwise the product search pipeline\nwill refuse to work for that ProductSet.", + "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.", "items": { "$ref": "KeyValue" }, @@ -7834,12 +7834,12 @@ "id": "ProductSearchResults", "properties": { "indexTime": { - "description": "Timestamp of the index which provided these results. Products added to the\nproduct set and products removed from the product set after this time are\nnot reflected in the current results.", + "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime", "type": "string" }, "productGroupedResults": { - "description": "List of results grouped by products detected in the query image. Each entry\ncorresponds to one bounding polygon in the query image, and contains the\nmatching products specific to that region. There may be duplicate product\nmatches in the union of all the per-product results.", + "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "items": { "$ref": "GroupedResult" }, @@ -7876,22 +7876,22 @@ "type": "object" }, "ReferenceImage": { - "description": "A `ReferenceImage` represents a product image and its associated metadata,\nsuch as bounding boxes.", + "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.", "id": "ReferenceImage", "properties": { "boundingPolys": { - "description": "Optional. Bounding polygons around the areas of interest in the reference image.\nIf this field is empty, the system will try to detect regions of\ninterest. At most 10 bounding polygons will be used.\n\nThe provided shape is converted into a non-rotated rectangle. Once\nconverted, the small edge of the rectangle must be greater than or equal\nto 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5\nis not).", + "description": "Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).", "items": { "$ref": "BoundingPoly" }, "type": "array" }, "name": { - "description": "The resource name of the reference image.\n\nFormat is:\n\n`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.\n\nThis field is ignored when creating a reference image.", + "description": "The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.", "type": "string" }, "uri": { - "description": "Required. The Google Cloud Storage URI of the reference image.\n\nThe URI must start with `gs://`.", + "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`.", "type": "string" } }, @@ -7902,7 +7902,7 @@ "id": "Result", "properties": { "image": { - "description": "The resource name of the image from the product that is the closest match\nto the query.", + "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { @@ -7910,7 +7910,7 @@ "description": "The Product." }, "score": { - "description": "A confidence level on the match, ranging from 0 (no confidence) to\n1 (full confidence).", + "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" } @@ -7918,11 +7918,11 @@ "type": "object" }, "SafeSearchAnnotation": { - "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", + "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "SafeSearchAnnotation", "properties": { "adult": { - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -7962,7 +7962,7 @@ "type": "string" }, "racy": { - "description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.", + "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -7982,7 +7982,7 @@ "type": "string" }, "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -8025,7 +8025,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": { @@ -8034,7 +8034,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.", @@ -8045,7 +8045,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" } }, @@ -8057,7 +8057,7 @@ "properties": { "boundingBox": { "$ref": "BoundingPoly", - "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", @@ -8076,7 +8076,7 @@ "type": "object" }, "TextAnnotation": { - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", + "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "TextAnnotation", "properties": { "pages": { @@ -8112,7 +8112,7 @@ "type": "object" }, "Vertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "Vertex", "properties": { "x": { @@ -8133,14 +8133,14 @@ "id": "WebDetection", "properties": { "bestGuessLabels": { - "description": "The service's best guess as to the topic of the request image.\nInferred from similar images on the open web.", + "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "WebLabel" }, "type": "array" }, "fullMatchingImages": { - "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", + "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "WebImage" }, @@ -8154,7 +8154,7 @@ "type": "array" }, "partialMatchingImages": { - "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", + "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "WebImage" }, @@ -8190,7 +8190,7 @@ "type": "string" }, "score": { - "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", + "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } @@ -8222,7 +8222,7 @@ "type": "string" }, "languageCode": { - "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, @@ -8233,7 +8233,7 @@ "id": "WebPage", "properties": { "fullMatchingImages": { - "description": "Fully matching images on the page.\nCan include resized copies of the query image.", + "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "WebImage" }, @@ -8244,7 +8244,7 @@ "type": "string" }, "partialMatchingImages": { - "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", + "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "WebImage" }, @@ -8268,7 +8268,7 @@ "properties": { "boundingBox": { "$ref": "BoundingPoly", - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertex order will still be (0, 1, 2, 3)." + "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", @@ -8280,7 +8280,7 @@ "description": "Additional information detected for the word." }, "symbols": { - "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", + "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "Symbol" }, diff --git a/discovery/websecurityscanner-v1.json b/discovery/websecurityscanner-v1.json index d9a1d16b04..7cfd5a1ac3 100644 --- a/discovery/websecurityscanner-v1.json +++ b/discovery/websecurityscanner-v1.json @@ -119,7 +119,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource name where the scan is created, which should be a\nproject resource name in the format 'projects/{projectId}'.", + "description": "Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -147,7 +147,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ScanConfig to be deleted. The name follows the\nformat of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", + "description": "Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$", "required": true, @@ -172,7 +172,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ScanConfig to be returned. The name follows the\nformat of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", + "description": "Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$", "required": true, @@ -197,18 +197,18 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of ScanConfigs to return, can be limited by server.\nIf not specified or not positive, the implementation will select a\nreasonable value.", + "description": "The maximum number of ScanConfigs to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous List request.\nIf unspecified, the first page of results is returned.", + "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource name, which should be a project resource name in the\nformat 'projects/{projectId}'.", + "description": "Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -233,14 +233,14 @@ ], "parameters": { "name": { - "description": "The resource name of the ScanConfig. The name follows the format of\n'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are\ngenerated by the system.", + "description": "The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition,\nsee\nhttps://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", "format": "google-fieldmask", "location": "query", "type": "string" @@ -267,7 +267,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ScanConfig to be used. The name follows the\nformat of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", + "description": "Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$", "required": true, @@ -299,7 +299,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ScanRun to be returned. The name follows the\nformat of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", + "description": "Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$", "required": true, @@ -315,7 +315,7 @@ ] }, "list": { - "description": "Lists ScanRuns under a given ScanConfig, in descending order of ScanRun\nstop time.", + "description": "Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.", "flatPath": "v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns", "httpMethod": "GET", "id": "websecurityscanner.projects.scanConfigs.scanRuns.list", @@ -324,18 +324,18 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of ScanRuns to return, can be limited by server.\nIf not specified or not positive, the implementation will select a\nreasonable value.", + "description": "The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous List request.\nIf unspecified, the first page of results is returned.", + "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource name, which should be a scan resource name in the\nformat 'projects/{projectId}/scanConfigs/{scanConfigId}'.", + "description": "Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$", "required": true, @@ -360,7 +360,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ScanRun to be stopped. The name follows the\nformat of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", + "description": "Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$", "required": true, @@ -392,18 +392,18 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of CrawledUrls to return, can be limited by server.\nIf not specified or not positive, the implementation will select a\nreasonable value.", + "description": "The maximum number of CrawledUrls to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous List request.\nIf unspecified, the first page of results is returned.", + "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource name, which should be a scan run resource name in the\nformat\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", + "description": "Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$", "required": true, @@ -432,7 +432,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource name, which should be a scan run resource name in the\nformat\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", + "description": "Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$", "required": true, @@ -461,7 +461,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Finding to be returned. The name follows the\nformat of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'.", + "description": "Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+/findings/[^/]+$", "required": true, @@ -486,23 +486,23 @@ ], "parameters": { "filter": { - "description": "The filter expression. The expression must be in the format: \n .\nSupported field: 'finding_type'.\nSupported operator: '='.", + "description": "The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='.", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of Findings to return, can be limited by server.\nIf not specified or not positive, the implementation will select a\nreasonable value.", + "description": "The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous List request.\nIf unspecified, the first page of results is returned.", + "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource name, which should be a scan run resource name in the\nformat\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", + "description": "Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$", "required": true, @@ -526,7 +526,7 @@ } } }, - "revision": "20200522", + "revision": "20200801", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": { @@ -549,7 +549,7 @@ "type": "object" }, "CrawledUrl": { - "description": "A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web\nSecurity Scanner Service crawls the web applications, following all links\nwithin the scope of sites, to find the URLs to test against.", + "description": "A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web Security Scanner Service crawls the web applications, following all links within the scope of sites, to find the URLs to test against.", "id": "CrawledUrl", "properties": { "body": { @@ -557,7 +557,7 @@ "type": "string" }, "httpMethod": { - "description": "Output only. The http method of the request that was used to visit the URL, in\nuppercase.", + "description": "Output only. The http method of the request that was used to visit the URL, in uppercase.", "type": "string" }, "url": { @@ -576,7 +576,7 @@ "type": "string" }, "password": { - "description": "Required. Input only. The password of the custom account. The credential is stored encrypted\nand not returned in any response nor included in audit logs.", + "description": "Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.", "type": "string" }, "username": { @@ -587,13 +587,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" }, "Finding": { - "description": "A Finding resource represents a vulnerability instance identified during a\nScanRun.", + "description": "A Finding resource represents a vulnerability instance identified during a ScanRun.", "id": "Finding", "properties": { "body": { @@ -609,27 +609,27 @@ "type": "string" }, "findingType": { - "description": "Output only. The type of the Finding.\nDetailed and up-to-date information on findings can be found here:\nhttps://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings", + "description": "Output only. The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings", "type": "string" }, "form": { "$ref": "Form", - "description": "Output only. An addon containing information reported for a vulnerability with an HTML\nform, if any." + "description": "Output only. An addon containing information reported for a vulnerability with an HTML form, if any." }, "frameUrl": { - "description": "Output only. If the vulnerability was originated from nested IFrame, the immediate\nparent IFrame is reported.", + "description": "Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.", "type": "string" }, "fuzzedUrl": { - "description": "Output only. The URL produced by the server-side fuzzer and used in the request that\ntriggered the vulnerability.", + "description": "Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability.", "type": "string" }, "httpMethod": { - "description": "Output only. The http method of the request that triggered the vulnerability, in\nuppercase.", + "description": "Output only. The http method of the request that triggered the vulnerability, in uppercase.", "type": "string" }, "name": { - "description": "Output only. The resource name of the Finding. The name follows the format of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'.\nThe finding IDs are generated by the system.", + "description": "Output only. The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system.", "type": "string" }, "outdatedLibrary": { @@ -637,7 +637,7 @@ "description": "Output only. An addon containing information about outdated libraries." }, "reproductionUrl": { - "description": "Output only. The URL containing human-readable payload that user can leverage to\nreproduce the vulnerability.", + "description": "Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability.", "type": "string" }, "severity": { @@ -656,15 +656,16 @@ "Medium severity.", "Low severity." ], + "readOnly": true, "type": "string" }, "trackingId": { - "description": "Output only. The tracking ID uniquely identifies a vulnerability instance across\nmultiple ScanRuns.", + "description": "Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.", "type": "string" }, "violatingResource": { "$ref": "ViolatingResource", - "description": "Output only. An addon containing detailed information regarding any resource causing the\nvulnerability such as JavaScript sources, image, audio files, etc." + "description": "Output only. An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc." }, "vulnerableHeaders": { "$ref": "VulnerableHeaders", @@ -672,7 +673,7 @@ }, "vulnerableParameters": { "$ref": "VulnerableParameters", - "description": "Output only. An addon containing information about request parameters which were found\nto be vulnerable." + "description": "Output only. An addon containing information about request parameters which were found to be vulnerable." }, "xss": { "$ref": "Xss", @@ -682,7 +683,7 @@ "type": "object" }, "FindingTypeStats": { - "description": "A FindingTypeStats resource represents stats regarding a specific FindingType\nof Findings under a given ScanRun.", + "description": "A FindingTypeStats resource represents stats regarding a specific FindingType of Findings under a given ScanRun.", "id": "FindingTypeStats", "properties": { "findingCount": { @@ -720,7 +721,7 @@ "id": "GoogleAccount", "properties": { "password": { - "description": "Required. Input only. The password of the Google account. The credential is stored encrypted\nand not returned in any response nor included in audit logs.", + "description": "Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.", "type": "string" }, "username": { @@ -751,17 +752,17 @@ "properties": { "iapTestServiceAccountInfo": { "$ref": "IapTestServiceAccountInfo", - "description": "Authentication configuration when Web-Security-Scanner service\naccount is added in Identity-Aware-Proxy (IAP) access policies." + "description": "Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies." } }, "type": "object" }, "IapTestServiceAccountInfo": { - "description": "Describes authentication configuration when Web-Security-Scanner\nservice account is added in Identity-Aware-Proxy (IAP) access policies.", + "description": "Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.", "id": "IapTestServiceAccountInfo", "properties": { "targetAudienceClientId": { - "description": "Required. Describes OAuth2 client id of resources protected by\nIdentity-Aware-Proxy (IAP).", + "description": "Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).", "type": "string" } }, @@ -779,7 +780,7 @@ "type": "array" }, "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } }, @@ -811,7 +812,7 @@ "type": "array" }, "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } }, @@ -822,7 +823,7 @@ "id": "ListScanConfigsResponse", "properties": { "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "scanConfigs": { @@ -840,7 +841,7 @@ "id": "ListScanRunsResponse", "properties": { "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "scanRuns": { @@ -881,10 +882,10 @@ "properties": { "authentication": { "$ref": "Authentication", - "description": "The authentication configuration. If specified, service will use the\nauthentication configuration during scanning." + "description": "The authentication configuration. If specified, service will use the authentication configuration during scanning." }, "blacklistPatterns": { - "description": "The excluded URL patterns as described in\nhttps://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls", + "description": "The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls", "items": { "type": "string" }, @@ -895,7 +896,7 @@ "type": "string" }, "exportToSecurityCommandCenter": { - "description": "Controls export of scan configurations and results to Security\nCommand Center.", + "description": "Controls export of scan configurations and results to Security Command Center.", "enum": [ "EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED", "ENABLED", @@ -909,16 +910,16 @@ "type": "string" }, "managedScan": { - "description": "Whether the scan config is managed by Web Security Scanner, output\nonly.", + "description": "Whether the scan config is managed by Web Security Scanner, output only.", "type": "boolean" }, "maxQps": { - "description": "The maximum QPS during scanning. A valid value ranges from 5 to 20\ninclusively. If the field is unspecified or its value is set 0, server will\ndefault to 15. Other values outside of [5, 20] range will be rejected with\nINVALID_ARGUMENT error.", + "description": "The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.", "format": "int32", "type": "integer" }, "name": { - "description": "The resource name of the ScanConfig. The name follows the format of\n'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are\ngenerated by the system.", + "description": "The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.", "type": "string" }, "riskLevel": { @@ -947,7 +948,7 @@ "type": "array" }, "staticIpScan": { - "description": "Whether the scan configuration has enabled static IP address scan feature.\nIf enabled, the scanner will access applications from static IP addresses.", + "description": "Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.", "type": "boolean" }, "userAgent": { @@ -970,7 +971,7 @@ "type": "object" }, "ScanConfigError": { - "description": "Defines a custom error message used by CreateScanConfig and UpdateScanConfig\nAPIs when scan configuration validation fails. It is also reported as part of\na ScanRunErrorTrace message if scan validation fails due to a scan\nconfiguration error.", + "description": "Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error.", "id": "ScanConfigError", "properties": { "code": { @@ -1022,68 +1023,68 @@ "enumDescriptions": [ "There is no error.", "There is no error.", - "Indicates an internal server error.\nPlease DO NOT USE THIS ERROR CODE unless the root cause is truly unknown.", - "One of the seed URLs is an App Engine URL but we cannot validate the scan\nsettings due to an App Engine API backend error.", - "One of the seed URLs is an App Engine URL but we cannot access the\nApp Engine API to validate scan settings.", - "One of the seed URLs is an App Engine URL but the Default Host of the\nApp Engine is not set.", + "Indicates an internal server error. Please DO NOT USE THIS ERROR CODE unless the root cause is truly unknown.", + "One of the seed URLs is an App Engine URL but we cannot validate the scan settings due to an App Engine API backend error.", + "One of the seed URLs is an App Engine URL but we cannot access the App Engine API to validate scan settings.", + "One of the seed URLs is an App Engine URL but the Default Host of the App Engine is not set.", "Google corporate accounts can not be used for scanning.", "The account of the scan creator can not be used for scanning.", - "This scan targets Compute Engine, but we cannot validate scan settings\ndue to a Compute Engine API backend error.", - "This scan targets Compute Engine, but we cannot access the Compute Engine\nAPI to validate the scan settings.", + "This scan targets Compute Engine, but we cannot validate scan settings due to a Compute Engine API backend error.", + "This scan targets Compute Engine, but we cannot access the Compute Engine API to validate the scan settings.", "The Custom Login URL does not belong to the current project.", "The Custom Login URL is malformed (can not be parsed).", "The Custom Login URL is mapped to a non-routable IP address in DNS.", - "The Custom Login URL is mapped to an IP address which is not reserved for\nthe current project.", + "The Custom Login URL is mapped to an IP address which is not reserved for the current project.", "The Custom Login URL has a non-routable IP address.", - "The Custom Login URL has an IP address which is not reserved for the\ncurrent project.", + "The Custom Login URL has an IP address which is not reserved for the current project.", "Another scan with the same name (case-sensitive) already exists.", "A field is set to an invalid value.", "There was an error trying to authenticate to the scan target.", "Finding type value is not specified in the list findings request.", - "Scan targets Compute Engine, yet current project was not whitelisted for\nGoogle Compute Engine Scanning Alpha access.", + "Scan targets Compute Engine, yet current project was not whitelisted for Google Compute Engine Scanning Alpha access.", "User tries to update managed scan", - "The supplied filter is malformed. For example, it can not be parsed, does\nnot have a filter type in expression, or the same filter type appears\nmore than once.", + "The supplied filter is malformed. For example, it can not be parsed, does not have a filter type in expression, or the same filter type appears more than once.", "The supplied resource name is malformed (can not be parsed).", "The current project is not in an active state.", "A required field is not set.", - "Project id, scanconfig id, scanrun id, or finding id are not consistent\nwith each other in resource name.", + "Project id, scanconfig id, scanrun id, or finding id are not consistent with each other in resource name.", "The scan being requested to start is already running.", "The scan that was requested to be stopped is not running.", "One of the seed URLs does not belong to the current project.", "One of the seed URLs is malformed (can not be parsed).", "One of the seed URLs is mapped to a non-routable IP address in DNS.", - "One of the seed URLs is mapped to an IP address which is not reserved\nfor the current project.", + "One of the seed URLs is mapped to an IP address which is not reserved for the current project.", "One of the seed URLs has on-routable IP address.", - "One of the seed URLs has an IP address that is not reserved\nfor the current project.", - "The Web Security Scanner service account is not configured under the\nproject.", + "One of the seed URLs has an IP address that is not reserved for the current project.", + "The Web Security Scanner service account is not configured under the project.", "A project has reached the maximum number of scans.", "Resolving the details of the current project fails.", "One or more blacklist patterns were in the wrong format.", "The supplied filter is not supported.", - "The supplied finding type is not supported. For example, we do not\nprovide findings of the given finding type.", + "The supplied finding type is not supported. For example, we do not provide findings of the given finding type.", "The URL scheme of one or more of the supplied URLs is not supported." ], "type": "string" }, "fieldName": { - "description": "Output only. Indicates the full name of the ScanConfig field that triggers this error,\nfor example \"scan_config.max_qps\". This field is provided for\ntroubleshooting purposes only and its actual value can change in the\nfuture.", + "description": "Output only. Indicates the full name of the ScanConfig field that triggers this error, for example \"scan_config.max_qps\". This field is provided for troubleshooting purposes only and its actual value can change in the future.", "type": "string" } }, "type": "object" }, "ScanRun": { - "description": "A ScanRun is a output-only resource representing an actual run of the scan.\nNext id: 12", + "description": "A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12", "id": "ScanRun", "properties": { "endTime": { - "description": "Output only. The time at which the ScanRun reached termination state - that the ScanRun\nis either finished or stopped by user.", + "description": "Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.", "format": "google-datetime", "type": "string" }, "errorTrace": { "$ref": "ScanRunErrorTrace", - "description": "Output only. If result_state is an ERROR, this field provides the primary reason for\nscan's termination and more details, if such are available." + "description": "Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available." }, "executionState": { "description": "Output only. The execution state of the ScanRun.", @@ -1094,7 +1095,7 @@ "FINISHED" ], "enumDescriptions": [ - "Represents an invalid state caused by internal server error. This value\nshould never be returned.", + "Represents an invalid state caused by internal server error. This value should never be returned.", "The scan is waiting in the queue.", "The scan is in progress.", "The scan is either finished or stopped by user." @@ -1106,16 +1107,16 @@ "type": "boolean" }, "name": { - "description": "Output only. The resource name of the ScanRun. The name follows the format of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.\nThe ScanRun IDs are generated by the system.", + "description": "Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.", "type": "string" }, "progressPercent": { - "description": "Output only. The percentage of total completion ranging from 0 to 100.\nIf the scan is in queue, the value is 0.\nIf the scan is running, the value ranges from 0 to 100.\nIf the scan is finished, the value is 100.", + "description": "Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.", "format": "int32", "type": "integer" }, "resultState": { - "description": "Output only. The result state of the ScanRun. This field is only available after the\nexecution state reaches \"FINISHED\".", + "description": "Output only. The result state of the ScanRun. This field is only available after the execution state reaches \"FINISHED\".", "enum": [ "RESULT_STATE_UNSPECIFIED", "SUCCESS", @@ -1123,7 +1124,7 @@ "KILLED" ], "enumDescriptions": [ - "Default value. This value is returned when the ScanRun is not yet\nfinished.", + "Default value. This value is returned when the ScanRun is not yet finished.", "The scan finished without errors.", "The scan finished with errors.", "The scan was terminated by user." @@ -1136,12 +1137,12 @@ "type": "string" }, "urlsCrawledCount": { - "description": "Output only. The number of URLs crawled during this ScanRun. If the scan is in progress,\nthe value represents the number of URLs crawled up to now.", + "description": "Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.", "format": "int64", "type": "string" }, "urlsTestedCount": { - "description": "Output only. The number of URLs tested during this ScanRun. If the scan is in progress,\nthe value represents the number of URLs tested up to now. The number of\nURLs tested is usually larger than the number URLS crawled because\ntypically a crawled URL is tested with multiple test payloads.", + "description": "Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.", "format": "int64", "type": "string" }, @@ -1156,7 +1157,7 @@ "type": "object" }, "ScanRunErrorTrace": { - "description": "Output only.\nDefines an error trace message for a ScanRun.", + "description": "Output only. Defines an error trace message for a ScanRun.", "id": "ScanRunErrorTrace", "properties": { "code": { @@ -1173,28 +1174,28 @@ "enumDescriptions": [ "Default value is never used.", "Indicates that the scan run failed due to an internal server error.", - "Indicates a scan configuration error, usually due to outdated ScanConfig\nsettings, such as starting_urls or the DNS configuration.", - "Indicates an authentication error, usually due to outdated ScanConfig\nauthentication settings.", + "Indicates a scan configuration error, usually due to outdated ScanConfig settings, such as starting_urls or the DNS configuration.", + "Indicates an authentication error, usually due to outdated ScanConfig authentication settings.", "Indicates a scan operation timeout, usually caused by a very large site.", - "Indicates that a scan encountered excessive redirects, either to\nauthentication or some other page outside of the scan scope.", - "Indicates that a scan encountered numerous errors from the web site\npages. When available, most_common_http_error_code field indicates the\nmost common HTTP error code encountered during the scan." + "Indicates that a scan encountered excessive redirects, either to authentication or some other page outside of the scan scope.", + "Indicates that a scan encountered numerous errors from the web site pages. When available, most_common_http_error_code field indicates the most common HTTP error code encountered during the scan." ], "type": "string" }, "mostCommonHttpErrorCode": { - "description": "Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most\ncommon HTTP error code, if such is available. For example, if this code is\n404, the scan has encountered too many NOT_FOUND responses.", + "description": "Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.", "format": "int32", "type": "integer" }, "scanConfigError": { "$ref": "ScanConfigError", - "description": "Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error\nmessage encountered during scan configuration validation that is performed\nbefore each scan run." + "description": "Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run." } }, "type": "object" }, "ScanRunWarningTrace": { - "description": "Output only.\nDefines a warning trace message for ScanRun. Warning traces provide customers\nwith useful information that helps make the scanning process more effective.", + "description": "Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.", "id": "ScanRunWarningTrace", "properties": { "code": { @@ -1208,9 +1209,9 @@ ], "enumDescriptions": [ "Default value is never used.", - "Indicates that a scan discovered an unexpectedly low number of URLs. This\nis sometimes caused by complex navigation features or by using a single\nURL for numerous pages.", - "Indicates that a scan discovered too many URLs to test, or excessive\nredundant URLs.", - "Indicates that too many tests have been generated for the scan. Customer\nshould try reducing the number of starting URLs, increasing the QPS rate,\nor narrowing down the scope of the scan using the excluded patterns.", + "Indicates that a scan discovered an unexpectedly low number of URLs. This is sometimes caused by complex navigation features or by using a single URL for numerous pages.", + "Indicates that a scan discovered too many URLs to test, or excessive redundant URLs.", + "Indicates that too many tests have been generated for the scan. Customer should try reducing the number of starting URLs, increasing the QPS rate, or narrowing down the scope of the scan using the excluded patterns.", "Indicates that a scan is blocked by IAP." ], "type": "string" @@ -1228,7 +1229,7 @@ "type": "integer" }, "scheduleTime": { - "description": "A timestamp indicates when the next run will be scheduled. The value is\nrefreshed by the server after each run. If unspecified, it will default\nto current server time, which means the scan will be scheduled to start\nimmediately.", + "description": "A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.", "format": "google-datetime", "type": "string" } @@ -1248,7 +1249,7 @@ "type": "object" }, "ViolatingResource": { - "description": "Information regarding any resource causing the vulnerability such\nas JavaScript sources, image, audio files, etc.", + "description": "Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.", "id": "ViolatingResource", "properties": { "contentType": { @@ -1337,7 +1338,7 @@ "The attack comes from fuzzing the protocol.", "The attack comes from the server side and is stored.", "The attack is a Same-Origin Method Execution attack via a GET parameter.", - "The attack payload is received from a third-party host via a URL that is\nuser-controllable" + "The attack payload is received from a third-party host via a URL that is user-controllable" ], "type": "string" }, diff --git a/discovery/websecurityscanner-v1alpha.json b/discovery/websecurityscanner-v1alpha.json index d985a531a7..e5d7e72200 100644 --- a/discovery/websecurityscanner-v1alpha.json +++ b/discovery/websecurityscanner-v1alpha.json @@ -119,7 +119,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource name where the scan is created, which should be a\nproject resource name in the format 'projects/{projectId}'.", + "description": "Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -147,7 +147,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ScanConfig to be deleted. The name follows the\nformat of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", + "description": "Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$", "required": true, @@ -172,7 +172,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ScanConfig to be returned. The name follows the\nformat of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", + "description": "Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$", "required": true, @@ -197,18 +197,18 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of ScanConfigs to return, can be limited by server.\nIf not specified or not positive, the implementation will select a\nreasonable value.", + "description": "The maximum number of ScanConfigs to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous List request.\nIf unspecified, the first page of results is returned.", + "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource name, which should be a project resource name in the\nformat 'projects/{projectId}'.", + "description": "Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -233,14 +233,14 @@ ], "parameters": { "name": { - "description": "The resource name of the ScanConfig. The name follows the format of\n'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are\ngenerated by the system.", + "description": "The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition,\nsee\nhttps://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", "format": "google-fieldmask", "location": "query", "type": "string" @@ -267,7 +267,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ScanConfig to be used. The name follows the\nformat of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", + "description": "Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$", "required": true, @@ -299,7 +299,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ScanRun to be returned. The name follows the\nformat of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", + "description": "Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$", "required": true, @@ -315,7 +315,7 @@ ] }, "list": { - "description": "Lists ScanRuns under a given ScanConfig, in descending order of ScanRun\nstop time.", + "description": "Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.", "flatPath": "v1alpha/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns", "httpMethod": "GET", "id": "websecurityscanner.projects.scanConfigs.scanRuns.list", @@ -324,18 +324,18 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of ScanRuns to return, can be limited by server.\nIf not specified or not positive, the implementation will select a\nreasonable value.", + "description": "The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous List request.\nIf unspecified, the first page of results is returned.", + "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource name, which should be a scan resource name in the\nformat 'projects/{projectId}/scanConfigs/{scanConfigId}'.", + "description": "Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$", "required": true, @@ -360,7 +360,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ScanRun to be stopped. The name follows the\nformat of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", + "description": "Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$", "required": true, @@ -392,18 +392,18 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of CrawledUrls to return, can be limited by server.\nIf not specified or not positive, the implementation will select a\nreasonable value.", + "description": "The maximum number of CrawledUrls to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous List request.\nIf unspecified, the first page of results is returned.", + "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource name, which should be a scan run resource name in the\nformat\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", + "description": "Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$", "required": true, @@ -432,7 +432,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource name, which should be a scan run resource name in the\nformat\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", + "description": "Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$", "required": true, @@ -461,7 +461,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Finding to be returned. The name follows the\nformat of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'.", + "description": "Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+/findings/[^/]+$", "required": true, @@ -486,23 +486,23 @@ ], "parameters": { "filter": { - "description": "Required. The filter expression. The expression must be in the format: \n .\nSupported field: 'finding_type'.\nSupported operator: '='.", + "description": "Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='.", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of Findings to return, can be limited by server.\nIf not specified or not positive, the implementation will select a\nreasonable value.", + "description": "The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous List request.\nIf unspecified, the first page of results is returned.", + "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource name, which should be a scan run resource name in the\nformat\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", + "description": "Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$", "required": true, @@ -526,7 +526,7 @@ } } }, - "revision": "20200522", + "revision": "20200801", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": { @@ -545,7 +545,7 @@ "type": "object" }, "CrawledUrl": { - "description": "A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web\nSecurity Scanner Service crawls the web applications, following all links\nwithin the scope of sites, to find the URLs to test against.", + "description": "A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web Security Scanner Service crawls the web applications, following all links within the scope of sites, to find the URLs to test against.", "id": "CrawledUrl", "properties": { "body": { @@ -553,7 +553,7 @@ "type": "string" }, "httpMethod": { - "description": "Output only. The http method of the request that was used to visit the URL, in\nuppercase.", + "description": "Output only. The http method of the request that was used to visit the URL, in uppercase.", "type": "string" }, "url": { @@ -572,7 +572,7 @@ "type": "string" }, "password": { - "description": "Required. Input only. The password of the custom account. The credential is stored encrypted\nand not returned in any response nor included in audit logs.", + "description": "Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.", "type": "string" }, "username": { @@ -583,13 +583,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" }, "Finding": { - "description": "A Finding resource represents a vulnerability instance identified during a\nScanRun.", + "description": "A Finding resource represents a vulnerability instance identified during a ScanRun.", "id": "Finding", "properties": { "body": { @@ -622,14 +622,14 @@ ], "enumDescriptions": [ "The invalid finding type.", - "A page that was served over HTTPS also resources over HTTP. A\nman-in-the-middle attacker could tamper with the HTTP resource and gain\nfull access to the website that loads the resource or to monitor the\nactions taken by the user.", - "The version of an included library is known to contain a security issue.\nThe scanner checks the version of library in use against a known list of\nvulnerable libraries. False positives are possible if the version\ndetection fails or if the library has been manually patched.", - "This type of vulnerability occurs when the value of a request parameter\nis reflected at the beginning of the response, for example, in requests\nusing JSONP. Under certain circumstances, an attacker may be able to\nsupply an alphanumeric-only Flash file in the vulnerable parameter\ncausing the browser to execute the Flash file as if it originated on the\nvulnerable server.", - "A cross-site scripting (XSS) bug is found via JavaScript callback. For\ndetailed explanations on XSS, see\nhttps://www.google.com/about/appsecurity/learning/xss/.", - "A potential cross-site scripting (XSS) bug due to JavaScript breakage.\nIn some circumstances, the application under test might modify the test\nstring before it is parsed by the browser. When the browser attempts to\nruns this modified test string, it will likely break and throw a\nJavaScript execution error, thus an injection issue is occurring.\nHowever, it may not be exploitable. Manual verification is needed to see\nif the test string modifications can be evaded and confirm that the issue\nis in fact an XSS vulnerability. For detailed explanations on XSS, see\nhttps://www.google.com/about/appsecurity/learning/xss/.", - "An application appears to be transmitting a password field in clear text.\nAn attacker can eavesdrop network traffic and sniff the password field.", - "An application returns sensitive content with an invalid content type,\nor without an 'X-Content-Type-Options: nosniff' header.", - "A cross-site scripting (XSS) vulnerability in AngularJS module that\noccurs when a user-provided string is interpolated by Angular.", + "A page that was served over HTTPS also resources over HTTP. A man-in-the-middle attacker could tamper with the HTTP resource and gain full access to the website that loads the resource or to monitor the actions taken by the user.", + "The version of an included library is known to contain a security issue. The scanner checks the version of library in use against a known list of vulnerable libraries. False positives are possible if the version detection fails or if the library has been manually patched.", + "This type of vulnerability occurs when the value of a request parameter is reflected at the beginning of the response, for example, in requests using JSONP. Under certain circumstances, an attacker may be able to supply an alphanumeric-only Flash file in the vulnerable parameter causing the browser to execute the Flash file as if it originated on the vulnerable server.", + "A cross-site scripting (XSS) bug is found via JavaScript callback. For detailed explanations on XSS, see https://www.google.com/about/appsecurity/learning/xss/.", + "A potential cross-site scripting (XSS) bug due to JavaScript breakage. In some circumstances, the application under test might modify the test string before it is parsed by the browser. When the browser attempts to runs this modified test string, it will likely break and throw a JavaScript execution error, thus an injection issue is occurring. However, it may not be exploitable. Manual verification is needed to see if the test string modifications can be evaded and confirm that the issue is in fact an XSS vulnerability. For detailed explanations on XSS, see https://www.google.com/about/appsecurity/learning/xss/.", + "An application appears to be transmitting a password field in clear text. An attacker can eavesdrop network traffic and sniff the password field.", + "An application returns sensitive content with an invalid content type, or without an 'X-Content-Type-Options: nosniff' header.", + "A cross-site scripting (XSS) vulnerability in AngularJS module that occurs when a user-provided string is interpolated by Angular.", "A malformed or invalid valued header.", "Misspelled security header name.", "Mismatching values in a duplicate security header." @@ -637,19 +637,19 @@ "type": "string" }, "frameUrl": { - "description": "If the vulnerability was originated from nested IFrame, the immediate\nparent IFrame is reported.", + "description": "If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.", "type": "string" }, "fuzzedUrl": { - "description": "The URL produced by the server-side fuzzer and used in the request that\ntriggered the vulnerability.", + "description": "The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability.", "type": "string" }, "httpMethod": { - "description": "The http method of the request that triggered the vulnerability, in\nuppercase.", + "description": "The http method of the request that triggered the vulnerability, in uppercase.", "type": "string" }, "name": { - "description": "The resource name of the Finding. The name follows the format of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'.\nThe finding IDs are generated by the system.", + "description": "The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system.", "type": "string" }, "outdatedLibrary": { @@ -657,16 +657,16 @@ "description": "An addon containing information about outdated libraries." }, "reproductionUrl": { - "description": "The URL containing human-readable payload that user can leverage to\nreproduce the vulnerability.", + "description": "The URL containing human-readable payload that user can leverage to reproduce the vulnerability.", "type": "string" }, "trackingId": { - "description": "The tracking ID uniquely identifies a vulnerability instance across\nmultiple ScanRuns.", + "description": "The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.", "type": "string" }, "violatingResource": { "$ref": "ViolatingResource", - "description": "An addon containing detailed information regarding any resource causing the\nvulnerability such as JavaScript sources, image, audio files, etc." + "description": "An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc." }, "vulnerableHeaders": { "$ref": "VulnerableHeaders", @@ -674,7 +674,7 @@ }, "vulnerableParameters": { "$ref": "VulnerableParameters", - "description": "An addon containing information about request parameters which were found\nto be vulnerable." + "description": "An addon containing information about request parameters which were found to be vulnerable." }, "xss": { "$ref": "Xss", @@ -684,7 +684,7 @@ "type": "object" }, "FindingTypeStats": { - "description": "A FindingTypeStats resource represents stats regarding a specific FindingType\nof Findings under a given ScanRun.", + "description": "A FindingTypeStats resource represents stats regarding a specific FindingType of Findings under a given ScanRun.", "id": "FindingTypeStats", "properties": { "findingCount": { @@ -710,14 +710,14 @@ ], "enumDescriptions": [ "The invalid finding type.", - "A page that was served over HTTPS also resources over HTTP. A\nman-in-the-middle attacker could tamper with the HTTP resource and gain\nfull access to the website that loads the resource or to monitor the\nactions taken by the user.", - "The version of an included library is known to contain a security issue.\nThe scanner checks the version of library in use against a known list of\nvulnerable libraries. False positives are possible if the version\ndetection fails or if the library has been manually patched.", - "This type of vulnerability occurs when the value of a request parameter\nis reflected at the beginning of the response, for example, in requests\nusing JSONP. Under certain circumstances, an attacker may be able to\nsupply an alphanumeric-only Flash file in the vulnerable parameter\ncausing the browser to execute the Flash file as if it originated on the\nvulnerable server.", - "A cross-site scripting (XSS) bug is found via JavaScript callback. For\ndetailed explanations on XSS, see\nhttps://www.google.com/about/appsecurity/learning/xss/.", - "A potential cross-site scripting (XSS) bug due to JavaScript breakage.\nIn some circumstances, the application under test might modify the test\nstring before it is parsed by the browser. When the browser attempts to\nruns this modified test string, it will likely break and throw a\nJavaScript execution error, thus an injection issue is occurring.\nHowever, it may not be exploitable. Manual verification is needed to see\nif the test string modifications can be evaded and confirm that the issue\nis in fact an XSS vulnerability. For detailed explanations on XSS, see\nhttps://www.google.com/about/appsecurity/learning/xss/.", - "An application appears to be transmitting a password field in clear text.\nAn attacker can eavesdrop network traffic and sniff the password field.", - "An application returns sensitive content with an invalid content type,\nor without an 'X-Content-Type-Options: nosniff' header.", - "A cross-site scripting (XSS) vulnerability in AngularJS module that\noccurs when a user-provided string is interpolated by Angular.", + "A page that was served over HTTPS also resources over HTTP. A man-in-the-middle attacker could tamper with the HTTP resource and gain full access to the website that loads the resource or to monitor the actions taken by the user.", + "The version of an included library is known to contain a security issue. The scanner checks the version of library in use against a known list of vulnerable libraries. False positives are possible if the version detection fails or if the library has been manually patched.", + "This type of vulnerability occurs when the value of a request parameter is reflected at the beginning of the response, for example, in requests using JSONP. Under certain circumstances, an attacker may be able to supply an alphanumeric-only Flash file in the vulnerable parameter causing the browser to execute the Flash file as if it originated on the vulnerable server.", + "A cross-site scripting (XSS) bug is found via JavaScript callback. For detailed explanations on XSS, see https://www.google.com/about/appsecurity/learning/xss/.", + "A potential cross-site scripting (XSS) bug due to JavaScript breakage. In some circumstances, the application under test might modify the test string before it is parsed by the browser. When the browser attempts to runs this modified test string, it will likely break and throw a JavaScript execution error, thus an injection issue is occurring. However, it may not be exploitable. Manual verification is needed to see if the test string modifications can be evaded and confirm that the issue is in fact an XSS vulnerability. For detailed explanations on XSS, see https://www.google.com/about/appsecurity/learning/xss/.", + "An application appears to be transmitting a password field in clear text. An attacker can eavesdrop network traffic and sniff the password field.", + "An application returns sensitive content with an invalid content type, or without an 'X-Content-Type-Options: nosniff' header.", + "A cross-site scripting (XSS) vulnerability in AngularJS module that occurs when a user-provided string is interpolated by Angular.", "A malformed or invalid valued header.", "Misspelled security header name.", "Mismatching values in a duplicate security header." @@ -732,7 +732,7 @@ "id": "GoogleAccount", "properties": { "password": { - "description": "Required. Input only. The password of the Google account. The credential is stored encrypted\nand not returned in any response nor included in audit logs.", + "description": "Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.", "type": "string" }, "username": { @@ -769,7 +769,7 @@ "type": "array" }, "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } }, @@ -801,7 +801,7 @@ "type": "array" }, "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } }, @@ -812,7 +812,7 @@ "id": "ListScanConfigsResponse", "properties": { "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "scanConfigs": { @@ -830,7 +830,7 @@ "id": "ListScanRunsResponse", "properties": { "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "scanRuns": { @@ -866,15 +866,15 @@ "type": "object" }, "ScanConfig": { - "description": "A ScanConfig resource contains the configurations to launch a scan.\nnext id: 12", + "description": "A ScanConfig resource contains the configurations to launch a scan. next id: 12", "id": "ScanConfig", "properties": { "authentication": { "$ref": "Authentication", - "description": "The authentication configuration. If specified, service will use the\nauthentication configuration during scanning." + "description": "The authentication configuration. If specified, service will use the authentication configuration during scanning." }, "blacklistPatterns": { - "description": "The excluded URL patterns as described in\nhttps://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls", + "description": "The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls", "items": { "type": "string" }, @@ -889,12 +889,12 @@ "description": "Latest ScanRun if available." }, "maxQps": { - "description": "The maximum QPS during scanning. A valid value ranges from 5 to 20\ninclusively. If the field is unspecified or its value is set 0, server will\ndefault to 15. Other values outside of [5, 20] range will be rejected with\nINVALID_ARGUMENT error.", + "description": "The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.", "format": "int32", "type": "integer" }, "name": { - "description": "The resource name of the ScanConfig. The name follows the format of\n'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are\ngenerated by the system.", + "description": "The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.", "type": "string" }, "schedule": { @@ -909,9 +909,9 @@ "type": "array" }, "targetPlatforms": { - "description": "Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE\nwill be used as a default.", + "description": "Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.", "enumDescriptions": [ - "The target platform is unknown. Requests with this enum value will be\nrejected with INVALID_ARGUMENT error.", + "The target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.", "Google App Engine service.", "Google Compute Engine service." ], @@ -921,6 +921,11 @@ "APP_ENGINE", "COMPUTE" ], + "enumDescriptions": [ + "The target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.", + "Google App Engine service.", + "Google Compute Engine service." + ], "type": "string" }, "type": "array" @@ -949,7 +954,7 @@ "id": "ScanRun", "properties": { "endTime": { - "description": "The time at which the ScanRun reached termination state - that the ScanRun\nis either finished or stopped by user.", + "description": "The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.", "format": "google-datetime", "type": "string" }, @@ -962,7 +967,7 @@ "FINISHED" ], "enumDescriptions": [ - "Represents an invalid state caused by internal server error. This value\nshould never be returned.", + "Represents an invalid state caused by internal server error. This value should never be returned.", "The scan is waiting in the queue.", "The scan is in progress.", "The scan is either finished or stopped by user." @@ -974,16 +979,16 @@ "type": "boolean" }, "name": { - "description": "The resource name of the ScanRun. The name follows the format of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.\nThe ScanRun IDs are generated by the system.", + "description": "The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.", "type": "string" }, "progressPercent": { - "description": "The percentage of total completion ranging from 0 to 100.\nIf the scan is in queue, the value is 0.\nIf the scan is running, the value ranges from 0 to 100.\nIf the scan is finished, the value is 100.", + "description": "The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.", "format": "int32", "type": "integer" }, "resultState": { - "description": "The result state of the ScanRun. This field is only available after the\nexecution state reaches \"FINISHED\".", + "description": "The result state of the ScanRun. This field is only available after the execution state reaches \"FINISHED\".", "enum": [ "RESULT_STATE_UNSPECIFIED", "SUCCESS", @@ -991,7 +996,7 @@ "KILLED" ], "enumDescriptions": [ - "Default value. This value is returned when the ScanRun is not yet\nfinished.", + "Default value. This value is returned when the ScanRun is not yet finished.", "The scan finished without errors.", "The scan finished with errors.", "The scan was terminated by user." @@ -1004,12 +1009,12 @@ "type": "string" }, "urlsCrawledCount": { - "description": "The number of URLs crawled during this ScanRun. If the scan is in progress,\nthe value represents the number of URLs crawled up to now.", + "description": "The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.", "format": "int64", "type": "string" }, "urlsTestedCount": { - "description": "The number of URLs tested during this ScanRun. If the scan is in progress,\nthe value represents the number of URLs tested up to now. The number of\nURLs tested is usually larger than the number URLS crawled because\ntypically a crawled URL is tested with multiple test payloads.", + "description": "The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.", "format": "int64", "type": "string" } @@ -1026,7 +1031,7 @@ "type": "integer" }, "scheduleTime": { - "description": "A timestamp indicates when the next run will be scheduled. The value is\nrefreshed by the server after each run. If unspecified, it will default\nto current server time, which means the scan will be scheduled to start\nimmediately.", + "description": "A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.", "format": "google-datetime", "type": "string" } @@ -1046,7 +1051,7 @@ "type": "object" }, "ViolatingResource": { - "description": "Information regarding any resource causing the vulnerability such\nas JavaScript sources, image, audio files, etc.", + "description": "Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.", "id": "ViolatingResource", "properties": { "contentType": { diff --git a/discovery/websecurityscanner-v1beta.json b/discovery/websecurityscanner-v1beta.json index 65f11d61c1..c4692f6272 100644 --- a/discovery/websecurityscanner-v1beta.json +++ b/discovery/websecurityscanner-v1beta.json @@ -119,7 +119,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource name where the scan is created, which should be a\nproject resource name in the format 'projects/{projectId}'.", + "description": "Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -147,7 +147,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ScanConfig to be deleted. The name follows the\nformat of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", + "description": "Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$", "required": true, @@ -172,7 +172,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ScanConfig to be returned. The name follows the\nformat of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", + "description": "Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$", "required": true, @@ -197,18 +197,18 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of ScanConfigs to return, can be limited by server.\nIf not specified or not positive, the implementation will select a\nreasonable value.", + "description": "The maximum number of ScanConfigs to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous List request.\nIf unspecified, the first page of results is returned.", + "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource name, which should be a project resource name in the\nformat 'projects/{projectId}'.", + "description": "Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -233,14 +233,14 @@ ], "parameters": { "name": { - "description": "The resource name of the ScanConfig. The name follows the format of\n'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are\ngenerated by the system.", + "description": "The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition,\nsee\nhttps://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", "format": "google-fieldmask", "location": "query", "type": "string" @@ -267,7 +267,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ScanConfig to be used. The name follows the\nformat of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", + "description": "Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$", "required": true, @@ -299,7 +299,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ScanRun to be returned. The name follows the\nformat of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", + "description": "Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$", "required": true, @@ -315,7 +315,7 @@ ] }, "list": { - "description": "Lists ScanRuns under a given ScanConfig, in descending order of ScanRun\nstop time.", + "description": "Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.", "flatPath": "v1beta/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns", "httpMethod": "GET", "id": "websecurityscanner.projects.scanConfigs.scanRuns.list", @@ -324,18 +324,18 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of ScanRuns to return, can be limited by server.\nIf not specified or not positive, the implementation will select a\nreasonable value.", + "description": "The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous List request.\nIf unspecified, the first page of results is returned.", + "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource name, which should be a scan resource name in the\nformat 'projects/{projectId}/scanConfigs/{scanConfigId}'.", + "description": "Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$", "required": true, @@ -360,7 +360,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ScanRun to be stopped. The name follows the\nformat of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", + "description": "Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$", "required": true, @@ -392,18 +392,18 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of CrawledUrls to return, can be limited by server.\nIf not specified or not positive, the implementation will select a\nreasonable value.", + "description": "The maximum number of CrawledUrls to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous List request.\nIf unspecified, the first page of results is returned.", + "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource name, which should be a scan run resource name in the\nformat\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", + "description": "Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$", "required": true, @@ -432,7 +432,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource name, which should be a scan run resource name in the\nformat\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", + "description": "Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$", "required": true, @@ -461,7 +461,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Finding to be returned. The name follows the\nformat of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'.", + "description": "Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+/findings/[^/]+$", "required": true, @@ -486,23 +486,23 @@ ], "parameters": { "filter": { - "description": "Required. The filter expression. The expression must be in the format: \n .\nSupported field: 'finding_type'.\nSupported operator: '='.", + "description": "Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='.", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of Findings to return, can be limited by server.\nIf not specified or not positive, the implementation will select a\nreasonable value.", + "description": "The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous List request.\nIf unspecified, the first page of results is returned.", + "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource name, which should be a scan run resource name in the\nformat\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", + "description": "Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+/scanRuns/[^/]+$", "required": true, @@ -526,7 +526,7 @@ } } }, - "revision": "20200522", + "revision": "20200801", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": { @@ -549,7 +549,7 @@ "type": "object" }, "CrawledUrl": { - "description": "A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web\nSecurity Scanner Service crawls the web applications, following all links\nwithin the scope of sites, to find the URLs to test against.", + "description": "A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web Security Scanner Service crawls the web applications, following all links within the scope of sites, to find the URLs to test against.", "id": "CrawledUrl", "properties": { "body": { @@ -557,7 +557,7 @@ "type": "string" }, "httpMethod": { - "description": "The http method of the request that was used to visit the URL, in\nuppercase.", + "description": "The http method of the request that was used to visit the URL, in uppercase.", "type": "string" }, "url": { @@ -576,7 +576,7 @@ "type": "string" }, "password": { - "description": "Required. Input only. The password of the custom account. The credential is stored encrypted\nand not returned in any response nor included in audit logs.", + "description": "Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.", "type": "string" }, "username": { @@ -587,13 +587,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" }, "Finding": { - "description": "A Finding resource represents a vulnerability instance identified during a\nScanRun.", + "description": "A Finding resource represents a vulnerability instance identified during a ScanRun.", "id": "Finding", "properties": { "body": { @@ -609,27 +609,27 @@ "type": "string" }, "findingType": { - "description": "The type of the Finding.\nDetailed and up-to-date information on findings can be found here:\nhttps://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner", + "description": "The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner", "type": "string" }, "form": { "$ref": "Form", - "description": "An addon containing information reported for a vulnerability with an HTML\nform, if any." + "description": "An addon containing information reported for a vulnerability with an HTML form, if any." }, "frameUrl": { - "description": "If the vulnerability was originated from nested IFrame, the immediate\nparent IFrame is reported.", + "description": "If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.", "type": "string" }, "fuzzedUrl": { - "description": "The URL produced by the server-side fuzzer and used in the request that\ntriggered the vulnerability.", + "description": "The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability.", "type": "string" }, "httpMethod": { - "description": "The http method of the request that triggered the vulnerability, in\nuppercase.", + "description": "The http method of the request that triggered the vulnerability, in uppercase.", "type": "string" }, "name": { - "description": "The resource name of the Finding. The name follows the format of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'.\nThe finding IDs are generated by the system.", + "description": "The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system.", "type": "string" }, "outdatedLibrary": { @@ -637,7 +637,7 @@ "description": "An addon containing information about outdated libraries." }, "reproductionUrl": { - "description": "The URL containing human-readable payload that user can leverage to\nreproduce the vulnerability.", + "description": "The URL containing human-readable payload that user can leverage to reproduce the vulnerability.", "type": "string" }, "severity": { @@ -659,12 +659,12 @@ "type": "string" }, "trackingId": { - "description": "The tracking ID uniquely identifies a vulnerability instance across\nmultiple ScanRuns.", + "description": "The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.", "type": "string" }, "violatingResource": { "$ref": "ViolatingResource", - "description": "An addon containing detailed information regarding any resource causing the\nvulnerability such as JavaScript sources, image, audio files, etc." + "description": "An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc." }, "vulnerableHeaders": { "$ref": "VulnerableHeaders", @@ -672,7 +672,7 @@ }, "vulnerableParameters": { "$ref": "VulnerableParameters", - "description": "An addon containing information about request parameters which were found\nto be vulnerable." + "description": "An addon containing information about request parameters which were found to be vulnerable." }, "xss": { "$ref": "Xss", @@ -682,7 +682,7 @@ "type": "object" }, "FindingTypeStats": { - "description": "A FindingTypeStats resource represents stats regarding a specific FindingType\nof Findings under a given ScanRun.", + "description": "A FindingTypeStats resource represents stats regarding a specific FindingType of Findings under a given ScanRun.", "id": "FindingTypeStats", "properties": { "findingCount": { @@ -720,7 +720,7 @@ "id": "GoogleAccount", "properties": { "password": { - "description": "Required. Input only. The password of the Google account. The credential is stored encrypted\nand not returned in any response nor included in audit logs.", + "description": "Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.", "type": "string" }, "username": { @@ -751,17 +751,17 @@ "properties": { "iapTestServiceAccountInfo": { "$ref": "IapTestServiceAccountInfo", - "description": "Authentication configuration when Web-Security-Scanner service\naccount is added in Identity-Aware-Proxy (IAP) access policies." + "description": "Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies." } }, "type": "object" }, "IapTestServiceAccountInfo": { - "description": "Describes authentication configuration when Web-Security-Scanner\nservice account is added in Identity-Aware-Proxy (IAP) access policies.", + "description": "Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.", "id": "IapTestServiceAccountInfo", "properties": { "targetAudienceClientId": { - "description": "Required. Describes OAuth2 Client ID of resources protected by\nIdentity-Aware-Proxy(IAP).", + "description": "Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).", "type": "string" } }, @@ -779,7 +779,7 @@ "type": "array" }, "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } }, @@ -811,7 +811,7 @@ "type": "array" }, "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } }, @@ -822,7 +822,7 @@ "id": "ListScanConfigsResponse", "properties": { "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "scanConfigs": { @@ -840,7 +840,7 @@ "id": "ListScanRunsResponse", "properties": { "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "scanRuns": { @@ -881,10 +881,10 @@ "properties": { "authentication": { "$ref": "Authentication", - "description": "The authentication configuration. If specified, service will use the\nauthentication configuration during scanning." + "description": "The authentication configuration. If specified, service will use the authentication configuration during scanning." }, "blacklistPatterns": { - "description": "The excluded URL patterns as described in\nhttps://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls", + "description": "The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls", "items": { "type": "string" }, @@ -895,7 +895,7 @@ "type": "string" }, "exportToSecurityCommandCenter": { - "description": "Controls export of scan configurations and results to Security\nCommand Center.", + "description": "Controls export of scan configurations and results to Security Command Center.", "enum": [ "EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED", "ENABLED", @@ -913,16 +913,16 @@ "description": "Latest ScanRun if available." }, "managedScan": { - "description": "Whether the scan config is managed by Web Security Scanner, output\nonly.", + "description": "Whether the scan config is managed by Web Security Scanner, output only.", "type": "boolean" }, "maxQps": { - "description": "The maximum QPS during scanning. A valid value ranges from 5 to 20\ninclusively. If the field is unspecified or its value is set 0, server will\ndefault to 15. Other values outside of [5, 20] range will be rejected with\nINVALID_ARGUMENT error.", + "description": "The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.", "format": "int32", "type": "integer" }, "name": { - "description": "The resource name of the ScanConfig. The name follows the format of\n'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are\ngenerated by the system.", + "description": "The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.", "type": "string" }, "riskLevel": { @@ -951,13 +951,13 @@ "type": "array" }, "staticIpScan": { - "description": "Whether the scan configuration has enabled static IP address scan feature.\nIf enabled, the scanner will access applications from static IP addresses.", + "description": "Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.", "type": "boolean" }, "targetPlatforms": { - "description": "Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE\nwill be used as a default.", + "description": "Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.", "enumDescriptions": [ - "The target platform is unknown. Requests with this enum value will be\nrejected with INVALID_ARGUMENT error.", + "The target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.", "Google App Engine service.", "Google Compute Engine service." ], @@ -967,6 +967,11 @@ "APP_ENGINE", "COMPUTE" ], + "enumDescriptions": [ + "The target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.", + "Google App Engine service.", + "Google Compute Engine service." + ], "type": "string" }, "type": "array" @@ -991,7 +996,7 @@ "type": "object" }, "ScanConfigError": { - "description": "Defines a custom error message used by CreateScanConfig and UpdateScanConfig\nAPIs when scan configuration validation fails. It is also reported as part of\na ScanRunErrorTrace message if scan validation fails due to a scan\nconfiguration error.", + "description": "Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error.", "id": "ScanConfigError", "properties": { "code": { @@ -1043,68 +1048,68 @@ "enumDescriptions": [ "There is no error.", "There is no error.", - "Indicates an internal server error.\nPlease DO NOT USE THIS ERROR CODE unless the root cause is truly unknown.", - "One of the seed URLs is an App Engine URL but we cannot validate the scan\nsettings due to an App Engine API backend error.", - "One of the seed URLs is an App Engine URL but we cannot access the\nApp Engine API to validate scan settings.", - "One of the seed URLs is an App Engine URL but the Default Host of the\nApp Engine is not set.", + "Indicates an internal server error. Please DO NOT USE THIS ERROR CODE unless the root cause is truly unknown.", + "One of the seed URLs is an App Engine URL but we cannot validate the scan settings due to an App Engine API backend error.", + "One of the seed URLs is an App Engine URL but we cannot access the App Engine API to validate scan settings.", + "One of the seed URLs is an App Engine URL but the Default Host of the App Engine is not set.", "Google corporate accounts can not be used for scanning.", "The account of the scan creator can not be used for scanning.", - "This scan targets Compute Engine, but we cannot validate scan settings\ndue to a Compute Engine API backend error.", - "This scan targets Compute Engine, but we cannot access the Compute Engine\nAPI to validate the scan settings.", + "This scan targets Compute Engine, but we cannot validate scan settings due to a Compute Engine API backend error.", + "This scan targets Compute Engine, but we cannot access the Compute Engine API to validate the scan settings.", "The Custom Login URL does not belong to the current project.", "The Custom Login URL is malformed (can not be parsed).", "The Custom Login URL is mapped to a non-routable IP address in DNS.", - "The Custom Login URL is mapped to an IP address which is not reserved for\nthe current project.", + "The Custom Login URL is mapped to an IP address which is not reserved for the current project.", "The Custom Login URL has a non-routable IP address.", - "The Custom Login URL has an IP address which is not reserved for the\ncurrent project.", + "The Custom Login URL has an IP address which is not reserved for the current project.", "Another scan with the same name (case-sensitive) already exists.", "A field is set to an invalid value.", "There was an error trying to authenticate to the scan target.", "Finding type value is not specified in the list findings request.", - "Scan targets Compute Engine, yet current project was not whitelisted for\nGoogle Compute Engine Scanning Alpha access.", + "Scan targets Compute Engine, yet current project was not whitelisted for Google Compute Engine Scanning Alpha access.", "User tries to update managed scan", - "The supplied filter is malformed. For example, it can not be parsed, does\nnot have a filter type in expression, or the same filter type appears\nmore than once.", + "The supplied filter is malformed. For example, it can not be parsed, does not have a filter type in expression, or the same filter type appears more than once.", "The supplied resource name is malformed (can not be parsed).", "The current project is not in an active state.", "A required field is not set.", - "Project id, scanconfig id, scanrun id, or finding id are not consistent\nwith each other in resource name.", + "Project id, scanconfig id, scanrun id, or finding id are not consistent with each other in resource name.", "The scan being requested to start is already running.", "The scan that was requested to be stopped is not running.", "One of the seed URLs does not belong to the current project.", "One of the seed URLs is malformed (can not be parsed).", "One of the seed URLs is mapped to a non-routable IP address in DNS.", - "One of the seed URLs is mapped to an IP address which is not reserved\nfor the current project.", + "One of the seed URLs is mapped to an IP address which is not reserved for the current project.", "One of the seed URLs has on-routable IP address.", - "One of the seed URLs has an IP address that is not reserved\nfor the current project.", - "The Web Security Scanner service account is not configured under the\nproject.", + "One of the seed URLs has an IP address that is not reserved for the current project.", + "The Web Security Scanner service account is not configured under the project.", "A project has reached the maximum number of scans.", "Resolving the details of the current project fails.", "One or more blacklist patterns were in the wrong format.", "The supplied filter is not supported.", - "The supplied finding type is not supported. For example, we do not\nprovide findings of the given finding type.", + "The supplied finding type is not supported. For example, we do not provide findings of the given finding type.", "The URL scheme of one or more of the supplied URLs is not supported." ], "type": "string" }, "fieldName": { - "description": "Indicates the full name of the ScanConfig field that triggers this error,\nfor example \"scan_config.max_qps\". This field is provided for\ntroubleshooting purposes only and its actual value can change in the\nfuture.", + "description": "Indicates the full name of the ScanConfig field that triggers this error, for example \"scan_config.max_qps\". This field is provided for troubleshooting purposes only and its actual value can change in the future.", "type": "string" } }, "type": "object" }, "ScanRun": { - "description": "A ScanRun is a output-only resource representing an actual run of the scan.\nNext id: 12", + "description": "A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12", "id": "ScanRun", "properties": { "endTime": { - "description": "The time at which the ScanRun reached termination state - that the ScanRun\nis either finished or stopped by user.", + "description": "The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.", "format": "google-datetime", "type": "string" }, "errorTrace": { "$ref": "ScanRunErrorTrace", - "description": "If result_state is an ERROR, this field provides the primary reason for\nscan's termination and more details, if such are available." + "description": "If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available." }, "executionState": { "description": "The execution state of the ScanRun.", @@ -1115,7 +1120,7 @@ "FINISHED" ], "enumDescriptions": [ - "Represents an invalid state caused by internal server error. This value\nshould never be returned.", + "Represents an invalid state caused by internal server error. This value should never be returned.", "The scan is waiting in the queue.", "The scan is in progress.", "The scan is either finished or stopped by user." @@ -1127,16 +1132,16 @@ "type": "boolean" }, "name": { - "description": "The resource name of the ScanRun. The name follows the format of\n'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.\nThe ScanRun IDs are generated by the system.", + "description": "The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.", "type": "string" }, "progressPercent": { - "description": "The percentage of total completion ranging from 0 to 100.\nIf the scan is in queue, the value is 0.\nIf the scan is running, the value ranges from 0 to 100.\nIf the scan is finished, the value is 100.", + "description": "The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.", "format": "int32", "type": "integer" }, "resultState": { - "description": "The result state of the ScanRun. This field is only available after the\nexecution state reaches \"FINISHED\".", + "description": "The result state of the ScanRun. This field is only available after the execution state reaches \"FINISHED\".", "enum": [ "RESULT_STATE_UNSPECIFIED", "SUCCESS", @@ -1144,7 +1149,7 @@ "KILLED" ], "enumDescriptions": [ - "Default value. This value is returned when the ScanRun is not yet\nfinished.", + "Default value. This value is returned when the ScanRun is not yet finished.", "The scan finished without errors.", "The scan finished with errors.", "The scan was terminated by user." @@ -1157,12 +1162,12 @@ "type": "string" }, "urlsCrawledCount": { - "description": "The number of URLs crawled during this ScanRun. If the scan is in progress,\nthe value represents the number of URLs crawled up to now.", + "description": "The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.", "format": "int64", "type": "string" }, "urlsTestedCount": { - "description": "The number of URLs tested during this ScanRun. If the scan is in progress,\nthe value represents the number of URLs tested up to now. The number of\nURLs tested is usually larger than the number URLS crawled because\ntypically a crawled URL is tested with multiple test payloads.", + "description": "The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.", "format": "int64", "type": "string" }, @@ -1177,7 +1182,7 @@ "type": "object" }, "ScanRunErrorTrace": { - "description": "Output only.\nDefines an error trace message for a ScanRun.", + "description": "Output only. Defines an error trace message for a ScanRun.", "id": "ScanRunErrorTrace", "properties": { "code": { @@ -1194,28 +1199,28 @@ "enumDescriptions": [ "Default value is never used.", "Indicates that the scan run failed due to an internal server error.", - "Indicates a scan configuration error, usually due to outdated ScanConfig\nsettings, such as starting_urls or the DNS configuration.", - "Indicates an authentication error, usually due to outdated ScanConfig\nauthentication settings.", + "Indicates a scan configuration error, usually due to outdated ScanConfig settings, such as starting_urls or the DNS configuration.", + "Indicates an authentication error, usually due to outdated ScanConfig authentication settings.", "Indicates a scan operation timeout, usually caused by a very large site.", - "Indicates that a scan encountered excessive redirects, either to\nauthentication or some other page outside of the scan scope.", - "Indicates that a scan encountered numerous errors from the web site\npages. When available, most_common_http_error_code field indicates the\nmost common HTTP error code encountered during the scan." + "Indicates that a scan encountered excessive redirects, either to authentication or some other page outside of the scan scope.", + "Indicates that a scan encountered numerous errors from the web site pages. When available, most_common_http_error_code field indicates the most common HTTP error code encountered during the scan." ], "type": "string" }, "mostCommonHttpErrorCode": { - "description": "If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most\ncommon HTTP error code, if such is available. For example, if this code is\n404, the scan has encountered too many NOT_FOUND responses.", + "description": "If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.", "format": "int32", "type": "integer" }, "scanConfigError": { "$ref": "ScanConfigError", - "description": "If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error\nmessage encountered during scan configuration validation that is performed\nbefore each scan run." + "description": "If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run." } }, "type": "object" }, "ScanRunWarningTrace": { - "description": "Output only.\nDefines a warning trace message for ScanRun. Warning traces provide customers\nwith useful information that helps make the scanning process more effective.", + "description": "Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.", "id": "ScanRunWarningTrace", "properties": { "code": { @@ -1229,9 +1234,9 @@ ], "enumDescriptions": [ "Default value is never used.", - "Indicates that a scan discovered an unexpectedly low number of URLs. This\nis sometimes caused by complex navigation features or by using a single\nURL for numerous pages.", - "Indicates that a scan discovered too many URLs to test, or excessive\nredundant URLs.", - "Indicates that too many tests have been generated for the scan. Customer\nshould try reducing the number of starting URLs, increasing the QPS rate,\nor narrowing down the scope of the scan using the excluded patterns.", + "Indicates that a scan discovered an unexpectedly low number of URLs. This is sometimes caused by complex navigation features or by using a single URL for numerous pages.", + "Indicates that a scan discovered too many URLs to test, or excessive redundant URLs.", + "Indicates that too many tests have been generated for the scan. Customer should try reducing the number of starting URLs, increasing the QPS rate, or narrowing down the scope of the scan using the excluded patterns.", "Indicates that a scan is blocked by IAP." ], "type": "string" @@ -1249,7 +1254,7 @@ "type": "integer" }, "scheduleTime": { - "description": "A timestamp indicates when the next run will be scheduled. The value is\nrefreshed by the server after each run. If unspecified, it will default\nto current server time, which means the scan will be scheduled to start\nimmediately.", + "description": "A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.", "format": "google-datetime", "type": "string" } @@ -1269,7 +1274,7 @@ "type": "object" }, "ViolatingResource": { - "description": "Information regarding any resource causing the vulnerability such\nas JavaScript sources, image, audio files, etc.", + "description": "Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.", "id": "ViolatingResource", "properties": { "contentType": { diff --git a/src/apis/cloudprofiler/v2.ts b/src/apis/cloudprofiler/v2.ts index 39e0fef406..7f5859ddab 100644 --- a/src/apis/cloudprofiler/v2.ts +++ b/src/apis/cloudprofiler/v2.ts @@ -145,7 +145,7 @@ export namespace cloudprofiler_v2 { */ export interface Schema$Deployment { /** - * Labels identify the deployment within the user universe and same target. Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. Value for an individual label must be <= 512 bytes, the total size of all label names and values must be <= 1024 bytes. Label named "language" can be used to record the programming language of the profiled deployment. The standard choices for the value include "java", "go", "python", "ruby", "nodejs", "php", "dotnet". For deployments running on Google Cloud Platform, "zone" or "region" label should be present describing the deployment location. An example of a zone is "us-central1-a", an example of a region is "us-central1" or "us-central". + * Labels identify the deployment within the user universe and same target. Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. Value for an individual label must be <= 512 bytes, the total size of all label names and values must be <= 1024 bytes. Label named "language" can be used to record the programming language of the profiled deployment. The standard choices for the value include "java", "go", "python", "ruby", "nodejs", "php", "dotnet". For deployments running on Google Cloud Platform, "zone" or "region" label should be present describing the deployment location. An example of a zone is "us-central1-a", an example of a region is "us-central1" or "us-central". */ labels?: {[key: string]: string} | null; /** @@ -170,7 +170,7 @@ export namespace cloudprofiler_v2 { */ duration?: string | null; /** - * Input only. Labels associated to this specific profile. These labels will get merged with the deployment labels for the final data set. See documentation on deployment labels for validation rules and limits. + * Input only. Labels associated to this specific profile. These labels will get merged with the deployment labels for the final data set. See documentation on deployment labels for validation rules and limits. */ labels?: {[key: string]: string} | null; /** @@ -204,7 +204,7 @@ export namespace cloudprofiler_v2 { /** * cloudprofiler.projects.profiles.create - * @desc CreateProfile creates a new profile resource in the online mode. The server ensures that the new profiles are created at a constant rate per deployment, so the creation request may hang for some time until the next profile session is available. The request may fail with ABORTED error if the creation is not available within ~1m, the response will indicate the duration of the backoff the client should take before attempting creating a profile again. The backoff duration is returned in google.rpc.RetryInfo extension on the response status. To a gRPC client, the extension will be return as a binary-serialized proto in the trailing metadata item named "google.rpc.retryinfo-bin". + * @desc CreateProfile creates a new profile resource in the online mode. The server ensures that the new profiles are created at a constant rate per deployment, so the creation request may hang for some time until the next profile session is available. The request may fail with ABORTED error if the creation is not available within ~1m, the response will indicate the duration of the backoff the client should take before attempting creating a profile again. The backoff duration is returned in google.rpc.RetryInfo extension on the response status. To a gRPC client, the extension will be return as a binary-serialized proto in the trailing metadata item named "google.rpc.retryinfo-bin". * @example * // Before running the sample: * // - Enable the API at: @@ -541,10 +541,7 @@ export namespace cloudprofiler_v2 { * const res = await cloudprofiler.projects.profiles.patch({ * // Output only. Opaque, server-assigned, unique ID for this profile. * name: 'projects/my-project/profiles/my-profile', - * // Field mask used to specify the fields to be overwritten. Currently only - * // profile_bytes and labels fields are supported by UpdateProfile, so only - * // those fields can be specified in the mask. When no mask is provided, all - * // fields are overwritten. + * // Field mask used to specify the fields to be overwritten. Currently only profile_bytes and labels fields are supported by UpdateProfile, so only those fields can be specified in the mask. When no mask is provided, all fields are overwritten. * updateMask: 'placeholder-value', * * // Request body metadata diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 5e73e9b6ad..98861983eb 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -207,7 +207,7 @@ export namespace container_v1beta1 { */ management?: Schema$NodeManagement; /** - * Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass "automatic" as field value. + * Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass "automatic" as field value. */ minCpuPlatform?: string | null; /** @@ -1161,7 +1161,7 @@ export namespace container_v1beta1 { */ export interface Schema$MaintenancePolicy { /** - * A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a <code>get()</code> request to the cluster to get the current resource version and include it with requests to set the policy. + * A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. */ resourceVersion?: string | null; /** @@ -1347,11 +1347,11 @@ export namespace container_v1beta1 { */ machineType?: string | null; /** - * The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-oslogin" "gci-ensure-gke-docker" "gci-metrics-enabled" "gci-update-strategy" "instance-template" "kube-env" "startup-script" "user-data" "disable-address-manager" "windows-startup-script-ps1" "common-psm1" "k8s-node-setup-psm1" "install-ssh-psm1" "user-profile-psm1" "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. + * The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" - "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. */ metadata?: {[key: string]: string} | null; /** - * Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + * Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) */ minCpuPlatform?: string | null; /** @@ -1670,7 +1670,7 @@ export namespace container_v1beta1 { */ export interface Schema$RecurringTimeWindow { /** - * An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> To repeat some window daily (equivalent to the DailyMaintenanceWindow): <code>FREQ=DAILY</code> For the first weekend of every month: <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: <code> start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR </code> Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: <code> start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA </code> Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. + * An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. */ recurrence?: string | null; /** @@ -1860,7 +1860,7 @@ export namespace container_v1beta1 { */ clusterId?: string | null; /** - * Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a <code>get()</code> request to the resource to get the latest fingerprint. + * Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a `get()` request to the resource to get the latest fingerprint. */ labelFingerprint?: string | null; /** diff --git a/src/apis/displayvideo/v1.ts b/src/apis/displayvideo/v1.ts index 77c9bef251..b640b32b69 100644 --- a/src/apis/displayvideo/v1.ts +++ b/src/apis/displayvideo/v1.ts @@ -690,15 +690,15 @@ export namespace displayvideo_v1 { */ export interface Schema$AuditAdvertiserResponse { /** - * The number of ACTIVE and PAUSED campaigns under this advertiser. These campaigns count towards the limit of 9,999 campaigns per advertiser. + * The number of ACTIVE and PAUSED campaigns under this advertiser. These campaigns count towards the limit of 9999 campaigns per advertiser. */ usedCampaignsCount?: string | null; /** - * The number of ACTIVE, PAUSED and DRAFT insertion orders under this advertiser. These insertion orders count towards the limit of 9,999 insertion orders per advertiser. + * The number of ACTIVE, PAUSED and DRAFT insertion orders under this advertiser. These insertion orders count towards the limit of 9999 insertion orders per advertiser. */ usedInsertionOrdersCount?: string | null; /** - * The number of ACTIVE, PAUSED, and DRAFT line items under this advertiser. These line items count towards the limit of 9,999 line items per advertiser. + * The number of ACTIVE, PAUSED, and DRAFT line items under this advertiser. These line items count towards the limit of 9999 line items per advertiser. */ usedLineItemsCount?: string | null; } @@ -851,9 +851,6 @@ export namespace displayvideo_v1 { */ deletedAssignedUserRoles?: string[] | null; } - /** - * Response message for BulkEditAssignedUserRoles. - */ export interface Schema$BulkEditAssignedUserRolesResponse { /** * The list of assigned user roles that have been successfully created. This list will be absent if empty. @@ -2834,9 +2831,6 @@ export namespace displayvideo_v1 { */ nextPageToken?: string | null; } - /** - * Response message for CustomBiddingAlgorithmService.ListCustomBiddingAlgorithms. - */ export interface Schema$ListCustomBiddingAlgorithmsResponse { /** * The list of custom bidding algorithms. This list will be absent if empty. @@ -2969,9 +2963,6 @@ export namespace displayvideo_v1 { */ nextPageToken?: string | null; } - /** - * Response message for ListPartnerAssignedTargetingOptions. - */ export interface Schema$ListPartnerAssignedTargetingOptionsResponse { /** * The list of assigned targeting options. This list will be absent if empty. @@ -2982,9 +2973,6 @@ export namespace displayvideo_v1 { */ nextPageToken?: string | null; } - /** - * Response message for ListPartners. - */ export interface Schema$ListPartnersResponse { /** * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListPartners` method to retrieve the next page of results. @@ -3021,9 +3009,6 @@ export namespace displayvideo_v1 { */ targetingOptions?: Schema$TargetingOption[]; } - /** - * Response message for ListUsers. - */ export interface Schema$ListUsersResponse { /** * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListUsers` method to retrieve the next page of results. This token will be absent if there are no more results to return. @@ -4068,7 +4053,7 @@ export namespace displayvideo_v1 { /** * displayvideo.advertisers.audit - * @desc Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their [respective resource limit]: (https://support.google.com/displayvideo/answer/6071450?hl=en) + * @desc Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450. * @example * // Before running the sample: * // - Enable the API at: @@ -15817,11 +15802,11 @@ export namespace displayvideo_v1 { * * // Do the magic * const res = await displayvideo.customBiddingAlgorithms.get({ - * // The ID of the DV3 partner that has access to the custom bidding algorithm. + * // The ID of the DV360 partner that has access to the custom bidding algorithm. * advertiserId: 'placeholder-value', * // Required. The ID of the custom bidding algorithm to fetch. * customBiddingAlgorithmId: '[^/]+', - * // The ID of the DV3 partner that has access to the custom bidding algorithm. + * // The ID of the DV360 partner that has access to the custom bidding algorithm. * partnerId: 'placeholder-value', * }); * console.log(res.data); @@ -15847,9 +15832,9 @@ export namespace displayvideo_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.advertiserId The ID of the DV3 partner that has access to the custom bidding algorithm. + * @param {string=} params.advertiserId The ID of the DV360 partner that has access to the custom bidding algorithm. * @param {string} params.customBiddingAlgorithmId Required. The ID of the custom bidding algorithm to fetch. - * @param {string=} params.partnerId The ID of the DV3 partner that has access to the custom bidding algorithm. + * @param {string=} params.partnerId The ID of the DV360 partner that has access to the custom bidding algorithm. * @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 @@ -15965,7 +15950,7 @@ export namespace displayvideo_v1 { * * // Do the magic * const res = await displayvideo.customBiddingAlgorithms.list({ - * // The ID of the DV3 advertiser that has access to the custom bidding algorithm. + * // The ID of the DV360 advertiser that has access to the custom bidding algorithm. * advertiserId: 'placeholder-value', * // Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND`. A sequence of restrictions * implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)` or `EQUALS (=)`. * The operator must be `CONTAINS (:)` for the following field: - `displayName` * The operator must be `EQUALS (=)` for the following field: - `customBiddingAlgorithmType` * For `displayName`, the value is a string. We return all custom bidding algorithms whose display_name contains such string. * For `customBiddingAlgorithmType`, the value is a string. We return all algorithms whose custom_bidding_algorithm_type is equal to the given type. Examples: * All custom bidding algorithms for which the display name contains "politics": `displayName:politics`. * All custom bidding algorithms for which the type is "SCRIPT_BASED": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this field should be no more than 500 characters. * filter: 'placeholder-value', @@ -15975,7 +15960,7 @@ export namespace displayvideo_v1 { * pageSize: 'placeholder-value', * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned. * pageToken: 'placeholder-value', - * // The ID of the DV3 partner that has access to the custom bidding algorithm. + * // The ID of the DV360 partner that has access to the custom bidding algorithm. * partnerId: 'placeholder-value', * }); * console.log(res.data); @@ -15996,12 +15981,12 @@ export namespace displayvideo_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.advertiserId The ID of the DV3 advertiser that has access to the custom bidding algorithm. + * @param {string=} params.advertiserId The ID of the DV360 advertiser that has access to the custom bidding algorithm. * @param {string=} params.filter Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND`. A sequence of restrictions * implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)` or `EQUALS (=)`. * The operator must be `CONTAINS (:)` for the following field: - `displayName` * The operator must be `EQUALS (=)` for the following field: - `customBiddingAlgorithmType` * For `displayName`, the value is a string. We return all custom bidding algorithms whose display_name contains such string. * For `customBiddingAlgorithmType`, the value is a string. We return all algorithms whose custom_bidding_algorithm_type is equal to the given type. Examples: * All custom bidding algorithms for which the display name contains "politics": `displayName:politics`. * All custom bidding algorithms for which the type is "SCRIPT_BASED": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this field should be no more than 500 characters. * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned. - * @param {string=} params.partnerId The ID of the DV3 partner that has access to the custom bidding algorithm. + * @param {string=} params.partnerId The ID of the DV360 partner that has access to the custom bidding algorithm. * @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 @@ -16098,7 +16083,7 @@ export namespace displayvideo_v1 { export interface Params$Resource$Custombiddingalgorithms$Get extends StandardParameters { /** - * The ID of the DV3 partner that has access to the custom bidding algorithm. + * The ID of the DV360 partner that has access to the custom bidding algorithm. */ advertiserId?: string; /** @@ -16106,14 +16091,14 @@ export namespace displayvideo_v1 { */ customBiddingAlgorithmId?: string; /** - * The ID of the DV3 partner that has access to the custom bidding algorithm. + * The ID of the DV360 partner that has access to the custom bidding algorithm. */ partnerId?: string; } export interface Params$Resource$Custombiddingalgorithms$List extends StandardParameters { /** - * The ID of the DV3 advertiser that has access to the custom bidding algorithm. + * The ID of the DV360 advertiser that has access to the custom bidding algorithm. */ advertiserId?: string; /** @@ -16133,7 +16118,7 @@ export namespace displayvideo_v1 { */ pageToken?: string; /** - * The ID of the DV3 partner that has access to the custom bidding algorithm. + * The ID of the DV360 partner that has access to the custom bidding algorithm. */ partnerId?: string; } @@ -19589,7 +19574,7 @@ export namespace displayvideo_v1 { /** * displayvideo.partners.bulkEditPartnerAssignedTargetingOptions - * @desc Bulk edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.create_requests . + * @desc Bulk edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests . * @example * // Before running the sample: * // - Enable the API at: @@ -22970,7 +22955,7 @@ export namespace displayvideo_v1 { /** * displayvideo.users.bulkEditAssignedUserRoles - * @desc Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deleted_assigned_user_roles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.created_assigned_user_roles. + * @desc Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.createdAssignedUserRoles. * @example * // Before running the sample: * // - Enable the API at: diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 06af929118..7096a92242 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -273,7 +273,7 @@ export namespace dlp_v2 { tableReference?: Schema$GooglePrivacyDlpV2BigQueryTable; } /** - * Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `<project_id>:<dataset_id>.<table_id>` or `<project_id>.<dataset_id>.<table_id>`. + * Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. */ export interface Schema$GooglePrivacyDlpV2BigQueryTable { /** @@ -405,7 +405,7 @@ export namespace dlp_v2 { */ charactersToIgnore?: Schema$GooglePrivacyDlpV2CharsToIgnore[]; /** - * Character to use to mask the sensitive values&mdash;for example, `*` for an alphabetic string such as a name, or `0` for a numeric string such as ZIP code or credit card number. This string must have a length of 1. If not supplied, this value defaults to `*` for strings, and `0` for digits. + * Character to use to mask the sensitive values—for example, `*` for an alphabetic string such as a name, or `0` for a numeric string such as ZIP code or credit card number. This string must have a length of 1. If not supplied, this value defaults to `*` for strings, and `0` for digits. */ maskingCharacter?: string | null; /** @@ -435,7 +435,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2CloudStorageFileSet { /** - * The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed. + * The url, in the format `gs:///`. Trailing wildcard in the path is allowed. */ url?: string | null; } @@ -475,7 +475,7 @@ export namespace dlp_v2 { path?: string | null; } /** - * Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` + * Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` */ export interface Schema$GooglePrivacyDlpV2CloudStorageRegexFileSet { /** @@ -483,11 +483,11 @@ export namespace dlp_v2 { */ bucketName?: string | null; /** - * A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + * A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. */ excludeRegex?: string[] | null; /** - * A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in `exclude_regex`. Leaving this field empty will match all files by default (this is equivalent to including `.*` in the list). Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + * A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in `exclude_regex`. Leaving this field empty will match all files by default (this is equivalent to including `.*` in the list). Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. */ includeRegex?: string[] | null; } @@ -509,7 +509,7 @@ export namespace dlp_v2 { red?: number | null; } /** - * The field type of `value` and `field` do not need to match to be considered equal, but not all comparisons are possible. EQUAL_TO and NOT_EQUAL_TO attempt to compare even with incompatible types, but all other comparisons are invalid with incompatible types. A `value` of type: - `string` can be compared against all other types - `boolean` can only be compared against other booleans - `integer` can be compared against doubles or a string if the string value can be parsed as an integer. - `double` can be compared against integers or a string if the string can be parsed as a double. - `Timestamp` can be compared against strings in RFC 3339 date string format. - `TimeOfDay` can be compared against timestamps and strings in the format of 'HH:mm:ss'. If we fail to compare do to type mismatch, a warning will be given and the condition will evaluate to false. + * The field type of `value` and `field` do not need to match to be considered equal, but not all comparisons are possible. EQUAL_TO and NOT_EQUAL_TO attempt to compare even with incompatible types, but all other comparisons are invalid with incompatible types. A `value` of type: - `string` can be compared against all other types - `boolean` can only be compared against other booleans - `integer` can be compared against doubles or a string if the string value can be parsed as an integer. - `double` can be compared against integers or a string if the string can be parsed as a double. - `Timestamp` can be compared against strings in RFC 3339 date string format. - `TimeOfDay` can be compared against timestamps and strings in the format of 'HH:mm:ss'. If we fail to compare do to type mismatch, a warning will be given and the condition will evaluate to false. */ export interface Schema$GooglePrivacyDlpV2Condition { /** @@ -547,11 +547,11 @@ export namespace dlp_v2 { */ projectId?: string | null; /** - * The rest of the path after the root. Examples: - For BigQuery table `project_id:dataset_id.table_id`, the relative path is `table_id` - Google Cloud Storage file `gs://bucket/folder/filename.txt`, the relative path is `folder/filename.txt` + * The rest of the path after the root. Examples: - For BigQuery table `project_id:dataset_id.table_id`, the relative path is `table_id` - Google Cloud Storage file `gs://bucket/folder/filename.txt`, the relative path is `folder/filename.txt` */ relativePath?: string | null; /** - * The root of the container. Examples: - For BigQuery table `project_id:dataset_id.table_id`, the root is `dataset_id` - For Google Cloud Storage file `gs://bucket/folder/filename.txt`, the root is `gs://bucket` + * The root of the container. Examples: - For BigQuery table `project_id:dataset_id.table_id`, the root is `dataset_id` - For Google Cloud Storage file `gs://bucket/folder/filename.txt`, the root is `gs://bucket` */ rootPath?: string | null; /** @@ -589,7 +589,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2ContentLocation { /** - * Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for an example an image contained within a document). + * Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for an example an image contained within a document). */ containerName?: string | null; /** @@ -711,7 +711,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2CryptoDeterministicConfig { /** - * A context may be used for higher security and maintaining referential integrity such that the same identifier in two different contexts will be given a distinct surrogate. The context is appended to plaintext value being encrypted. On decryption the provided context is validated against the value used during encryption. If a context was provided during encryption, same context must be provided during decryption as well. If the context is not set, plaintext would be used as is for encryption. If the context is set but: 1. there is no record present when transforming a given value or 2. the field is not present when transforming a given value, plaintext would be used as is for encryption. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and non-structured `ContentItem`s. + * A context may be used for higher security and maintaining referential integrity such that the same identifier in two different contexts will be given a distinct surrogate. The context is appended to plaintext value being encrypted. On decryption the provided context is validated against the value used during encryption. If a context was provided during encryption, same context must be provided during decryption as well. If the context is not set, plaintext would be used as is for encryption. If the context is set but: 1. there is no record present when transforming a given value or 2. the field is not present when transforming a given value, plaintext would be used as is for encryption. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and non-structured `ContentItem`s. */ context?: Schema$GooglePrivacyDlpV2FieldId; /** @@ -719,7 +719,7 @@ export namespace dlp_v2 { */ cryptoKey?: Schema$GooglePrivacyDlpV2CryptoKey; /** - * The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE. + * The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE. */ surrogateInfoType?: Schema$GooglePrivacyDlpV2InfoType; } @@ -750,7 +750,7 @@ export namespace dlp_v2 { unwrapped?: Schema$GooglePrivacyDlpV2UnwrappedCryptoKey; } /** - * Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/dlp/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. + * Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/dlp/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. */ export interface Schema$GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig { /** @@ -758,7 +758,7 @@ export namespace dlp_v2 { */ commonAlphabet?: string | null; /** - * The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and non-structured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 + * The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and non-structured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 */ context?: Schema$GooglePrivacyDlpV2FieldId; /** @@ -766,7 +766,7 @@ export namespace dlp_v2 { */ cryptoKey?: Schema$GooglePrivacyDlpV2CryptoKey; /** - * This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: <code>0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/</code> + * This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ */ customAlphabet?: string | null; /** @@ -774,7 +774,7 @@ export namespace dlp_v2 { */ radix?: number | null; /** - * The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE + * The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE */ surrogateInfoType?: Schema$GooglePrivacyDlpV2InfoType; } @@ -854,7 +854,7 @@ export namespace dlp_v2 { */ lowerBoundDays?: number | null; /** - * Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. + * Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. */ upperBoundDays?: number | null; } @@ -947,7 +947,7 @@ export namespace dlp_v2 { */ createTime?: string | null; /** - * ///////////// // The core content of the template // /////////////// + * ///////////// // The core content of the template // /////////////// */ deidentifyConfig?: Schema$GooglePrivacyDlpV2DeidentifyConfig; /** @@ -959,7 +959,7 @@ export namespace dlp_v2 { */ displayName?: string | null; /** - * Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` + * Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` */ name?: string | null; /** @@ -985,7 +985,7 @@ export namespace dlp_v2 { regionCode?: string | null; } /** - * A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset. + * A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset. */ export interface Schema$GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket { /** @@ -1027,7 +1027,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2DeltaPresenceEstimationResult { /** - * The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4. + * The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4. */ deltaPresenceEstimationHistogram?: Schema$GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket[]; } @@ -1041,7 +1041,7 @@ export namespace dlp_v2 { hotwordRule?: Schema$GooglePrivacyDlpV2HotwordRule; } /** - * Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. + * Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. */ export interface Schema$GooglePrivacyDlpV2Dictionary { /** @@ -1186,7 +1186,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2FieldTransformation { /** - * Only apply the transformation if the condition evaluates to true for the given `RecordCondition`. The conditions are allowed to reference fields that are not used in the actual transformation. Example Use Cases: - Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range. - Redact a field if the date of birth field is greater than 85. + * Only apply the transformation if the condition evaluates to true for the given `RecordCondition`. The conditions are allowed to reference fields that are not used in the actual transformation. Example Use Cases: - Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range. - Redact a field if the date of birth field is greater than 85. */ condition?: Schema$GooglePrivacyDlpV2RecordCondition; /** @@ -1211,7 +1211,7 @@ export namespace dlp_v2 { */ regexFileSet?: Schema$GooglePrivacyDlpV2CloudStorageRegexFileSet; /** - * The Cloud Storage url of the file(s) to scan, in the format `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed. If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that `gs://mybucket/` is equivalent to `gs://mybucket/x, and `gs://mybucket/directory/` is equivalent to `gs://mybucket/directory/x. Exactly one of `url` or `regex_file_set` must be set. + * The Cloud Storage url of the file(s) to scan, in the format `gs:///`. Trailing wildcard in the path is allowed. If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that `gs://mybucket/` is equivalent to `gs://mybucket/x, and `gs://mybucket/directory/` is equivalent to `gs://mybucket/directory/x. Exactly one of `url` or `regex_file_set` must be set. */ url?: string | null; } @@ -1236,7 +1236,7 @@ export namespace dlp_v2 { */ jobName?: string | null; /** - * The labels associated with this `Finding`. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"` + * The labels associated with this `Finding`. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"` */ labels?: {[key: string]: string} | null; /** @@ -1290,7 +1290,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2FinishDlpJobRequest {} /** - * Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}, i.e if lower_bound = 10 and upper_bound = 20 all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. + * Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}, i.e if lower_bound = 10 and upper_bound = 20 all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. */ export interface Schema$GooglePrivacyDlpV2FixedSizeBucketingConfig { /** @@ -1345,11 +1345,11 @@ export namespace dlp_v2 { */ containerDetails?: Schema$GooglePrivacyDlpV2Container; /** - * Offset in bytes of the line, from the beginning of the file, where the finding is located. Populate if the item being scanned is only part of a bigger item, such as a shard of a file and you want to track the absolute position of the finding. + * Offset in bytes of the line, from the beginning of the file, where the finding is located. Populate if the item being scanned is only part of a bigger item, such as a shard of a file and you want to track the absolute position of the finding. */ fileOffset?: string | null; /** - * Labels to represent user provided metadata about the data being inspected. If configured by the job, some key values may be required. The labels associated with `Finding`'s produced by hybrid inspection. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"` + * Labels to represent user provided metadata about the data being inspected. If configured by the job, some key values may be required. The labels associated with `Finding`'s produced by hybrid inspection. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"` */ labels?: {[key: string]: string} | null; /** @@ -1409,11 +1409,11 @@ export namespace dlp_v2 { */ description?: string | null; /** - * To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"` + * To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"` */ labels?: {[key: string]: string} | null; /** - * These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can be required. + * These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can be required. */ requiredFindingLabelKeys?: string[] | null; /** @@ -1452,7 +1452,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2InfoType { /** - * Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`. + * Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`. */ name?: string | null; } @@ -1546,7 +1546,7 @@ export namespace dlp_v2 { */ includeQuote?: boolean | null; /** - * Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time. + * Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time. */ infoTypes?: Schema$GooglePrivacyDlpV2InfoType[]; /** @@ -1686,7 +1686,7 @@ export namespace dlp_v2 { */ inspectConfig?: Schema$GooglePrivacyDlpV2InspectConfig; /** - * Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; + * Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; */ name?: string | null; /** @@ -1748,7 +1748,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2KAnonymityConfig { /** - * Message indicating that multiple rows might be associated to a single individual. If the same entity_id is associated to multiple quasi-identifier tuples over distinct rows, we consider the entire collection of tuples as the composite quasi-identifier. This collection is a multiset: the order in which the different tuples appear in the dataset is ignored, but their frequency is taken into account. Important note: a maximum of 1000 rows can be associated to a single entity ID. If more rows are associated with the same entity ID, some might be ignored. + * Message indicating that multiple rows might be associated to a single individual. If the same entity_id is associated to multiple quasi-identifier tuples over distinct rows, we consider the entire collection of tuples as the composite quasi-identifier. This collection is a multiset: the order in which the different tuples appear in the dataset is ignored, but their frequency is taken into account. Important note: a maximum of 1000 rows can be associated to a single entity ID. If more rows are associated with the same entity ID, some might be ignored. */ entityId?: Schema$GooglePrivacyDlpV2EntityId; /** @@ -1812,7 +1812,7 @@ export namespace dlp_v2 { */ partitionId?: Schema$GooglePrivacyDlpV2PartitionId; /** - * The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. A path can never be empty, and a path can have at most 100 elements. + * The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. A path can never be empty, and a path can have at most 100 elements. */ path?: Schema$GooglePrivacyDlpV2PathElement[]; } @@ -1843,7 +1843,7 @@ export namespace dlp_v2 { regionCode?: string | null; } /** - * A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records. + * A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records. */ export interface Schema$GooglePrivacyDlpV2KMapEstimationHistogramBucket { /** @@ -1885,7 +1885,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2KMapEstimationResult { /** - * The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10. + * The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10. */ kMapEstimationHistogram?: Schema$GooglePrivacyDlpV2KMapEstimationHistogramBucket[]; } @@ -2156,16 +2156,16 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2OutputStorageConfig { /** - * Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. + * Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. */ outputSchema?: string | null; /** - * Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. + * Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. */ table?: Schema$GooglePrivacyDlpV2BigQueryTable; } /** - * Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. + * Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. */ export interface Schema$GooglePrivacyDlpV2PartitionId { /** @@ -2178,7 +2178,7 @@ export namespace dlp_v2 { projectId?: string | null; } /** - * A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + * A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. */ export interface Schema$GooglePrivacyDlpV2PathElement { /** @@ -2514,7 +2514,7 @@ export namespace dlp_v2 { */ locationId?: string | null; /** - * Configuration for the re-identification of the content item. This field shares the same proto message type that is used for de-identification, however its usage here is for the reversal of the previous de-identification. Re-identification is performed by examining the transformations used to de-identify the items and executing the reverse. This requires that only reversible transformations be provided here. The reversible transformations are: - `CryptoDeterministicConfig` - `CryptoReplaceFfxFpeConfig` + * Configuration for the re-identification of the content item. This field shares the same proto message type that is used for de-identification, however its usage here is for the reversal of the previous de-identification. Re-identification is performed by examining the transformations used to de-identify the items and executing the reverse. This requires that only reversible transformations be provided here. The reversible transformations are: - `CryptoDeterministicConfig` - `CryptoReplaceFfxFpeConfig` */ reidentifyConfig?: Schema$GooglePrivacyDlpV2DeidentifyConfig; /** @@ -2622,7 +2622,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2Schedule { /** - * With this option a job is started a regular periodic basis. For example: every day (86400 seconds). A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days. + * With this option a job is started a regular periodic basis. For example: every day (86400 seconds). A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days. */ recurrencePeriodDuration?: string | null; } @@ -2735,7 +2735,7 @@ export namespace dlp_v2 { */ createTime?: string | null; /** - * Errors that occurred when creating this storedInfoType version, or anomalies detected in the storedInfoType data that render it unusable. Only the five most recent errors will be displayed, with the most recent error appearing first. For example, some of the data for stored custom dictionaries is put in the user's Google Cloud Storage bucket, and if this data is modified or deleted by the user or another system, the dictionary becomes invalid. If any errors occur, fix the problem indicated by the error message and use the UpdateStoredInfoType API method to create another version of the storedInfoType to continue using it, reusing the same `config` if it was not the source of the error. + * Errors that occurred when creating this storedInfoType version, or anomalies detected in the storedInfoType data that render it unusable. Only the five most recent errors will be displayed, with the most recent error appearing first. For example, some of the data for stored custom dictionaries is put in the user's Google Cloud Storage bucket, and if this data is modified or deleted by the user or another system, the dictionary becomes invalid. If any errors occur, fix the problem indicated by the error message and use the UpdateStoredInfoType API method to create another version of the storedInfoType to continue using it, reusing the same `config` if it was not the source of the error. */ errors?: Schema$GooglePrivacyDlpV2Error[]; /** @@ -2863,7 +2863,7 @@ export namespace dlp_v2 { */ startTime?: string | null; /** - * Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: `INTEGER`, `DATE`, `TIMESTAMP`, or `DATETIME` BigQuery column. For Datastore. Valid data types of the timestamp field are: `TIMESTAMP`. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid. + * Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: `INTEGER`, `DATE`, `TIMESTAMP`, or `DATETIME` BigQuery column. For Datastore. Valid data types of the timestamp field are: `TIMESTAMP`. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid. */ timestampField?: Schema$GooglePrivacyDlpV2FieldId; } @@ -3078,11 +3078,11 @@ export namespace dlp_v2 { words?: 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$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 { /** @@ -3090,7 +3090,7 @@ export namespace dlp_v2 { */ 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; /** @@ -3099,7 +3099,7 @@ export namespace dlp_v2 { message?: 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$GoogleTypeDate { /** @@ -3170,17 +3170,13 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.infoTypes.list({ - * // filter to only return infoTypes supported by certain parts of the - * // API. Defaults to supported_by=INSPECT. + * // filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. * filter: 'placeholder-value', - * // BCP-47 language code for localized infoType friendly - * // names. If omitted, or if localized strings are not available, - * // en-US strings will be returned. + * // BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. * languageCode: 'placeholder-value', * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // The parent resource name. - * // - Format:locations/[LOCATION-ID] + * // The parent resource name. - Format:locations/[LOCATION-ID] * parent: 'placeholder-value', * }); * console.log(res.data); @@ -3360,17 +3356,13 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.locations.infoTypes.list({ - * // filter to only return infoTypes supported by certain parts of the - * // API. Defaults to supported_by=INSPECT. + * // filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. * filter: 'placeholder-value', - * // BCP-47 language code for localized infoType friendly - * // names. If omitted, or if localized strings are not available, - * // en-US strings will be returned. + * // BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. * languageCode: 'placeholder-value', * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // The parent resource name. - * // - Format:locations/[LOCATION-ID] + * // The parent resource name. - Format:locations/[LOCATION-ID] * parent: 'locations/my-location', * }); * console.log(res.data); @@ -3567,11 +3559,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.deidentifyTemplates.create({ - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'organizations/my-organization', * * // Request body metadata @@ -3733,9 +3721,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.deidentifyTemplates.delete({ - * // Required. Resource name of the organization and deidentify template to be deleted, - * // for example `organizations/433245324/deidentifyTemplates/432452342` or - * // projects/project-id/deidentifyTemplates/432452342. + * // Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. * name: * 'organizations/my-organization/deidentifyTemplates/my-deidentifyTemplate', * }); @@ -3865,9 +3851,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.deidentifyTemplates.get({ - * // Required. Resource name of the organization and deidentify template to be read, for - * // example `organizations/433245324/deidentifyTemplates/432452342` or - * // projects/project-id/deidentifyTemplates/432452342. + * // Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. * name: * 'organizations/my-organization/deidentifyTemplates/my-deidentifyTemplate', * }); @@ -4018,31 +4002,13 @@ export namespace dlp_v2 { * const res = await dlp.organizations.deidentifyTemplates.list({ * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // Comma separated list of fields to order by, - * // followed by `asc` or `desc` postfix. This list is case-insensitive, - * // default sorting order is ascending, redundant space characters are - * // insignificant. - * // - * // Example: `name asc,update_time, create_time desc` - * // - * // Supported fields are: - * // - * // - `create_time`: corresponds to time the template was created. - * // - `update_time`: corresponds to time the template was last updated. - * // - `name`: corresponds to template's name. - * // - `display_name`: corresponds to template's display name. + * // Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. * orderBy: 'placeholder-value', - * // Size of the page, can be limited by server. If zero server returns - * // a page of max size 100. + * // Size of the page, can be limited by server. If zero server returns a page of max size 100. * pageSize: 'placeholder-value', - * // Page token to continue retrieval. Comes from previous call - * // to `ListDeidentifyTemplates`. + * // Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. * pageToken: 'placeholder-value', - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'organizations/my-organization', * }); * console.log(res.data); @@ -4064,7 +4030,7 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId Deprecated. This field has no effect. - * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. * @param {string} params.parent Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] @@ -4200,9 +4166,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.deidentifyTemplates.patch({ - * // Required. Resource name of organization and deidentify template to be updated, for - * // example `organizations/433245324/deidentifyTemplates/432452342` or - * // projects/project-id/deidentifyTemplates/432452342. + * // Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. * name: * 'organizations/my-organization/deidentifyTemplates/my-deidentifyTemplate', * @@ -4368,7 +4332,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** @@ -4430,11 +4394,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.inspectTemplates.create({ - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'organizations/my-organization', * * // Request body metadata @@ -4590,9 +4550,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.inspectTemplates.delete({ - * // Required. Resource name of the organization and inspectTemplate to be deleted, for - * // example `organizations/433245324/inspectTemplates/432452342` or - * // projects/project-id/inspectTemplates/432452342. + * // Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. * name: 'organizations/my-organization/inspectTemplates/my-inspectTemplate', * }); * console.log(res.data); @@ -4721,9 +4679,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.inspectTemplates.get({ - * // Required. Resource name of the organization and inspectTemplate to be read, for - * // example `organizations/433245324/inspectTemplates/432452342` or - * // projects/project-id/inspectTemplates/432452342. + * // Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. * name: 'organizations/my-organization/inspectTemplates/my-inspectTemplate', * }); * console.log(res.data); @@ -4867,31 +4823,13 @@ export namespace dlp_v2 { * const res = await dlp.organizations.inspectTemplates.list({ * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // Comma separated list of fields to order by, - * // followed by `asc` or `desc` postfix. This list is case-insensitive, - * // default sorting order is ascending, redundant space characters are - * // insignificant. - * // - * // Example: `name asc,update_time, create_time desc` - * // - * // Supported fields are: - * // - * // - `create_time`: corresponds to time the template was created. - * // - `update_time`: corresponds to time the template was last updated. - * // - `name`: corresponds to template's name. - * // - `display_name`: corresponds to template's display name. + * // Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. * orderBy: 'placeholder-value', - * // Size of the page, can be limited by server. If zero server returns - * // a page of max size 100. + * // Size of the page, can be limited by server. If zero server returns a page of max size 100. * pageSize: 'placeholder-value', - * // Page token to continue retrieval. Comes from previous call - * // to `ListInspectTemplates`. + * // Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. * pageToken: 'placeholder-value', - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'organizations/my-organization', * }); * console.log(res.data); @@ -4913,7 +4851,7 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId Deprecated. This field has no effect. - * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. * @param {string} params.parent Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] @@ -5050,9 +4988,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.inspectTemplates.patch({ - * // Required. Resource name of organization and inspectTemplate to be updated, for - * // example `organizations/433245324/inspectTemplates/432452342` or - * // projects/project-id/inspectTemplates/432452342. + * // Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. * name: 'organizations/my-organization/inspectTemplates/my-inspectTemplate', * * // Request body metadata @@ -5211,7 +5147,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** @@ -5292,11 +5228,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.locations.deidentifyTemplates.create({ - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'organizations/my-organization/locations/my-location', * * // Request body metadata @@ -5458,9 +5390,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.locations.deidentifyTemplates.delete({ - * // Required. Resource name of the organization and deidentify template to be deleted, - * // for example `organizations/433245324/deidentifyTemplates/432452342` or - * // projects/project-id/deidentifyTemplates/432452342. + * // Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. * name: * 'organizations/my-organization/locations/my-location/deidentifyTemplates/my-deidentifyTemplate', * }); @@ -5590,9 +5520,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.locations.deidentifyTemplates.get({ - * // Required. Resource name of the organization and deidentify template to be read, for - * // example `organizations/433245324/deidentifyTemplates/432452342` or - * // projects/project-id/deidentifyTemplates/432452342. + * // Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. * name: * 'organizations/my-organization/locations/my-location/deidentifyTemplates/my-deidentifyTemplate', * }); @@ -5743,31 +5671,13 @@ export namespace dlp_v2 { * const res = await dlp.organizations.locations.deidentifyTemplates.list({ * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // Comma separated list of fields to order by, - * // followed by `asc` or `desc` postfix. This list is case-insensitive, - * // default sorting order is ascending, redundant space characters are - * // insignificant. - * // - * // Example: `name asc,update_time, create_time desc` - * // - * // Supported fields are: - * // - * // - `create_time`: corresponds to time the template was created. - * // - `update_time`: corresponds to time the template was last updated. - * // - `name`: corresponds to template's name. - * // - `display_name`: corresponds to template's display name. + * // Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. * orderBy: 'placeholder-value', - * // Size of the page, can be limited by server. If zero server returns - * // a page of max size 100. + * // Size of the page, can be limited by server. If zero server returns a page of max size 100. * pageSize: 'placeholder-value', - * // Page token to continue retrieval. Comes from previous call - * // to `ListDeidentifyTemplates`. + * // Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. * pageToken: 'placeholder-value', - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'organizations/my-organization/locations/my-location', * }); * console.log(res.data); @@ -5789,7 +5699,7 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId Deprecated. This field has no effect. - * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. * @param {string} params.parent Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] @@ -5925,9 +5835,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.locations.deidentifyTemplates.patch({ - * // Required. Resource name of organization and deidentify template to be updated, for - * // example `organizations/433245324/deidentifyTemplates/432452342` or - * // projects/project-id/deidentifyTemplates/432452342. + * // Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. * name: * 'organizations/my-organization/locations/my-location/deidentifyTemplates/my-deidentifyTemplate', * @@ -6093,7 +6001,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** @@ -6155,11 +6063,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.locations.inspectTemplates.create({ - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'organizations/my-organization/locations/my-location', * * // Request body metadata @@ -6315,9 +6219,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.locations.inspectTemplates.delete({ - * // Required. Resource name of the organization and inspectTemplate to be deleted, for - * // example `organizations/433245324/inspectTemplates/432452342` or - * // projects/project-id/inspectTemplates/432452342. + * // Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. * name: * 'organizations/my-organization/locations/my-location/inspectTemplates/my-inspectTemplate', * }); @@ -6447,9 +6349,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.locations.inspectTemplates.get({ - * // Required. Resource name of the organization and inspectTemplate to be read, for - * // example `organizations/433245324/inspectTemplates/432452342` or - * // projects/project-id/inspectTemplates/432452342. + * // Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. * name: * 'organizations/my-organization/locations/my-location/inspectTemplates/my-inspectTemplate', * }); @@ -6594,31 +6494,13 @@ export namespace dlp_v2 { * const res = await dlp.organizations.locations.inspectTemplates.list({ * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // Comma separated list of fields to order by, - * // followed by `asc` or `desc` postfix. This list is case-insensitive, - * // default sorting order is ascending, redundant space characters are - * // insignificant. - * // - * // Example: `name asc,update_time, create_time desc` - * // - * // Supported fields are: - * // - * // - `create_time`: corresponds to time the template was created. - * // - `update_time`: corresponds to time the template was last updated. - * // - `name`: corresponds to template's name. - * // - `display_name`: corresponds to template's display name. + * // Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. * orderBy: 'placeholder-value', - * // Size of the page, can be limited by server. If zero server returns - * // a page of max size 100. + * // Size of the page, can be limited by server. If zero server returns a page of max size 100. * pageSize: 'placeholder-value', - * // Page token to continue retrieval. Comes from previous call - * // to `ListInspectTemplates`. + * // Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. * pageToken: 'placeholder-value', - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'organizations/my-organization/locations/my-location', * }); * console.log(res.data); @@ -6640,7 +6522,7 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId Deprecated. This field has no effect. - * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. * @param {string} params.parent Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] @@ -6777,9 +6659,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.locations.inspectTemplates.patch({ - * // Required. Resource name of organization and inspectTemplate to be updated, for - * // example `organizations/433245324/inspectTemplates/432452342` or - * // projects/project-id/inspectTemplates/432452342. + * // Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. * name: * 'organizations/my-organization/locations/my-location/inspectTemplates/my-inspectTemplate', * @@ -6939,7 +6819,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** @@ -7001,11 +6881,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.locations.storedInfoTypes.create({ - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'organizations/my-organization/locations/my-location', * * // Request body metadata @@ -7158,9 +7034,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.locations.storedInfoTypes.delete({ - * // Required. Resource name of the organization and storedInfoType to be deleted, for - * // example `organizations/433245324/storedInfoTypes/432452342` or - * // projects/project-id/storedInfoTypes/432452342. + * // Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. * name: * 'organizations/my-organization/locations/my-location/storedInfoTypes/my-storedInfoType', * }); @@ -7290,9 +7164,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.locations.storedInfoTypes.get({ - * // Required. Resource name of the organization and storedInfoType to be read, for - * // example `organizations/433245324/storedInfoTypes/432452342` or - * // projects/project-id/storedInfoTypes/432452342. + * // Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. * name: * 'organizations/my-organization/locations/my-location/storedInfoTypes/my-storedInfoType', * }); @@ -7434,32 +7306,13 @@ export namespace dlp_v2 { * const res = await dlp.organizations.locations.storedInfoTypes.list({ * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // Comma separated list of fields to order by, - * // followed by `asc` or `desc` postfix. This list is case-insensitive, - * // default sorting order is ascending, redundant space characters are - * // insignificant. - * // - * // Example: `name asc, display_name, create_time desc` - * // - * // Supported fields are: - * // - * // - `create_time`: corresponds to time the most recent version of the - * // resource was created. - * // - `state`: corresponds to the state of the resource. - * // - `name`: corresponds to resource name. - * // - `display_name`: corresponds to info type's display name. + * // Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. * orderBy: 'placeholder-value', - * // Size of the page, can be limited by server. If zero server returns - * // a page of max size 100. + * // Size of the page, can be limited by server. If zero server returns a page of max size 100. * pageSize: 'placeholder-value', - * // Page token to continue retrieval. Comes from previous call - * // to `ListStoredInfoTypes`. + * // Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. * pageToken: 'placeholder-value', - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'organizations/my-organization/locations/my-location', * }); * console.log(res.data); @@ -7481,7 +7334,7 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId Deprecated. This field has no effect. - * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. * @param {string} params.parent Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] @@ -7618,9 +7471,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.locations.storedInfoTypes.patch({ - * // Required. Resource name of organization and storedInfoType to be updated, for - * // example `organizations/433245324/storedInfoTypes/432452342` or - * // projects/project-id/storedInfoTypes/432452342. + * // Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. * name: * 'organizations/my-organization/locations/my-location/storedInfoTypes/my-storedInfoType', * @@ -7777,7 +7628,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** @@ -7839,11 +7690,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.storedInfoTypes.create({ - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'organizations/my-organization', * * // Request body metadata @@ -7996,9 +7843,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.storedInfoTypes.delete({ - * // Required. Resource name of the organization and storedInfoType to be deleted, for - * // example `organizations/433245324/storedInfoTypes/432452342` or - * // projects/project-id/storedInfoTypes/432452342. + * // Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. * name: 'organizations/my-organization/storedInfoTypes/my-storedInfoType', * }); * console.log(res.data); @@ -8127,9 +7972,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.storedInfoTypes.get({ - * // Required. Resource name of the organization and storedInfoType to be read, for - * // example `organizations/433245324/storedInfoTypes/432452342` or - * // projects/project-id/storedInfoTypes/432452342. + * // Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. * name: 'organizations/my-organization/storedInfoTypes/my-storedInfoType', * }); * console.log(res.data); @@ -8270,32 +8113,13 @@ export namespace dlp_v2 { * const res = await dlp.organizations.storedInfoTypes.list({ * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // Comma separated list of fields to order by, - * // followed by `asc` or `desc` postfix. This list is case-insensitive, - * // default sorting order is ascending, redundant space characters are - * // insignificant. - * // - * // Example: `name asc, display_name, create_time desc` - * // - * // Supported fields are: - * // - * // - `create_time`: corresponds to time the most recent version of the - * // resource was created. - * // - `state`: corresponds to the state of the resource. - * // - `name`: corresponds to resource name. - * // - `display_name`: corresponds to info type's display name. + * // Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. * orderBy: 'placeholder-value', - * // Size of the page, can be limited by server. If zero server returns - * // a page of max size 100. + * // Size of the page, can be limited by server. If zero server returns a page of max size 100. * pageSize: 'placeholder-value', - * // Page token to continue retrieval. Comes from previous call - * // to `ListStoredInfoTypes`. + * // Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. * pageToken: 'placeholder-value', - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'organizations/my-organization', * }); * console.log(res.data); @@ -8317,7 +8141,7 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId Deprecated. This field has no effect. - * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. * @param {string} params.parent Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] @@ -8454,9 +8278,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.organizations.storedInfoTypes.patch({ - * // Required. Resource name of organization and storedInfoType to be updated, for - * // example `organizations/433245324/storedInfoTypes/432452342` or - * // projects/project-id/storedInfoTypes/432452342. + * // Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. * name: 'organizations/my-organization/storedInfoTypes/my-storedInfoType', * * // Request body metadata @@ -8612,7 +8434,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** @@ -8678,7 +8500,7 @@ export namespace dlp_v2 { /** * dlp.projects.content.deidentify - * @desc De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. + * @desc De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. * @example * // Before running the sample: * // - Enable the API at: @@ -8703,9 +8525,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.content.deidentify({ - * // Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] + * // Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project', * * // Request body metadata @@ -8849,7 +8669,7 @@ export namespace dlp_v2 { /** * dlp.projects.content.inspect - * @desc Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text, + * @desc Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text, * @example * // Before running the sample: * // - Enable the API at: @@ -8874,9 +8694,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.content.inspect({ - * // Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] + * // Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project', * * // Request body metadata @@ -9034,9 +8852,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.content.reidentify({ - * // Required. The parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] + * // Required. The parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project', * * // Request body metadata @@ -9249,11 +9065,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.deidentifyTemplates.create({ - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project', * * // Request body metadata @@ -9415,9 +9227,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.deidentifyTemplates.delete({ - * // Required. Resource name of the organization and deidentify template to be deleted, - * // for example `organizations/433245324/deidentifyTemplates/432452342` or - * // projects/project-id/deidentifyTemplates/432452342. + * // Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. * name: 'projects/my-project/deidentifyTemplates/my-deidentifyTemplate', * }); * console.log(res.data); @@ -9546,9 +9356,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.deidentifyTemplates.get({ - * // Required. Resource name of the organization and deidentify template to be read, for - * // example `organizations/433245324/deidentifyTemplates/432452342` or - * // projects/project-id/deidentifyTemplates/432452342. + * // Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. * name: 'projects/my-project/deidentifyTemplates/my-deidentifyTemplate', * }); * console.log(res.data); @@ -9698,31 +9506,13 @@ export namespace dlp_v2 { * const res = await dlp.projects.deidentifyTemplates.list({ * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // Comma separated list of fields to order by, - * // followed by `asc` or `desc` postfix. This list is case-insensitive, - * // default sorting order is ascending, redundant space characters are - * // insignificant. - * // - * // Example: `name asc,update_time, create_time desc` - * // - * // Supported fields are: - * // - * // - `create_time`: corresponds to time the template was created. - * // - `update_time`: corresponds to time the template was last updated. - * // - `name`: corresponds to template's name. - * // - `display_name`: corresponds to template's display name. + * // Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. * orderBy: 'placeholder-value', - * // Size of the page, can be limited by server. If zero server returns - * // a page of max size 100. + * // Size of the page, can be limited by server. If zero server returns a page of max size 100. * pageSize: 'placeholder-value', - * // Page token to continue retrieval. Comes from previous call - * // to `ListDeidentifyTemplates`. + * // Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. * pageToken: 'placeholder-value', - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project', * }); * console.log(res.data); @@ -9744,7 +9534,7 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId Deprecated. This field has no effect. - * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. * @param {string} params.parent Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] @@ -9880,9 +9670,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.deidentifyTemplates.patch({ - * // Required. Resource name of organization and deidentify template to be updated, for - * // example `organizations/433245324/deidentifyTemplates/432452342` or - * // projects/project-id/deidentifyTemplates/432452342. + * // Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. * name: 'projects/my-project/deidentifyTemplates/my-deidentifyTemplate', * * // Request body metadata @@ -10047,7 +9835,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** @@ -10220,7 +10008,7 @@ export namespace dlp_v2 { /** * dlp.projects.dlpJobs.create - * @desc Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. + * @desc Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. * @example * // Before running the sample: * // - Enable the API at: @@ -10245,9 +10033,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.dlpJobs.create({ - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project', * * // Request body metadata @@ -10677,58 +10463,17 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.dlpJobs.list({ - * // Allows filtering. - * // - * // Supported syntax: - * // - * // * Filter expressions are made up of one or more restrictions. - * // * Restrictions can be combined by `AND` or `OR` logical operators. A - * // sequence of restrictions implicitly uses `AND`. - * // * A restriction has the form of `{field} {operator} {value}`. - * // * Supported fields/values for inspect jobs: - * // - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - * // - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - * // - `trigger_name` - The resource name of the trigger that created job. - * // - 'end_time` - Corresponds to time the job finished. - * // - 'start_time` - Corresponds to time the job finished. - * // * Supported fields for risk analysis jobs: - * // - `state` - RUNNING|CANCELED|FINISHED|FAILED - * // - 'end_time` - Corresponds to time the job finished. - * // - 'start_time` - Corresponds to time the job finished. - * // * The operator must be `=` or `!=`. - * // - * // Examples: - * // - * // * inspected_storage = cloud_storage AND state = done - * // * inspected_storage = cloud_storage OR inspected_storage = bigquery - * // * inspected_storage = cloud_storage AND (state = done OR state = canceled) - * // * end_time > \"2017-12-12T00:00:00+00:00\" - * // - * // The length of this field should be no more than 500 characters. + * // Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. * filter: 'placeholder-value', * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // Comma separated list of fields to order by, - * // followed by `asc` or `desc` postfix. This list is case-insensitive, - * // default sorting order is ascending, redundant space characters are - * // insignificant. - * // - * // Example: `name asc, end_time asc, create_time desc` - * // - * // Supported fields are: - * // - * // - `create_time`: corresponds to time the job was created. - * // - `end_time`: corresponds to time the job ended. - * // - `name`: corresponds to job's name. - * // - `state`: corresponds to `state` + * // Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` * orderBy: 'placeholder-value', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project', * // The type of job. Defaults to `DlpJobType.INSPECT` * type: 'placeholder-value', @@ -10751,9 +10496,9 @@ export namespace dlp_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * @param {string=} params.filter Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. * @param {string=} params.locationId Deprecated. This field has no effect. - * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. * @param {string} params.parent Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] @@ -10898,7 +10643,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Dlpjobs$List extends StandardParameters { /** - * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. */ filter?: string; /** @@ -10906,7 +10651,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` */ orderBy?: string; /** @@ -10935,7 +10680,7 @@ export namespace dlp_v2 { /** * dlp.projects.image.redact - * @desc Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. + * @desc Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. * @example * // Before running the sample: * // - Enable the API at: @@ -10960,9 +10705,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.image.redact({ - * // The parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] + * // The parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project', * * // Request body metadata @@ -11143,11 +10886,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.inspectTemplates.create({ - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project', * * // Request body metadata @@ -11303,9 +11042,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.inspectTemplates.delete({ - * // Required. Resource name of the organization and inspectTemplate to be deleted, for - * // example `organizations/433245324/inspectTemplates/432452342` or - * // projects/project-id/inspectTemplates/432452342. + * // Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. * name: 'projects/my-project/inspectTemplates/my-inspectTemplate', * }); * console.log(res.data); @@ -11434,9 +11171,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.inspectTemplates.get({ - * // Required. Resource name of the organization and inspectTemplate to be read, for - * // example `organizations/433245324/inspectTemplates/432452342` or - * // projects/project-id/inspectTemplates/432452342. + * // Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. * name: 'projects/my-project/inspectTemplates/my-inspectTemplate', * }); * console.log(res.data); @@ -11580,31 +11315,13 @@ export namespace dlp_v2 { * const res = await dlp.projects.inspectTemplates.list({ * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // Comma separated list of fields to order by, - * // followed by `asc` or `desc` postfix. This list is case-insensitive, - * // default sorting order is ascending, redundant space characters are - * // insignificant. - * // - * // Example: `name asc,update_time, create_time desc` - * // - * // Supported fields are: - * // - * // - `create_time`: corresponds to time the template was created. - * // - `update_time`: corresponds to time the template was last updated. - * // - `name`: corresponds to template's name. - * // - `display_name`: corresponds to template's display name. + * // Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. * orderBy: 'placeholder-value', - * // Size of the page, can be limited by server. If zero server returns - * // a page of max size 100. + * // Size of the page, can be limited by server. If zero server returns a page of max size 100. * pageSize: 'placeholder-value', - * // Page token to continue retrieval. Comes from previous call - * // to `ListInspectTemplates`. + * // Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. * pageToken: 'placeholder-value', - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project', * }); * console.log(res.data); @@ -11626,7 +11343,7 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId Deprecated. This field has no effect. - * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. * @param {string} params.parent Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] @@ -11763,9 +11480,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.inspectTemplates.patch({ - * // Required. Resource name of organization and inspectTemplate to be updated, for - * // example `organizations/433245324/inspectTemplates/432452342` or - * // projects/project-id/inspectTemplates/432452342. + * // Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. * name: 'projects/my-project/inspectTemplates/my-inspectTemplate', * * // Request body metadata @@ -11924,7 +11639,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** @@ -11986,8 +11701,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.jobTriggers.activate({ - * // Required. Resource name of the trigger to activate, for example - * // `projects/dlp-test-project/jobTriggers/53234423`. + * // Required. Resource name of the trigger to activate, for example `projects/dlp-test-project/jobTriggers/53234423`. * name: 'projects/my-project/jobTriggers/my-jobTrigger', * * // Request body metadata @@ -12141,9 +11855,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.jobTriggers.create({ - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project', * * // Request body metadata @@ -12303,8 +12015,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.jobTriggers.delete({ - * // Required. Resource name of the project and the triggeredJob, for example - * // `projects/dlp-test-project/jobTriggers/53234423`. + * // Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. * name: 'projects/my-project/jobTriggers/my-jobTrigger', * }); * console.log(res.data); @@ -12433,8 +12144,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.jobTriggers.get({ - * // Required. Resource name of the project and the triggeredJob, for example - * // `projects/dlp-test-project/jobTriggers/53234423`. + * // Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. * name: 'projects/my-project/jobTriggers/my-jobTrigger', * }); * console.log(res.data); @@ -12580,58 +12290,17 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.jobTriggers.list({ - * // Allows filtering. - * // - * // Supported syntax: - * // - * // * Filter expressions are made up of one or more restrictions. - * // * Restrictions can be combined by `AND` or `OR` logical operators. A - * // sequence of restrictions implicitly uses `AND`. - * // * A restriction has the form of `{field} {operator} {value}`. - * // * Supported fields/values for inspect jobs: - * // - `status` - HEALTHY|PAUSED|CANCELLED - * // - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - * // - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by - * // quotation marks. Nanoseconds are ignored. - * // - 'error_count' - Number of errors that have occurred while running. - * // * The operator must be `=` or `!=` for status and inspected_storage. - * // - * // Examples: - * // - * // * inspected_storage = cloud_storage AND status = HEALTHY - * // * inspected_storage = cloud_storage OR inspected_storage = bigquery - * // * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) - * // * last_run_time > \"2017-12-12T00:00:00+00:00\" - * // - * // The length of this field should be no more than 500 characters. + * // Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. * filter: 'placeholder-value', * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // Comma separated list of triggeredJob fields to order by, - * // followed by `asc` or `desc` postfix. This list is case-insensitive, - * // default sorting order is ascending, redundant space characters are - * // insignificant. - * // - * // Example: `name asc,update_time, create_time desc` - * // - * // Supported fields are: - * // - * // - `create_time`: corresponds to time the JobTrigger was created. - * // - `update_time`: corresponds to time the JobTrigger was last updated. - * // - `last_run_time`: corresponds to the last time the JobTrigger ran. - * // - `name`: corresponds to JobTrigger's name. - * // - `display_name`: corresponds to JobTrigger's display name. - * // - `status`: corresponds to JobTrigger's status. + * // Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. * orderBy: 'placeholder-value', * // Size of the page, can be limited by a server. * pageSize: 'placeholder-value', - * // Page token to continue retrieval. Comes from previous call - * // to ListJobTriggers. `order_by` field must not - * // change for subsequent calls. + * // Page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls. * pageToken: 'placeholder-value', - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project', * }); * console.log(res.data); @@ -12652,9 +12321,9 @@ export namespace dlp_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * @param {string=} params.filter Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. * @param {string=} params.locationId Deprecated. This field has no effect. - * @param {string=} params.orderBy Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. + * @param {string=} params.orderBy Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. * @param {integer=} params.pageSize Size of the page, can be limited by a server. * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls. * @param {string} params.parent Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] @@ -12785,8 +12454,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.jobTriggers.patch({ - * // Required. Resource name of the project and the triggeredJob, for example - * // `projects/dlp-test-project/jobTriggers/53234423`. + * // Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. * name: 'projects/my-project/jobTriggers/my-jobTrigger', * * // Request body metadata @@ -12957,7 +12625,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Jobtriggers$List extends StandardParameters { /** - * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. */ filter?: string; /** @@ -12965,7 +12633,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. + * Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. */ orderBy?: string; /** @@ -13031,7 +12699,7 @@ export namespace dlp_v2 { /** * dlp.projects.locations.content.deidentify - * @desc De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. + * @desc De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. * @example * // Before running the sample: * // - Enable the API at: @@ -13056,9 +12724,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.content.deidentify({ - * // Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] + * // Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -13202,7 +12868,7 @@ export namespace dlp_v2 { /** * dlp.projects.locations.content.inspect - * @desc Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text, + * @desc Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text, * @example * // Before running the sample: * // - Enable the API at: @@ -13227,9 +12893,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.content.inspect({ - * // Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] + * // Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -13387,9 +13051,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.content.reidentify({ - * // Required. The parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] + * // Required. The parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -13602,11 +13264,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.deidentifyTemplates.create({ - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -13768,9 +13426,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.deidentifyTemplates.delete({ - * // Required. Resource name of the organization and deidentify template to be deleted, - * // for example `organizations/433245324/deidentifyTemplates/432452342` or - * // projects/project-id/deidentifyTemplates/432452342. + * // Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. * name: * 'projects/my-project/locations/my-location/deidentifyTemplates/my-deidentifyTemplate', * }); @@ -13900,9 +13556,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.deidentifyTemplates.get({ - * // Required. Resource name of the organization and deidentify template to be read, for - * // example `organizations/433245324/deidentifyTemplates/432452342` or - * // projects/project-id/deidentifyTemplates/432452342. + * // Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. * name: * 'projects/my-project/locations/my-location/deidentifyTemplates/my-deidentifyTemplate', * }); @@ -14053,31 +13707,13 @@ export namespace dlp_v2 { * const res = await dlp.projects.locations.deidentifyTemplates.list({ * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // Comma separated list of fields to order by, - * // followed by `asc` or `desc` postfix. This list is case-insensitive, - * // default sorting order is ascending, redundant space characters are - * // insignificant. - * // - * // Example: `name asc,update_time, create_time desc` - * // - * // Supported fields are: - * // - * // - `create_time`: corresponds to time the template was created. - * // - `update_time`: corresponds to time the template was last updated. - * // - `name`: corresponds to template's name. - * // - `display_name`: corresponds to template's display name. + * // Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. * orderBy: 'placeholder-value', - * // Size of the page, can be limited by server. If zero server returns - * // a page of max size 100. + * // Size of the page, can be limited by server. If zero server returns a page of max size 100. * pageSize: 'placeholder-value', - * // Page token to continue retrieval. Comes from previous call - * // to `ListDeidentifyTemplates`. + * // Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. * pageToken: 'placeholder-value', - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); @@ -14099,7 +13735,7 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId Deprecated. This field has no effect. - * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. * @param {string} params.parent Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] @@ -14235,9 +13871,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.deidentifyTemplates.patch({ - * // Required. Resource name of organization and deidentify template to be updated, for - * // example `organizations/433245324/deidentifyTemplates/432452342` or - * // projects/project-id/deidentifyTemplates/432452342. + * // Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. * name: * 'projects/my-project/locations/my-location/deidentifyTemplates/my-deidentifyTemplate', * @@ -14403,7 +14037,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** @@ -14576,7 +14210,7 @@ export namespace dlp_v2 { /** * dlp.projects.locations.dlpJobs.create - * @desc Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. + * @desc Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. * @example * // Before running the sample: * // - Enable the API at: @@ -14601,9 +14235,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.dlpJobs.create({ - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -15169,8 +14801,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.dlpJobs.hybridInspect({ - * // Required. Resource name of the job to execute a hybrid inspect on, for example - * // `projects/dlp-test-project/dlpJob/53234423`. + * // Required. Resource name of the job to execute a hybrid inspect on, for example `projects/dlp-test-project/dlpJob/53234423`. * name: 'projects/my-project/locations/my-location/dlpJobs/my-dlpJob', * * // Request body metadata @@ -15323,58 +14954,17 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.dlpJobs.list({ - * // Allows filtering. - * // - * // Supported syntax: - * // - * // * Filter expressions are made up of one or more restrictions. - * // * Restrictions can be combined by `AND` or `OR` logical operators. A - * // sequence of restrictions implicitly uses `AND`. - * // * A restriction has the form of `{field} {operator} {value}`. - * // * Supported fields/values for inspect jobs: - * // - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - * // - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - * // - `trigger_name` - The resource name of the trigger that created job. - * // - 'end_time` - Corresponds to time the job finished. - * // - 'start_time` - Corresponds to time the job finished. - * // * Supported fields for risk analysis jobs: - * // - `state` - RUNNING|CANCELED|FINISHED|FAILED - * // - 'end_time` - Corresponds to time the job finished. - * // - 'start_time` - Corresponds to time the job finished. - * // * The operator must be `=` or `!=`. - * // - * // Examples: - * // - * // * inspected_storage = cloud_storage AND state = done - * // * inspected_storage = cloud_storage OR inspected_storage = bigquery - * // * inspected_storage = cloud_storage AND (state = done OR state = canceled) - * // * end_time > \"2017-12-12T00:00:00+00:00\" - * // - * // The length of this field should be no more than 500 characters. + * // Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. * filter: 'placeholder-value', * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // Comma separated list of fields to order by, - * // followed by `asc` or `desc` postfix. This list is case-insensitive, - * // default sorting order is ascending, redundant space characters are - * // insignificant. - * // - * // Example: `name asc, end_time asc, create_time desc` - * // - * // Supported fields are: - * // - * // - `create_time`: corresponds to time the job was created. - * // - `end_time`: corresponds to time the job ended. - * // - `name`: corresponds to job's name. - * // - `state`: corresponds to `state` + * // Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` * orderBy: 'placeholder-value', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project/locations/my-location', * // The type of job. Defaults to `DlpJobType.INSPECT` * type: 'placeholder-value', @@ -15397,9 +14987,9 @@ export namespace dlp_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * @param {string=} params.filter Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. * @param {string=} params.locationId Deprecated. This field has no effect. - * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. * @param {string} params.parent Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] @@ -15568,7 +15158,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Dlpjobs$List extends StandardParameters { /** - * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. */ filter?: string; /** @@ -15576,7 +15166,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` */ orderBy?: string; /** @@ -15605,7 +15195,7 @@ export namespace dlp_v2 { /** * dlp.projects.locations.image.redact - * @desc Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. + * @desc Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. * @example * // Before running the sample: * // - Enable the API at: @@ -15630,9 +15220,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.image.redact({ - * // The parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] + * // The parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -15813,11 +15401,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.inspectTemplates.create({ - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -15973,9 +15557,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.inspectTemplates.delete({ - * // Required. Resource name of the organization and inspectTemplate to be deleted, for - * // example `organizations/433245324/inspectTemplates/432452342` or - * // projects/project-id/inspectTemplates/432452342. + * // Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. * name: * 'projects/my-project/locations/my-location/inspectTemplates/my-inspectTemplate', * }); @@ -16105,9 +15687,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.inspectTemplates.get({ - * // Required. Resource name of the organization and inspectTemplate to be read, for - * // example `organizations/433245324/inspectTemplates/432452342` or - * // projects/project-id/inspectTemplates/432452342. + * // Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. * name: * 'projects/my-project/locations/my-location/inspectTemplates/my-inspectTemplate', * }); @@ -16252,31 +15832,13 @@ export namespace dlp_v2 { * const res = await dlp.projects.locations.inspectTemplates.list({ * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // Comma separated list of fields to order by, - * // followed by `asc` or `desc` postfix. This list is case-insensitive, - * // default sorting order is ascending, redundant space characters are - * // insignificant. - * // - * // Example: `name asc,update_time, create_time desc` - * // - * // Supported fields are: - * // - * // - `create_time`: corresponds to time the template was created. - * // - `update_time`: corresponds to time the template was last updated. - * // - `name`: corresponds to template's name. - * // - `display_name`: corresponds to template's display name. + * // Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. * orderBy: 'placeholder-value', - * // Size of the page, can be limited by server. If zero server returns - * // a page of max size 100. + * // Size of the page, can be limited by server. If zero server returns a page of max size 100. * pageSize: 'placeholder-value', - * // Page token to continue retrieval. Comes from previous call - * // to `ListInspectTemplates`. + * // Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. * pageToken: 'placeholder-value', - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); @@ -16298,7 +15860,7 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId Deprecated. This field has no effect. - * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. * @param {string} params.parent Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] @@ -16435,9 +15997,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.inspectTemplates.patch({ - * // Required. Resource name of organization and inspectTemplate to be updated, for - * // example `organizations/433245324/inspectTemplates/432452342` or - * // projects/project-id/inspectTemplates/432452342. + * // Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. * name: * 'projects/my-project/locations/my-location/inspectTemplates/my-inspectTemplate', * @@ -16597,7 +16157,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** @@ -16659,8 +16219,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.jobTriggers.activate({ - * // Required. Resource name of the trigger to activate, for example - * // `projects/dlp-test-project/jobTriggers/53234423`. + * // Required. Resource name of the trigger to activate, for example `projects/dlp-test-project/jobTriggers/53234423`. * name: 'projects/my-project/locations/my-location/jobTriggers/my-jobTrigger', * * // Request body metadata @@ -16814,9 +16373,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.jobTriggers.create({ - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -16976,8 +16533,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.jobTriggers.delete({ - * // Required. Resource name of the project and the triggeredJob, for example - * // `projects/dlp-test-project/jobTriggers/53234423`. + * // Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. * name: 'projects/my-project/locations/my-location/jobTriggers/my-jobTrigger', * }); * console.log(res.data); @@ -17106,8 +16662,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.jobTriggers.get({ - * // Required. Resource name of the project and the triggeredJob, for example - * // `projects/dlp-test-project/jobTriggers/53234423`. + * // Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. * name: 'projects/my-project/locations/my-location/jobTriggers/my-jobTrigger', * }); * console.log(res.data); @@ -17253,8 +16808,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.jobTriggers.hybridInspect({ - * // Required. Resource name of the trigger to execute a hybrid inspect on, for example - * // `projects/dlp-test-project/jobTriggers/53234423`. + * // Required. Resource name of the trigger to execute a hybrid inspect on, for example `projects/dlp-test-project/jobTriggers/53234423`. * name: 'projects/my-project/locations/my-location/jobTriggers/my-jobTrigger', * * // Request body metadata @@ -17407,58 +16961,17 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.jobTriggers.list({ - * // Allows filtering. - * // - * // Supported syntax: - * // - * // * Filter expressions are made up of one or more restrictions. - * // * Restrictions can be combined by `AND` or `OR` logical operators. A - * // sequence of restrictions implicitly uses `AND`. - * // * A restriction has the form of `{field} {operator} {value}`. - * // * Supported fields/values for inspect jobs: - * // - `status` - HEALTHY|PAUSED|CANCELLED - * // - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - * // - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by - * // quotation marks. Nanoseconds are ignored. - * // - 'error_count' - Number of errors that have occurred while running. - * // * The operator must be `=` or `!=` for status and inspected_storage. - * // - * // Examples: - * // - * // * inspected_storage = cloud_storage AND status = HEALTHY - * // * inspected_storage = cloud_storage OR inspected_storage = bigquery - * // * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) - * // * last_run_time > \"2017-12-12T00:00:00+00:00\" - * // - * // The length of this field should be no more than 500 characters. + * // Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. * filter: 'placeholder-value', * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // Comma separated list of triggeredJob fields to order by, - * // followed by `asc` or `desc` postfix. This list is case-insensitive, - * // default sorting order is ascending, redundant space characters are - * // insignificant. - * // - * // Example: `name asc,update_time, create_time desc` - * // - * // Supported fields are: - * // - * // - `create_time`: corresponds to time the JobTrigger was created. - * // - `update_time`: corresponds to time the JobTrigger was last updated. - * // - `last_run_time`: corresponds to the last time the JobTrigger ran. - * // - `name`: corresponds to JobTrigger's name. - * // - `display_name`: corresponds to JobTrigger's display name. - * // - `status`: corresponds to JobTrigger's status. + * // Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. * orderBy: 'placeholder-value', * // Size of the page, can be limited by a server. * pageSize: 'placeholder-value', - * // Page token to continue retrieval. Comes from previous call - * // to ListJobTriggers. `order_by` field must not - * // change for subsequent calls. + * // Page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls. * pageToken: 'placeholder-value', - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); @@ -17479,9 +16992,9 @@ export namespace dlp_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * @param {string=} params.filter Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. * @param {string=} params.locationId Deprecated. This field has no effect. - * @param {string=} params.orderBy Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. + * @param {string=} params.orderBy Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. * @param {integer=} params.pageSize Size of the page, can be limited by a server. * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls. * @param {string} params.parent Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] @@ -17612,8 +17125,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.jobTriggers.patch({ - * // Required. Resource name of the project and the triggeredJob, for example - * // `projects/dlp-test-project/jobTriggers/53234423`. + * // Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. * name: 'projects/my-project/locations/my-location/jobTriggers/my-jobTrigger', * * // Request body metadata @@ -17796,7 +17308,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Jobtriggers$List extends StandardParameters { /** - * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. */ filter?: string; /** @@ -17804,7 +17316,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. + * Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. */ orderBy?: string; /** @@ -17866,11 +17378,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.storedInfoTypes.create({ - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -18023,9 +17531,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.storedInfoTypes.delete({ - * // Required. Resource name of the organization and storedInfoType to be deleted, for - * // example `organizations/433245324/storedInfoTypes/432452342` or - * // projects/project-id/storedInfoTypes/432452342. + * // Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. * name: * 'projects/my-project/locations/my-location/storedInfoTypes/my-storedInfoType', * }); @@ -18155,9 +17661,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.storedInfoTypes.get({ - * // Required. Resource name of the organization and storedInfoType to be read, for - * // example `organizations/433245324/storedInfoTypes/432452342` or - * // projects/project-id/storedInfoTypes/432452342. + * // Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. * name: * 'projects/my-project/locations/my-location/storedInfoTypes/my-storedInfoType', * }); @@ -18299,32 +17803,13 @@ export namespace dlp_v2 { * const res = await dlp.projects.locations.storedInfoTypes.list({ * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // Comma separated list of fields to order by, - * // followed by `asc` or `desc` postfix. This list is case-insensitive, - * // default sorting order is ascending, redundant space characters are - * // insignificant. - * // - * // Example: `name asc, display_name, create_time desc` - * // - * // Supported fields are: - * // - * // - `create_time`: corresponds to time the most recent version of the - * // resource was created. - * // - `state`: corresponds to the state of the resource. - * // - `name`: corresponds to resource name. - * // - `display_name`: corresponds to info type's display name. + * // Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. * orderBy: 'placeholder-value', - * // Size of the page, can be limited by server. If zero server returns - * // a page of max size 100. + * // Size of the page, can be limited by server. If zero server returns a page of max size 100. * pageSize: 'placeholder-value', - * // Page token to continue retrieval. Comes from previous call - * // to `ListStoredInfoTypes`. + * // Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. * pageToken: 'placeholder-value', - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); @@ -18346,7 +17831,7 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId Deprecated. This field has no effect. - * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. * @param {string} params.parent Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] @@ -18483,9 +17968,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.locations.storedInfoTypes.patch({ - * // Required. Resource name of organization and storedInfoType to be updated, for - * // example `organizations/433245324/storedInfoTypes/432452342` or - * // projects/project-id/storedInfoTypes/432452342. + * // Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. * name: * 'projects/my-project/locations/my-location/storedInfoTypes/my-storedInfoType', * @@ -18642,7 +18125,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** @@ -18704,11 +18187,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.storedInfoTypes.create({ - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project', * * // Request body metadata @@ -18861,9 +18340,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.storedInfoTypes.delete({ - * // Required. Resource name of the organization and storedInfoType to be deleted, for - * // example `organizations/433245324/storedInfoTypes/432452342` or - * // projects/project-id/storedInfoTypes/432452342. + * // Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. * name: 'projects/my-project/storedInfoTypes/my-storedInfoType', * }); * console.log(res.data); @@ -18992,9 +18469,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.storedInfoTypes.get({ - * // Required. Resource name of the organization and storedInfoType to be read, for - * // example `organizations/433245324/storedInfoTypes/432452342` or - * // projects/project-id/storedInfoTypes/432452342. + * // Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. * name: 'projects/my-project/storedInfoTypes/my-storedInfoType', * }); * console.log(res.data); @@ -19135,32 +18610,13 @@ export namespace dlp_v2 { * const res = await dlp.projects.storedInfoTypes.list({ * // Deprecated. This field has no effect. * locationId: 'placeholder-value', - * // Comma separated list of fields to order by, - * // followed by `asc` or `desc` postfix. This list is case-insensitive, - * // default sorting order is ascending, redundant space characters are - * // insignificant. - * // - * // Example: `name asc, display_name, create_time desc` - * // - * // Supported fields are: - * // - * // - `create_time`: corresponds to time the most recent version of the - * // resource was created. - * // - `state`: corresponds to the state of the resource. - * // - `name`: corresponds to resource name. - * // - `display_name`: corresponds to info type's display name. + * // Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. * orderBy: 'placeholder-value', - * // Size of the page, can be limited by server. If zero server returns - * // a page of max size 100. + * // Size of the page, can be limited by server. If zero server returns a page of max size 100. * pageSize: 'placeholder-value', - * // Page token to continue retrieval. Comes from previous call - * // to `ListStoredInfoTypes`. + * // Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. * pageToken: 'placeholder-value', - * // Required. Parent resource name. - * // - Format:projects/[PROJECT-ID] - * // - Format:organizations/[ORGANIZATION-ID] - * // - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - * // - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + * // Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] * parent: 'projects/my-project', * }); * console.log(res.data); @@ -19182,7 +18638,7 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId Deprecated. This field has no effect. - * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. * @param {string} params.parent Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format:organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] @@ -19319,9 +18775,7 @@ export namespace dlp_v2 { * * // Do the magic * const res = await dlp.projects.storedInfoTypes.patch({ - * // Required. Resource name of organization and storedInfoType to be updated, for - * // example `organizations/433245324/storedInfoTypes/432452342` or - * // projects/project-id/storedInfoTypes/432452342. + * // Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. * name: 'projects/my-project/storedInfoTypes/my-storedInfoType', * * // Request body metadata @@ -19477,7 +18931,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** diff --git a/src/apis/gmail/v1.ts b/src/apis/gmail/v1.ts index e7a9f7f22e..9994a6285c 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 "Set up mail delegation" 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 <a href="https://support.google.com/mail/answer/138350">"Set up mail delegation"</a> 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: 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:<somemsgid@example.com> 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: 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:<somemsgid@example.com> 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: # 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: <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 */ 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: # 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: <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 */ textColor?: string | null; } /** - * Language settings for an account. These settings correspond to the "Language settings" feature in the web interface. + * 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. */ export interface Schema$LanguageSettings { /** - * 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). + * 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). */ 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 messages.get 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 <a href="/gmail/api/v1/reference/users/messages/get">messages.get</a> 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 labels.get method can fetch additional label details. + * 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. */ 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 messages.get method. + * 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. */ 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 threads.get 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 <a href="/gmail/api/v1/reference/users/threads/get">threads.get</a> 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: 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 + * 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 */ 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 RFC 1521. + * 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>. */ 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 "Send Mail As" 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 <a href="https://support.google.com/mail/answer/22370">"Send Mail As"</a> 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 treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases. + * 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. */ 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 "Vacation responder" feature in the web interface. + * 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. */ 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,7 +906,8 @@ 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); @@ -1044,7 +1045,8 @@ 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); @@ -1172,7 +1174,8 @@ 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 @@ -1350,7 +1353,8 @@ 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 @@ -1510,7 +1514,8 @@ 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); @@ -1644,7 +1649,8 @@ 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); @@ -1782,15 +1788,20 @@ 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); @@ -1815,7 +1826,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. @@ -1935,7 +1946,8 @@ 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 @@ -2101,7 +2113,8 @@ 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 @@ -2295,7 +2308,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; /** @@ -2408,9 +2421,22 @@ 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); @@ -2436,7 +2462,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. @@ -2544,7 +2570,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; /** @@ -2590,7 +2616,8 @@ 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 @@ -2754,7 +2781,8 @@ 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); @@ -2887,7 +2915,8 @@ 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); @@ -3033,7 +3062,8 @@ 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); @@ -3173,7 +3203,8 @@ 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 @@ -3338,7 +3369,8 @@ 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 @@ -3554,7 +3586,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: @@ -3579,7 +3611,8 @@ 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 @@ -3714,7 +3747,8 @@ 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 @@ -3823,7 +3857,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: @@ -3850,7 +3884,8 @@ 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); @@ -3987,9 +4022,11 @@ 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); @@ -4135,15 +4172,21 @@ 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 @@ -4191,7 +4234,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. @@ -4317,11 +4360,15 @@ 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 @@ -4369,7 +4416,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 @@ -4494,7 +4541,8 @@ 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', @@ -4502,9 +4550,14 @@ 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); @@ -4530,7 +4583,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. @@ -4652,7 +4705,8 @@ 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 @@ -4807,7 +4861,8 @@ 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 @@ -4978,7 +5033,8 @@ 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); @@ -5122,7 +5178,8 @@ 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); @@ -5292,7 +5349,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; /** @@ -5335,7 +5392,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; /** @@ -5386,7 +5443,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; /** @@ -5503,7 +5560,8 @@ 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); @@ -5676,7 +5734,8 @@ 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); @@ -5698,7 +5757,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 @@ -5815,7 +5874,8 @@ 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); @@ -5838,7 +5898,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 @@ -5954,7 +6014,8 @@ 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); @@ -5974,7 +6035,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 @@ -6089,7 +6150,8 @@ 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); @@ -6110,7 +6172,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 @@ -6226,7 +6288,8 @@ 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); @@ -6253,7 +6316,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 @@ -6338,7 +6401,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: @@ -6363,7 +6426,8 @@ 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 @@ -6395,7 +6459,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. @@ -6508,7 +6572,8 @@ 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 @@ -6542,7 +6607,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. @@ -6629,7 +6694,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: @@ -6654,7 +6719,8 @@ 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 @@ -6682,7 +6748,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. @@ -6795,7 +6861,8 @@ 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 @@ -6825,7 +6892,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. @@ -6937,7 +7004,8 @@ 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 @@ -6979,7 +7047,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. @@ -7069,42 +7137,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; @@ -7116,7 +7184,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; @@ -7128,7 +7196,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; @@ -7140,7 +7208,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; @@ -7152,7 +7220,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; @@ -7170,7 +7238,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: @@ -7195,7 +7263,8 @@ 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 @@ -7225,7 +7294,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. @@ -7311,7 +7380,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: @@ -7338,7 +7407,8 @@ 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); @@ -7354,7 +7424,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 @@ -7438,7 +7508,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: @@ -7468,9 +7538,11 @@ 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); @@ -7492,7 +7564,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 @@ -7578,7 +7650,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: @@ -7608,7 +7680,8 @@ 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); @@ -7628,7 +7701,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 @@ -7720,7 +7793,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; @@ -7736,7 +7809,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; } @@ -7747,14 +7820,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; } @@ -7792,7 +7865,8 @@ 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 @@ -7937,7 +8011,8 @@ 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); @@ -8068,7 +8143,8 @@ 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); @@ -8206,7 +8282,8 @@ 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); @@ -8363,7 +8440,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: @@ -8388,7 +8465,8 @@ 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 @@ -8418,7 +8496,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. @@ -8507,7 +8585,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: @@ -8534,7 +8612,8 @@ 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); @@ -8550,7 +8629,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 @@ -8666,7 +8745,8 @@ 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); @@ -8688,7 +8768,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 @@ -8807,7 +8887,8 @@ 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); @@ -8827,7 +8908,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 @@ -8923,7 +9004,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; @@ -8939,7 +9020,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; } @@ -8950,14 +9031,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; } @@ -8974,7 +9055,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: @@ -8999,7 +9080,8 @@ 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 @@ -9043,7 +9125,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. @@ -9130,7 +9212,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: @@ -9157,7 +9239,8 @@ 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); @@ -9173,7 +9256,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 @@ -9256,7 +9339,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: @@ -9288,7 +9371,8 @@ 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); @@ -9317,7 +9401,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 @@ -9402,7 +9486,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: @@ -9432,7 +9516,8 @@ 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); @@ -9452,7 +9537,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 @@ -9571,7 +9656,8 @@ 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 @@ -9616,7 +9702,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. @@ -9702,7 +9788,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: @@ -9732,7 +9818,8 @@ 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 @@ -9777,7 +9864,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. @@ -9863,7 +9950,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: @@ -9890,7 +9977,8 @@ 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); @@ -9906,7 +9994,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 @@ -9992,7 +10080,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; @@ -10008,7 +10096,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; } @@ -10019,14 +10107,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; } @@ -10037,7 +10125,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; @@ -10053,7 +10141,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; @@ -10069,7 +10157,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; } @@ -10112,9 +10200,11 @@ 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); @@ -10248,9 +10338,11 @@ 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); @@ -10392,9 +10484,11 @@ 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 @@ -10553,9 +10647,11 @@ 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); @@ -10697,9 +10793,11 @@ 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); @@ -10907,7 +11005,8 @@ 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); @@ -11046,7 +11145,8 @@ 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); @@ -11188,7 +11288,8 @@ 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', @@ -11196,9 +11297,14 @@ 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); @@ -11224,7 +11330,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. @@ -11344,7 +11450,8 @@ 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 @@ -11493,7 +11600,8 @@ 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); @@ -11632,7 +11740,8 @@ 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); @@ -11789,7 +11898,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/manufacturers/v1.ts b/src/apis/manufacturers/v1.ts index 7bf897ce72..be54e5d5fa 100644 --- a/src/apis/manufacturers/v1.ts +++ b/src/apis/manufacturers/v1.ts @@ -240,7 +240,7 @@ export namespace manufacturers_v1 { */ richProductContent?: string[] | null; /** - * The scent of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#scent. + * The scent of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#scent. */ scent?: string | null; /** @@ -316,7 +316,7 @@ export namespace manufacturers_v1 { status?: 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 {} /** @@ -434,11 +434,11 @@ export namespace manufacturers_v1 { */ issues?: Schema$Issue[]; /** - * Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. + * Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. */ name?: string | null; /** - * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. + * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. */ parent?: string | null; /** @@ -510,20 +510,9 @@ export namespace manufacturers_v1 { * * // Do the magic * const res = await manufacturers.accounts.products.delete({ - * // Name in the format `{target_country}:{content_language}:{product_id}`. - * // - * // `target_country` - The target country of the product as a CLDR territory - * // code (for example, US). - * // - * // `content_language` - The content language of the product as a two-letter - * // ISO 639-1 language code (for example, en). - * // - * // `product_id` - The ID of the product. For more information, see - * // https://support.google.com/manufacturers/answer/6124116#id. + * // Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. * name: '[^/]+', - * // Parent ID in the format `accounts/{account_id}`. - * // - * // `account_id` - The ID of the Manufacturer Center account. + * // Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. * parent: 'accounts/my-account', * }); * console.log(res.data); @@ -541,8 +530,8 @@ export namespace manufacturers_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. - * @param {string} params.parent Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. + * @param {string} params.name Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. + * @param {string} params.parent Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. * @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 @@ -629,7 +618,7 @@ export namespace manufacturers_v1 { /** * manufacturers.accounts.products.get - * @desc Gets the product from a Manufacturer Center account, including product issues. A recently updated product takes around 15 minutes to process. Changes are only visible after it has been processed. While some issues may be available once the product has been processed, other issues may take days to appear. + * @desc Gets the product from a Manufacturer Center account, including product issues. A recently updated product takes around 15 minutes to process. Changes are only visible after it has been processed. While some issues may be available once the product has been processed, other issues may take days to appear. * @example * // Before running the sample: * // - Enable the API at: @@ -654,23 +643,11 @@ export namespace manufacturers_v1 { * * // Do the magic * const res = await manufacturers.accounts.products.get({ - * // The information to be included in the response. Only sections listed here - * // will be returned. + * // The information to be included in the response. Only sections listed here will be returned. * include: 'placeholder-value', - * // Name in the format `{target_country}:{content_language}:{product_id}`. - * // - * // `target_country` - The target country of the product as a CLDR territory - * // code (for example, US). - * // - * // `content_language` - The content language of the product as a two-letter - * // ISO 639-1 language code (for example, en). - * // - * // `product_id` - The ID of the product. For more information, see - * // https://support.google.com/manufacturers/answer/6124116#id. + * // Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. * name: '[^/]+', - * // Parent ID in the format `accounts/{account_id}`. - * // - * // `account_id` - The ID of the Manufacturer Center account. + * // Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. * parent: 'accounts/my-account', * }); * console.log(res.data); @@ -698,8 +675,8 @@ export namespace manufacturers_v1 { * * @param {object} params Parameters for request * @param {string=} params.include The information to be included in the response. Only sections listed here will be returned. - * @param {string} params.name Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. - * @param {string} params.parent Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. + * @param {string} params.name Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. + * @param {string} params.parent Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. * @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 @@ -811,17 +788,13 @@ export namespace manufacturers_v1 { * * // Do the magic * const res = await manufacturers.accounts.products.list({ - * // The information to be included in the response. Only sections listed here - * // will be returned. + * // The information to be included in the response. Only sections listed here will be returned. * include: 'placeholder-value', - * // Maximum number of product statuses to return in the response, used for - * // paging. + * // Maximum number of product statuses to return in the response, used for paging. * pageSize: 'placeholder-value', * // The token returned by the previous request. * pageToken: 'placeholder-value', - * // Parent ID in the format `accounts/{account_id}`. - * // - * // `account_id` - The ID of the Manufacturer Center account. + * // Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. * parent: 'accounts/my-account', * }); * console.log(res.data); @@ -845,7 +818,7 @@ export namespace manufacturers_v1 { * @param {string=} params.include The information to be included in the response. Only sections listed here will be returned. * @param {integer=} params.pageSize Maximum number of product statuses to return in the response, used for paging. * @param {string=} params.pageToken The token returned by the previous request. - * @param {string} params.parent Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. + * @param {string} params.parent Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. * @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 @@ -937,7 +910,7 @@ export namespace manufacturers_v1 { /** * manufacturers.accounts.products.update - * @desc Inserts or updates the attributes of the product in a Manufacturer Center account. Creates a product with the provided attributes. If the product already exists, then all attributes are replaced with the new ones. The checks at upload time are minimal. All required attributes need to be present for a product to be valid. Issues may show up later after the API has accepted a new upload for a product and it is possible to overwrite an existing valid product with an invalid product. To detect this, you should retrieve the product and check it for issues once the new version is available. Uploaded attributes first need to be processed before they can be retrieved. Until then, new products will be unavailable, and retrieval of previously uploaded products will return the original state of the product. + * @desc Inserts or updates the attributes of the product in a Manufacturer Center account. Creates a product with the provided attributes. If the product already exists, then all attributes are replaced with the new ones. The checks at upload time are minimal. All required attributes need to be present for a product to be valid. Issues may show up later after the API has accepted a new upload for a product and it is possible to overwrite an existing valid product with an invalid product. To detect this, you should retrieve the product and check it for issues once the new version is available. Uploaded attributes first need to be processed before they can be retrieved. Until then, new products will be unavailable, and retrieval of previously uploaded products will return the original state of the product. * @example * // Before running the sample: * // - Enable the API at: @@ -962,20 +935,9 @@ export namespace manufacturers_v1 { * * // Do the magic * const res = await manufacturers.accounts.products.update({ - * // Name in the format `{target_country}:{content_language}:{product_id}`. - * // - * // `target_country` - The target country of the product as a CLDR territory - * // code (for example, US). - * // - * // `content_language` - The content language of the product as a two-letter - * // ISO 639-1 language code (for example, en). - * // - * // `product_id` - The ID of the product. For more information, see - * // https://support.google.com/manufacturers/answer/6124116#id. + * // Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. * name: '[^/]+', - * // Parent ID in the format `accounts/{account_id}`. - * // - * // `account_id` - The ID of the Manufacturer Center account. + * // Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. * parent: 'accounts/my-account', * * // Request body metadata @@ -1036,8 +998,8 @@ export namespace manufacturers_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. - * @param {string} params.parent Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. + * @param {string} params.name Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. + * @param {string} params.parent Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. * @param {().Attributes} 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. @@ -1127,11 +1089,11 @@ export namespace manufacturers_v1 { export interface Params$Resource$Accounts$Products$Delete extends StandardParameters { /** - * Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. + * Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. */ name?: string; /** - * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. + * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. */ parent?: string; } @@ -1142,11 +1104,11 @@ export namespace manufacturers_v1 { */ include?: string[]; /** - * Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. + * Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. */ name?: string; /** - * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. + * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. */ parent?: string; } @@ -1165,18 +1127,18 @@ export namespace manufacturers_v1 { */ pageToken?: string; /** - * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. + * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. */ parent?: string; } export interface Params$Resource$Accounts$Products$Update extends StandardParameters { /** - * Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. + * Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. */ name?: string; /** - * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. + * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. */ parent?: string; diff --git a/src/apis/oslogin/v1alpha.ts b/src/apis/oslogin/v1alpha.ts index 39bcd0a4c7..90822e4956 100644 --- a/src/apis/oslogin/v1alpha.ts +++ b/src/apis/oslogin/v1alpha.ts @@ -128,7 +128,7 @@ export namespace oslogin_v1alpha { } /** - * 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 {} /** @@ -219,7 +219,7 @@ export namespace oslogin_v1alpha { */ fingerprint?: string | null; /** - * Public key text in SSH format, defined by <a href="https://www.ietf.org/rfc/rfc4253.txt" target="_blank">RFC4253</a> section 6.6. + * Public key text in SSH format, defined by RFC4253 section 6.6. */ key?: string | null; /** @@ -614,9 +614,7 @@ export namespace oslogin_v1alpha { * * // Do the magic * const res = await oslogin.users.projects.delete({ - * // A reference to the POSIX account to update. POSIX accounts are identified - * // by the project ID they are associated with. A reference to the POSIX - * // account is in format `users/{user}/projects/{project}`. + * // A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`. * name: 'users/my-user/projects/my-project', * // The type of operating system associated with the account. * operatingSystemType: 'placeholder-value', @@ -767,9 +765,7 @@ export namespace oslogin_v1alpha { * * // Do the magic * const res = await oslogin.users.sshPublicKeys.delete({ - * // The fingerprint of the public key to update. Public keys are identified by - * // their SHA-256 fingerprint. The fingerprint of the public key is in format - * // `users/{user}/sshPublicKeys/{fingerprint}`. + * // The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. * name: 'users/my-user/sshPublicKeys/my-sshPublicKey', * }); * console.log(res.data); @@ -898,9 +894,7 @@ export namespace oslogin_v1alpha { * * // Do the magic * const res = await oslogin.users.sshPublicKeys.get({ - * // The fingerprint of the public key to retrieve. Public keys are identified - * // by their SHA-256 fingerprint. The fingerprint of the public key is in - * // format `users/{user}/sshPublicKeys/{fingerprint}`. + * // The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. * name: 'users/my-user/sshPublicKeys/my-sshPublicKey', * }); * console.log(res.data); @@ -1034,9 +1028,7 @@ export namespace oslogin_v1alpha { * * // Do the magic * const res = await oslogin.users.sshPublicKeys.patch({ - * // The fingerprint of the public key to update. Public keys are identified by - * // their SHA-256 fingerprint. The fingerprint of the public key is in format - * // `users/{user}/sshPublicKeys/{fingerprint}`. + * // The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. * name: 'users/my-user/sshPublicKeys/my-sshPublicKey', * // Mask to control which fields get updated. Updates all if not present. * updateMask: 'placeholder-value', diff --git a/src/apis/people/v1.ts b/src/apis/people/v1.ts index ad6237f58e..8369073f38 100644 --- a/src/apis/people/v1.ts +++ b/src/apis/people/v1.ts @@ -274,6 +274,23 @@ export namespace people_v1 { */ url?: string | null; } + /** + * Arbitrary client data that is populated by clients. Duplicate keys and values are allowed. + */ + export interface Schema$ClientData { + /** + * The client specified key of the client data. + */ + key?: string | null; + /** + * Metadata about the client data. + */ + metadata?: Schema$FieldMetadata; + /** + * The client specified value of the client data. + */ + value?: string | null; + } /** * A contact group. */ @@ -363,7 +380,7 @@ export namespace people_v1 { */ copyMask?: string | null; /** - * Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to the copy mask with metadata and membership fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to the copy mask with metadata and membership fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined */ readMask?: string | null; /** @@ -950,6 +967,10 @@ export namespace people_v1 { * The person's calendar URLs. */ calendarUrls?: Schema$CalendarUrl[]; + /** + * The person's client data. + */ + clientData?: Schema$ClientData[]; /** * Output only. The person's cover photos. */ @@ -1360,7 +1381,7 @@ export namespace people_v1 { */ export interface Schema$UpdateContactPhotoRequest { /** - * Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined */ personFields?: string | null; /** @@ -2584,6 +2605,7 @@ export namespace people_v1 { * // "birthdays": [], * // "braggingRights": [], * // "calendarUrls": [], + * // "clientData": [], * // "coverPhotos": [], * // "emailAddresses": [], * // "etag": "my_etag", @@ -2932,7 +2954,7 @@ export namespace people_v1 { * * // Do the magic * const res = await people.people.createContact({ - * // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * personFields: 'placeholder-value', * // Optional. A mask of what source types to return. Defaults to ReadSourceType.CONTACT and ReadSourceType.PROFILE if not set. * sources: 'placeholder-value', @@ -2948,6 +2970,7 @@ export namespace people_v1 { * // "birthdays": [], * // "braggingRights": [], * // "calendarUrls": [], + * // "clientData": [], * // "coverPhotos": [], * // "emailAddresses": [], * // "etag": "my_etag", @@ -2991,6 +3014,7 @@ export namespace people_v1 { * // "birthdays": [], * // "braggingRights": [], * // "calendarUrls": [], + * // "clientData": [], * // "coverPhotos": [], * // "emailAddresses": [], * // "etag": "my_etag", @@ -3032,7 +3056,7 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.personFields Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * @param {string=} params.personFields Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * @param {string=} params.sources Optional. A mask of what source types to return. Defaults to ReadSourceType.CONTACT and ReadSourceType.PROFILE if not set. * @param {().Person} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3274,7 +3298,7 @@ export namespace people_v1 { * * // Do the magic * const res = await people.people.deleteContactPhoto({ - * // Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * // Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * personFields: 'placeholder-value', * // Required. The resource name of the contact whose photo will be deleted. * resourceName: 'people/[^/]+', @@ -3298,7 +3322,7 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.personFields Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * @param {string=} params.personFields Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * @param {string} params.resourceName Required. The resource name of the contact whose photo will be deleted. * @param {string=} params.sources Optional. A mask of what source types to return. Defaults to ReadSourceType.CONTACT and ReadSourceType.PROFILE if not set. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3430,7 +3454,7 @@ export namespace people_v1 { * * // Do the magic * const res = await people.people.get({ - * // Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * // Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * personFields: 'placeholder-value', * // Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`. * 'requestMask.includeField': 'placeholder-value', @@ -3450,6 +3474,7 @@ export namespace people_v1 { * // "birthdays": [], * // "braggingRights": [], * // "calendarUrls": [], + * // "clientData": [], * // "coverPhotos": [], * // "emailAddresses": [], * // "etag": "my_etag", @@ -3491,7 +3516,7 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.personFields Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * @param {string=} params.personFields Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * @param {string=} params.requestMask.includeField Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`. * @param {string} params.resourceName Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). * @param {string=} params.sources Optional. A mask of what source types to return. Defaults to ReadSourceType.PROFILE and ReadSourceType.CONTACT if not set. @@ -3616,7 +3641,7 @@ export namespace people_v1 { * * // Do the magic * const res = await people.people.getBatchGet({ - * // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * personFields: 'placeholder-value', * // Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`. * 'requestMask.includeField': 'placeholder-value', @@ -3642,7 +3667,7 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.personFields Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * @param {string=} params.personFields Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * @param {string=} params.requestMask.includeField Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`. * @param {string=} params.resourceNames Required. The resource names of the people to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). You can include up to 50 resource names in one request. * @param {string=} params.sources Optional. A mask of what source types to return. Defaults to ReadSourceType.CONTACT and ReadSourceType.PROFILE if not set. @@ -3765,7 +3790,7 @@ export namespace people_v1 { * pageSize: 'placeholder-value', * // Optional. A page token, received from a previous `ListDirectoryPeople` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDirectoryPeople` must match the call that provided the page token. * pageToken: 'placeholder-value', - * // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * readMask: 'placeholder-value', * // Optional. Whether the response should include `next_sync_token`, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. * requestSyncToken: 'placeholder-value', @@ -3796,7 +3821,7 @@ export namespace people_v1 { * @param {string=} params.mergeSources Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers. * @param {integer=} params.pageSize Optional. The number of people to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0. * @param {string=} params.pageToken Optional. A page token, received from a previous `ListDirectoryPeople` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDirectoryPeople` must match the call that provided the page token. - * @param {string=} params.readMask Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * @param {string=} params.readMask Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * @param {boolean=} params.requestSyncToken Optional. Whether the response should include `next_sync_token`, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. * @param {string=} params.sources Required. Directory sources to return. * @param {string=} params.syncToken Optional. A sync token, received from a previous `ListDirectoryPeople` call. Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `ListDirectoryPeople` must match the call that provided the sync token. @@ -3925,7 +3950,7 @@ export namespace people_v1 { * pageToken: 'placeholder-value', * // Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match. * query: 'placeholder-value', - * // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * readMask: 'placeholder-value', * // Required. Directory sources to return. * sources: 'placeholder-value', @@ -3953,7 +3978,7 @@ export namespace people_v1 { * @param {integer=} params.pageSize Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0. * @param {string=} params.pageToken Optional. A page token, received from a previous `SearchDirectoryPeople` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchDirectoryPeople` must match the call that provided the page token. * @param {string=} params.query Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match. - * @param {string=} params.readMask Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * @param {string=} params.readMask Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * @param {string=} params.sources Required. Directory sources to return. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4074,13 +4099,13 @@ export namespace people_v1 { * * // Do the magic * const res = await people.people.updateContact({ - * // Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * // Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * personFields: 'placeholder-value', * // The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`. * resourceName: 'people/[^/]+', * // Optional. A mask of what source types to return. Defaults to ReadSourceType.CONTACT and ReadSourceType.PROFILE if not set. * sources: 'placeholder-value', - * // Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined + * // Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined * updatePersonFields: 'placeholder-value', * * // Request body metadata @@ -4094,6 +4119,7 @@ export namespace people_v1 { * // "birthdays": [], * // "braggingRights": [], * // "calendarUrls": [], + * // "clientData": [], * // "coverPhotos": [], * // "emailAddresses": [], * // "etag": "my_etag", @@ -4137,6 +4163,7 @@ export namespace people_v1 { * // "birthdays": [], * // "braggingRights": [], * // "calendarUrls": [], + * // "clientData": [], * // "coverPhotos": [], * // "emailAddresses": [], * // "etag": "my_etag", @@ -4178,10 +4205,10 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.personFields Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * @param {string=} params.personFields Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * @param {string} params.resourceName The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`. * @param {string=} params.sources Optional. A mask of what source types to return. Defaults to ReadSourceType.CONTACT and ReadSourceType.PROFILE if not set. - * @param {string=} params.updatePersonFields Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined + * @param {string=} params.updatePersonFields Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined * @param {().Person} 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. @@ -4419,7 +4446,7 @@ export namespace people_v1 { export interface Params$Resource$People$Createcontact extends StandardParameters { /** - * Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined */ personFields?: string; /** @@ -4442,7 +4469,7 @@ export namespace people_v1 { export interface Params$Resource$People$Deletecontactphoto extends StandardParameters { /** - * Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined */ personFields?: string; /** @@ -4456,7 +4483,7 @@ export namespace people_v1 { } export interface Params$Resource$People$Get extends StandardParameters { /** - * Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined */ personFields?: string; /** @@ -4475,7 +4502,7 @@ export namespace people_v1 { export interface Params$Resource$People$Getbatchget extends StandardParameters { /** - * Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined */ personFields?: string; /** @@ -4506,7 +4533,7 @@ export namespace people_v1 { */ pageToken?: string; /** - * Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined */ readMask?: string; /** @@ -4541,7 +4568,7 @@ export namespace people_v1 { */ query?: string; /** - * Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined */ readMask?: string; /** @@ -4552,7 +4579,7 @@ export namespace people_v1 { export interface Params$Resource$People$Updatecontact extends StandardParameters { /** - * Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined */ personFields?: string; /** @@ -4564,7 +4591,7 @@ export namespace people_v1 { */ sources?: string[]; /** - * Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined + * Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined */ updatePersonFields?: string; @@ -4626,7 +4653,7 @@ export namespace people_v1 { * pageSize: 'placeholder-value', * // Optional. A page token, received from a previous `ListConnections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnections` must match the call that provided the page token. * pageToken: 'placeholder-value', - * // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * personFields: 'placeholder-value', * // Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`. * 'requestMask.includeField': 'placeholder-value', @@ -4664,7 +4691,7 @@ export namespace people_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0. * @param {string=} params.pageToken Optional. A page token, received from a previous `ListConnections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnections` must match the call that provided the page token. - * @param {string=} params.personFields Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * @param {string=} params.personFields Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * @param {string=} params.requestMask.includeField Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`. * @param {boolean=} params.requestSyncToken Optional. Whether the response should include `next_sync_token`, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit. * @param {string} params.resourceName Required. The resource name to return connections for. Only `people/me` is valid. @@ -4771,7 +4798,7 @@ export namespace people_v1 { */ pageToken?: string; /** - * Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined + * Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined */ personFields?: string; /** diff --git a/src/apis/playablelocations/v3.ts b/src/apis/playablelocations/v3.ts index f9ae22ec6b..818d246e5c 100644 --- a/src/apis/playablelocations/v3.ts +++ b/src/apis/playablelocations/v3.ts @@ -132,7 +132,7 @@ export namespace playablelocations_v3 { */ export interface Schema$GoogleMapsPlayablelocationsV3Impression { /** - * An arbitrary, developer-defined type identifier for each type of game object used in your game. Since players interact with differ types of game objects in different ways, this field allows you to segregate impression data by type for analysis. You should assign a unique `game_object_type` ID to represent a distinct type of game object in your game. For example, 1=monster location, 2=powerup location. + * An arbitrary, developer-defined type identifier for each type of game object used in your game. Since players interact with differ types of game objects in different ways, this field allows you to segregate impression data by type for analysis. You should assign a unique `game_object_type` ID to represent a distinct type of game object in your game. For example, 1=monster location, 2=powerup location. */ gameObjectType?: number | null; /** @@ -157,7 +157,7 @@ export namespace playablelocations_v3 { */ impressions?: Schema$GoogleMapsPlayablelocationsV3Impression[]; /** - * Required. A string that uniquely identifies the log impressions request. This allows you to detect duplicate requests. We recommend that you use UUIDs for this value. The value must not exceed 50 characters. You should reuse the `request_id` only when retrying a request in case of failure. In this case, the request must be identical to the one that failed. + * Required. A string that uniquely identifies the log impressions request. This allows you to detect duplicate requests. We recommend that you use UUIDs for this value. The value must not exceed 50 characters. You should reuse the `request_id` only when retrying a request in case of failure. In this case, the request must be identical to the one that failed. */ requestId?: string | null; } @@ -178,12 +178,12 @@ export namespace playablelocations_v3 { */ playerReports?: Schema$GoogleMapsPlayablelocationsV3PlayerReport[]; /** - * Required. A string that uniquely identifies the log player reports request. This allows you to detect duplicate requests. We recommend that you use UUIDs for this value. The value must not exceed 50 characters. You should reuse the `request_id` only when retrying a request in the case of a failure. In that case, the request must be identical to the one that failed. + * Required. A string that uniquely identifies the log player reports request. This allows you to detect duplicate requests. We recommend that you use UUIDs for this value. The value must not exceed 50 characters. You should reuse the `request_id` only when retrying a request in the case of a failure. In that case, the request must be identical to the one that failed. */ requestId?: string | null; } /** - * A response for the LogPlayerReports method. This method returns no data upon success. + * A response for the LogPlayerReports method. This method returns no data upon success. */ export interface Schema$GoogleMapsPlayablelocationsV3LogPlayerReportsResponse {} /** @@ -212,7 +212,7 @@ export namespace playablelocations_v3 { */ export interface Schema$GoogleMapsPlayablelocationsV3SampleAreaFilter { /** - * Required. The S2 cell ID of the area you want. This must be between cell level 11 and 14 (inclusive). S2 cells are 64-bit integers that identify areas on the Earth. They are hierarchical, and can therefore be used for spatial indexing. The S2 geometry library is available in a number of languages: * [C++](https://github.com/google/s2geometry) * [Java](https://github.com/google/s2-geometry-library-java) * [Go](https://github.com/golang/geo) * [Python](https://github.com/google/s2geometry/tree/master/src/python) + * Required. The S2 cell ID of the area you want. This must be between cell level 11 and 14 (inclusive). S2 cells are 64-bit integers that identify areas on the Earth. They are hierarchical, and can therefore be used for spatial indexing. The S2 geometry library is available in a number of languages: * [C++](https://github.com/google/s2geometry) * [Java](https://github.com/google/s2-geometry-library-java) * [Go](https://github.com/golang/geo) * [Python](https://github.com/google/s2geometry/tree/master/src/python) */ s2CellId?: string | null; } @@ -221,7 +221,7 @@ export namespace playablelocations_v3 { */ export interface Schema$GoogleMapsPlayablelocationsV3SampleCriterion { /** - * Specifies which `PlayableLocation` fields are returned. `name` (which is used for logging impressions), `center_point` and `place_id` (or `plus_code`) are always returned. The following fields are omitted unless you specify them here: * snapped_point * types Note: The more fields you include, the more expensive in terms of data and associated latency your query will be. + * Specifies which `PlayableLocation` fields are returned. `name` (which is used for logging impressions), `center_point` and `place_id` (or `plus_code`) are always returned. The following fields are omitted unless you specify them here: * snapped_point * types Note: The more fields you include, the more expensive in terms of data and associated latency your query will be. */ fieldsToReturn?: string | null; /** @@ -229,7 +229,7 @@ export namespace playablelocations_v3 { */ filter?: Schema$GoogleMapsPlayablelocationsV3SampleFilter; /** - * Required. An arbitrary, developer-defined identifier of the type of game object that the playable location is used for. This field allows you to specify criteria per game object type when searching for playable locations. You should assign a unique `game_object_type` ID across all `request_criteria` to represent a distinct type of game object. For example, 1=monster location, 2=powerup location. The response contains a map<game_object_type, Response>. + * Required. An arbitrary, developer-defined identifier of the type of game object that the playable location is used for. This field allows you to specify criteria per game object type when searching for playable locations. You should assign a unique `game_object_type` ID across all `request_criteria` to represent a distinct type of game object. For example, 1=monster location, 2=powerup location. The response contains a map. */ gameObjectType?: number | null; } @@ -242,7 +242,7 @@ export namespace playablelocations_v3 { */ includedTypes?: string[] | null; /** - * Specifies the maximum number of playable locations to return. This value must not be greater than 1000. The default value is 100. Only the top-ranking playable locations are returned. + * Specifies the maximum number of playable locations to return. This value must not be greater than 1000. The default value is 100. Only the top-ranking playable locations are returned. */ maxLocationCount?: number | null; /** @@ -255,7 +255,7 @@ export namespace playablelocations_v3 { */ export interface Schema$GoogleMapsPlayablelocationsV3SamplePlayableLocation { /** - * Required. The latitude and longitude associated with the center of the playable location. By default, the set of playable locations returned from SamplePlayableLocations use center-point coordinates. + * Required. The latitude and longitude associated with the center of the playable location. By default, the set of playable locations returned from SamplePlayableLocations use center-point coordinates. */ centerPoint?: Schema$GoogleTypeLatLng; /** @@ -275,7 +275,7 @@ export namespace playablelocations_v3 { */ snappedPoint?: Schema$GoogleTypeLatLng; /** - * A collection of [Playable Location Types](/maps/documentation/gaming/tt/types) for this playable location. The first type in the collection is the primary type. Type information might not be available for all playable locations. + * A collection of [Playable Location Types](/maps/documentation/gaming/tt/types) for this playable location. The first type in the collection is the primary type. Type information might not be available for all playable locations. */ types?: string[] | null; } @@ -289,7 +289,7 @@ export namespace playablelocations_v3 { locations?: Schema$GoogleMapsPlayablelocationsV3SamplePlayableLocation[]; } /** - * Life of a query: - When a game starts in a new location, your game server issues a SamplePlayableLocations request. The request specifies the S2 cell, and contains one or more "criteria" for filtering: - Criterion 0: i locations for long-lived bases, or level 0 monsters, or... - Criterion 1: j locations for short-lived bases, or level 1 monsters, ... - Criterion 2: k locations for random objects. - etc (up to 5 criterion may be specified). `PlayableLocationList` will then contain mutually exclusive lists of `PlayableLocation` objects that satisfy each of the criteria. Think of it as a collection of real-world locations that you can then associate with your game state. Note: These points are impermanent in nature. E.g, parks can close, and places can be removed. The response specifies how long you can expect the playable locations to last. Once they expire, you should query the `samplePlayableLocations` API again to get a fresh view of the real world. + * Life of a query: - When a game starts in a new location, your game server issues a SamplePlayableLocations request. The request specifies the S2 cell, and contains one or more "criteria" for filtering: - Criterion 0: i locations for long-lived bases, or level 0 monsters, or... - Criterion 1: j locations for short-lived bases, or level 1 monsters, ... - Criterion 2: k locations for random objects. - etc (up to 5 criterion may be specified). `PlayableLocationList` will then contain mutually exclusive lists of `PlayableLocation` objects that satisfy each of the criteria. Think of it as a collection of real-world locations that you can then associate with your game state. Note: These points are impermanent in nature. E.g, parks can close, and places can be removed. The response specifies how long you can expect the playable locations to last. Once they expire, you should query the `samplePlayableLocations` API again to get a fresh view of the real world. */ export interface Schema$GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest { /** @@ -323,11 +323,11 @@ export namespace playablelocations_v3 { */ export interface Schema$GoogleMapsPlayablelocationsV3SampleSpacingOptions { /** - * Required. The minimum spacing between any two playable locations, measured in meters. The minimum value is 30. The maximum value is 1000. Inputs will be rounded up to the next 10 meter interval. The default value is 200m. Set this field to remove tight clusters of playable locations. Note: The spacing is a greedy algorithm. It optimizes for selecting the highest ranking locations first, not to maximize the number of locations selected. Consider the following scenario: * Rank: A: 2, B: 1, C: 3. * Distance: A--200m--B--200m--C If spacing=250, it will pick the highest ranked location [B], not [A, C]. Note: Spacing works within the game object type itself, as well as the previous ones. Suppose three game object types, each with the following spacing: * X: 400m, Y: undefined, Z: 200m. 1. Add locations for X, within 400m of each other. 2. Add locations for Y, without any spacing. 3. Finally, add locations for Z within 200m of each other as well X and Y. The distance diagram between those locations end up as: * From->To. * X->X: 400m * Y->X, Y->Y: unspecified. * Z->X, Z->Y, Z->Z: 200m. + * Required. The minimum spacing between any two playable locations, measured in meters. The minimum value is 30. The maximum value is 1000. Inputs will be rounded up to the next 10 meter interval. The default value is 200m. Set this field to remove tight clusters of playable locations. Note: The spacing is a greedy algorithm. It optimizes for selecting the highest ranking locations first, not to maximize the number of locations selected. Consider the following scenario: * Rank: A: 2, B: 1, C: 3. * Distance: A--200m--B--200m--C If spacing=250, it will pick the highest ranked location [B], not [A, C]. Note: Spacing works within the game object type itself, as well as the previous ones. Suppose three game object types, each with the following spacing: * X: 400m, Y: undefined, Z: 200m. 1. Add locations for X, within 400m of each other. 2. Add locations for Y, without any spacing. 3. Finally, add locations for Z within 200m of each other as well X and Y. The distance diagram between those locations end up as: * From->To. * X->X: 400m * Y->X, Y->Y: unspecified. * Z->X, Z->Y, Z->Z: 200m. */ minSpacingMeters?: number | null; /** - * Specifies whether the minimum spacing constraint applies to the center-point or to the snapped point of playable locations. The default value is `CENTER_POINT`. If a snapped point is not available for a playable location, its center-point is used instead. Set this to the point type used in your game. + * Specifies whether the minimum spacing constraint applies to the center-point or to the snapped point of playable locations. The default value is `CENTER_POINT`. If a snapped point is not available for a playable location, its center-point is used instead. Set this to the point type used in your game. */ pointType?: string | null; } @@ -369,7 +369,7 @@ export namespace playablelocations_v3 { platform?: string | null; } /** - * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. */ export interface Schema$GoogleTypeLatLng { /** @@ -390,7 +390,7 @@ export namespace playablelocations_v3 { /** * playablelocations.logImpressions - * @desc Logs new events when playable locations are displayed, and when they are interacted with. Impressions are not partially saved; either all impressions are saved and this request succeeds, or no impressions are saved, and this request fails. + * @desc Logs new events when playable locations are displayed, and when they are interacted with. Impressions are not partially saved; either all impressions are saved and this request succeeds, or no impressions are saved, and this request fails. * @example * // Before running the sample: * // - Enable the API at: @@ -550,7 +550,7 @@ export namespace playablelocations_v3 { /** * playablelocations.logPlayerReports - * @desc Logs bad playable location reports submitted by players. Reports are not partially saved; either all reports are saved and this request succeeds, or no reports are saved, and this request fails. + * @desc Logs bad playable location reports submitted by players. Reports are not partially saved; either all reports are saved and this request succeeds, or no reports are saved, and this request fails. * @example * // Before running the sample: * // - Enable the API at: @@ -713,7 +713,7 @@ export namespace playablelocations_v3 { /** * playablelocations.samplePlayableLocations - * @desc Returns a set of playable locations that lie within a specified area, that satisfy optional filter criteria. Note: Identical `SamplePlayableLocations` requests can return different results as the state of the world changes over time. + * @desc Returns a set of playable locations that lie within a specified area, that satisfy optional filter criteria. Note: Identical `SamplePlayableLocations` requests can return different results as the state of the world changes over time. * @example * // Before running the sample: * // - Enable the API at: diff --git a/src/apis/vectortile/v1.ts b/src/apis/vectortile/v1.ts index 15427d6bdf..cb380feb1e 100644 --- a/src/apis/vectortile/v1.ts +++ b/src/apis/vectortile/v1.ts @@ -138,11 +138,11 @@ export namespace vectortile_v1 { */ hasExternalEdges?: boolean | null; /** - * When has_external_edges is true, the polygon has some edges that border another feature. This field indicates the internal edges that do not border another feature. Each value is an index into the vertices array, and denotes the start vertex of the internal edge (the next vertex in the boundary loop is the end of the edge). If the selected vertex is the last vertex in the boundary loop, then the edge between that vertex and the starting vertex of the loop is internal. This field may be used for styling. For example, building parapets could be placed only on the external edges of a building polygon, or water could be lighter colored near the external edges of a body of water. If has_external_edges is false, all edges are internal and this field will be empty. + * When has_external_edges is true, the polygon has some edges that border another feature. This field indicates the internal edges that do not border another feature. Each value is an index into the vertices array, and denotes the start vertex of the internal edge (the next vertex in the boundary loop is the end of the edge). If the selected vertex is the last vertex in the boundary loop, then the edge between that vertex and the starting vertex of the loop is internal. This field may be used for styling. For example, building parapets could be placed only on the external edges of a building polygon, or water could be lighter colored near the external edges of a body of water. If has_external_edges is false, all edges are internal and this field will be empty. */ internalEdges?: number[] | null; /** - * Identifies the boundary loops of the polygon. Only set for INDEXED_TRIANGLE polygons. Each value is an index into the vertices array indicating the beginning of a loop. For instance, values of [2, 5] would indicate loop_data contained 3 loops with indices 0-1, 2-4, and 5-end. This may be used in conjunction with the internal_edges field for styling polygon boundaries. Note that an edge may be on a polygon boundary but still internal to the feature. For example, a feature split across multiple tiles will have an internal polygon boundary edge along the edge of the tile. + * Identifies the boundary loops of the polygon. Only set for INDEXED_TRIANGLE polygons. Each value is an index into the vertices array indicating the beginning of a loop. For instance, values of [2, 5] would indicate loop_data contained 3 loops with indices 0-1, 2-4, and 5-end. This may be used in conjunction with the internal_edges field for styling polygon boundaries. Note that an edge may be on a polygon boundary but still internal to the feature. For example, a feature split across multiple tiles will have an internal polygon boundary edge along the edge of the tile. */ loopBreaks?: number[] | null; /** @@ -158,12 +158,12 @@ export namespace vectortile_v1 { */ vertexOffsets?: Schema$Vertex2DList; /** - * The z-ordering of this area. Areas with a lower z-order should be rendered beneath areas with a higher z-order. This z-ordering does not imply anything about the altitude of the line relative to the ground, but it can be used to prevent z-fighting during rendering on the client. This z-ordering can only be used to compare areas, and cannot be compared with the z_order field in the Line message. The z-order may be negative or zero. + * The z-ordering of this area. Areas with a lower z-order should be rendered beneath areas with a higher z-order. This z-ordering does not imply anything about the altitude of the line relative to the ground, but it can be used to prevent z-fighting during rendering on the client. This z-ordering can only be used to compare areas, and cannot be compared with the z_order field in the Line message. The z-order may be negative or zero. */ zOrder?: number | null; } /** - * Represents a height-extruded area: a 3D prism with a constant X-Y plane cross section. Used to represent extruded buildings. A single building may consist of several extruded areas. The min_z and max_z fields are scaled to the size of the tile. An extruded area with a max_z value of 4096 has the same height as the width of the tile that it is on. + * Represents a height-extruded area: a 3D prism with a constant X-Y plane cross section. Used to represent extruded buildings. A single building may consist of several extruded areas. The min_z and max_z fields are scaled to the size of the tile. An extruded area with a max_z value of 4096 has the same height as the width of the tile that it is on. */ export interface Schema$ExtrudedArea { /** @@ -221,7 +221,7 @@ export namespace vectortile_v1 { */ features?: Schema$Feature[]; /** - * Resource name of the tile. The tile resource name is prefixed by its collection ID `tiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@<x>,<y>,<zoom>z`. For example, `tiles/@1,2,3z`. + * Resource name of the tile. The tile resource name is prefixed by its collection ID `tiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `tiles/@1,2,3z`. */ name?: string | null; /** @@ -233,12 +233,12 @@ export namespace vectortile_v1 { */ status?: string | null; /** - * An opaque value, usually less than 30 characters, that contains version info about this tile and the data that was used to generate it. The client should store this value in its tile cache and pass it back to the API in the client_tile_version_id field of subsequent tile requests in order to enable the API to detect when the new tile would be the same as the one the client already has in its cache. Also see STATUS_OK_DATA_UNCHANGED. + * An opaque value, usually less than 30 characters, that contains version info about this tile and the data that was used to generate it. The client should store this value in its tile cache and pass it back to the API in the client_tile_version_id field of subsequent tile requests in order to enable the API to detect when the new tile would be the same as the one the client already has in its cache. Also see STATUS_OK_DATA_UNCHANGED. */ versionId?: string | null; } /** - * A packed representation of a 2D grid of uniformly spaced points containing elevation data. Each point within the grid represents the altitude in meters above average sea level at that location within the tile. Elevations provided are (generally) relative to the EGM96 geoid, however some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0].a[m] +-----------------+ | | | N | | ^ | | | | | W <-----> E | | | | | v | | S | | | +-----------------+ rows[n].a[0] rows[n].a[m] Rather than storing the altitudes directly, we store the diffs between them as integers at some requested level of precision to take advantage of integer packing. The actual altitude values a[] can be reconstructed using the scale and each row's first_altitude and altitude_diff fields. + * A packed representation of a 2D grid of uniformly spaced points containing elevation data. Each point within the grid represents the altitude in meters above average sea level at that location within the tile. Elevations provided are (generally) relative to the EGM96 geoid, however some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0].a[m] +-----------------+ | | | N | | ^ | | | | | W <-----> E | | | | | v | | S | | | +-----------------+ rows[n].a[0] rows[n].a[m] Rather than storing the altitudes directly, we store the diffs between them as integers at some requested level of precision to take advantage of integer packing. The actual altitude values a[] can be reconstructed using the scale and each row's first_altitude and altitude_diff fields. */ export interface Schema$FirstDerivativeElevationGrid { /** @@ -251,7 +251,7 @@ export namespace vectortile_v1 { rows?: Schema$Row[]; } /** - * Represents the geometry of a feature, that is, the shape that it has on the map. The local tile coordinate system has the origin at the north-west (upper-left) corner of the tile, and is scaled to 4096 units across each edge. The height (Z) axis has the same scale factor: an extruded area with a max_z value of 4096 has the same height as the width of the tile that it is on. There is no clipping boundary, so it is possible that some coordinates will lie outside the tile boundaries. + * Represents the geometry of a feature, that is, the shape that it has on the map. The local tile coordinate system has the origin at the north-west (upper-left) corner of the tile, and is scaled to 4096 units across each edge. The height (Z) axis has the same scale factor: an extruded area with a max_z value of 4096 has the same height as the width of the tile that it is on. There is no clipping boundary, so it is possible that some coordinates will lie outside the tile boundaries. */ export interface Schema$Geometry { /** @@ -280,7 +280,7 @@ export namespace vectortile_v1 { */ vertexOffsets?: Schema$Vertex2DList; /** - * The z-order of the line. Lines with a lower z-order should be rendered beneath lines with a higher z-order. This z-ordering does not imply anything about the altitude of the area relative to the ground, but it can be used to prevent z-fighting during rendering on the client. In general, larger and more important road features will have a higher z-order line associated with them. This z-ordering can only be used to compare lines, and cannot be compared with the z_order field in the Area message. The z-order may be negative or zero. + * The z-order of the line. Lines with a lower z-order should be rendered beneath lines with a higher z-order. This z-ordering does not imply anything about the altitude of the area relative to the ground, but it can be used to prevent z-fighting during rendering on the client. In general, larger and more important road features will have a higher z-order line associated with them. This z-ordering can only be used to compare lines, and cannot be compared with the z_order field in the Area message. The z-order may be negative or zero. */ zOrder?: number | null; } @@ -338,7 +338,7 @@ export namespace vectortile_v1 { altitudeDiffs?: number[] | null; } /** - * A packed representation of a 2D grid of uniformly spaced points containing elevation data. Each point within the grid represents the altitude in meters above average sea level at that location within the tile. Elevations provided are (generally) relative to the EGM96 geoid, however some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0].a[m] +-----------------+ | | | N | | ^ | | | | | W <-----> E | | | | | v | | S | | | +-----------------+ rows[n].a[0] rows[n].a[m] Rather than storing the altitudes directly, we store the diffs of the diffs between them as integers at some requested level of precision to take advantage of integer packing. Note that the data is packed in such a way that is fast to decode in Unity and that further optimizes wire size. + * A packed representation of a 2D grid of uniformly spaced points containing elevation data. Each point within the grid represents the altitude in meters above average sea level at that location within the tile. Elevations provided are (generally) relative to the EGM96 geoid, however some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0].a[m] +-----------------+ | | | N | | ^ | | | | | W <-----> E | | | | | v | | S | | | +-----------------+ rows[n].a[0] rows[n].a[m] Rather than storing the altitudes directly, we store the diffs of the diffs between them as integers at some requested level of precision to take advantage of integer packing. Note that the data is packed in such a way that is fast to decode in Unity and that further optimizes wire size. */ export interface Schema$SecondDerivativeElevationGrid { /** @@ -350,7 +350,7 @@ export namespace vectortile_v1 { */ columnCount?: number | null; /** - * A stream of elements each representing a point on the tile running across each row from left to right, top to bottom. There will be precisely horizontal_resolution * vertical_resolution elements in the stream. The elements are not the heights, rather the second order derivative of the values one would expect in a stream of height data. Each element is a varint with the following encoding: ------------------------------------------------------------------------| | Head Nibble | ------------------------------------------------------------------------| | Bit 0 | Bit 1 | Bits 2-3 | | Terminator| Sign (1=neg) | Least significant 2 bits of absolute error | ------------------------------------------------------------------------| | Tail Nibble #1 | ------------------------------------------------------------------------| | Bit 0 | Bit 1-3 | | Terminator| Least significant 3 bits of absolute error | ------------------------------------------------------------------------| | ... | Tail Nibble #n | ------------------------------------------------------------------------| | Bit 0 | Bit 1-3 | | Terminator| Least significant 3 bits of absolute error | ------------------------------------------------------------------------| + * A stream of elements each representing a point on the tile running across each row from left to right, top to bottom. There will be precisely horizontal_resolution * vertical_resolution elements in the stream. The elements are not the heights, rather the second order derivative of the values one would expect in a stream of height data. Each element is a varint with the following encoding: ------------------------------------------------------------------------| | Head Nibble | ------------------------------------------------------------------------| | Bit 0 | Bit 1 | Bits 2-3 | | Terminator| Sign (1=neg) | Least significant 2 bits of absolute error | ------------------------------------------------------------------------| | Tail Nibble #1 | ------------------------------------------------------------------------| | Bit 0 | Bit 1-3 | | Terminator| Least significant 3 bits of absolute error | ------------------------------------------------------------------------| | ... | Tail Nibble #n | ------------------------------------------------------------------------| | Bit 0 | Bit 1-3 | | Terminator| Least significant 3 bits of absolute error | ------------------------------------------------------------------------| */ encodedData?: string | null; /** @@ -380,7 +380,7 @@ export namespace vectortile_v1 { */ firstDerivative?: Schema$FirstDerivativeElevationGrid; /** - * Resource name of the tile. The tile resource name is prefixed by its collection ID `terrain/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@<x>,<y>,<zoom>z`. For example, `terrain/@1,2,3z`. + * Resource name of the tile. The tile resource name is prefixed by its collection ID `terrain/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `terrain/@1,2,3z`. */ name?: string | null; /** @@ -389,7 +389,7 @@ export namespace vectortile_v1 { secondDerivative?: Schema$SecondDerivativeElevationGrid; } /** - * Global tile coordinates. Global tile coordinates reference a specific tile on the map at a specific zoom level. The origin of this coordinate system is always at the northwest corner of the map, with x values increasing from west to east and y values increasing from north to south. Tiles are indexed using x, y coordinates from that origin. The zoom level containing the entire world in a tile is 0, and it increases as you zoom in. Zoom level n + 1 will contain 4 times as many tiles as zoom level n. The zoom level controls the level of detail of the data that is returned. In particular, this affects the set of feature types returned, their density, and geometry simplification. The exact tile contents may change over time, but care will be taken to keep supporting the most important use cases. For example, zoom level 15 shows roads for orientation and planning in the local neighborhood and zoom level 17 shows buildings to give users on foot a sense of situational awareness. + * Global tile coordinates. Global tile coordinates reference a specific tile on the map at a specific zoom level. The origin of this coordinate system is always at the northwest corner of the map, with x values increasing from west to east and y values increasing from north to south. Tiles are indexed using x, y coordinates from that origin. The zoom level containing the entire world in a tile is 0, and it increases as you zoom in. Zoom level n + 1 will contain 4 times as many tiles as zoom level n. The zoom level controls the level of detail of the data that is returned. In particular, this affects the set of feature types returned, their density, and geometry simplification. The exact tile contents may change over time, but care will be taken to keep supporting the most important use cases. For example, zoom level 15 shows roads for orientation and planning in the local neighborhood and zoom level 17 shows buildings to give users on foot a sense of situational awareness. */ export interface Schema$TileCoordinates { /** @@ -406,7 +406,7 @@ export namespace vectortile_v1 { zoom?: number | null; } /** - * Represents a strip of triangles. Each triangle uses the last edge of the previous one. The following diagram shows an example of a triangle strip, with each vertex labeled with its index in the vertex_index array. (1)-----(3) / \ / \ / \ / \ / \ / \ (0)-----(2)-----(4) Vertices may be in either clockwise or counter-clockwise order. + * Represents a strip of triangles. Each triangle uses the last edge of the previous one. The following diagram shows an example of a triangle strip, with each vertex labeled with its index in the vertex_index array. (1)-----(3) / \ / \ / \ / \ / \ / \ (0)-----(2)-----(4) Vertices may be in either clockwise or counter-clockwise order. */ export interface Schema$TriangleStrip { /** @@ -415,7 +415,7 @@ export namespace vectortile_v1 { vertexIndices?: number[] | null; } /** - * 2D vertex list used for lines and areas. Each entry represents an offset from the previous one in local tile coordinates. The first entry is offset from (0, 0). For example, the list of vertices [(1,1), (2, 2), (1, 2)] would be encoded in vertex offsets as [(1, 1), (1, 1), (-1, 0)]. + * 2D vertex list used for lines and areas. Each entry represents an offset from the previous one in local tile coordinates. The first entry is offset from (0, 0). For example, the list of vertices [(1,1), (2, 2), (1, 2)] would be encoded in vertex offsets as [(1, 1), (1, 1), (-1, 0)]. */ export interface Schema$Vertex2DList { /** @@ -478,78 +478,39 @@ export namespace vectortile_v1 { * * // Do the magic * const res = await vectortile.featuretiles.get({ - * // API client name and version. For example, the SDK calling the API. The - * // exact format is up to the client. + * // API client name and version. For example, the SDK calling the API. The exact format is up to the client. * 'clientInfo.apiClient': 'placeholder-value', - * // Application ID, such as the package name on Android and the bundle - * // identifier on iOS platforms. + * // Application ID, such as the package name on Android and the bundle identifier on iOS platforms. * 'clientInfo.applicationId': 'placeholder-value', - * // Application version number, such as "1.2.3". The exact format is - * // application-dependent. + * // Application version number, such as "1.2.3". The exact format is application-dependent. * 'clientInfo.applicationVersion': 'placeholder-value', - * // Device model as reported by the device. The exact format is - * // platform-dependent. + * // Device model as reported by the device. The exact format is platform-dependent. * 'clientInfo.deviceModel': 'placeholder-value', - * // Operating system name and version as reported by the OS. For example, - * // "Mac OS X 10.10.4". The exact format is platform-dependent. + * // Operating system name and version as reported by the OS. For example, "Mac OS X 10.10.4". The exact format is platform-dependent. * 'clientInfo.operatingSystem': 'placeholder-value', * // Platform where the application is running. * 'clientInfo.platform': 'placeholder-value', - * // A client-generated user ID. The ID should be generated and persisted during - * // the first user session or whenever a pre-existing ID is not found. The - * // exact format is up to the client. This must be non-empty in a - * // GetFeatureTileRequest (whether via the header or - * // GetFeatureTileRequest.client_info). + * // Required. A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.client_info). * 'clientInfo.userId': 'placeholder-value', - * // Optional version id identifying the tile that is already in the client's - * // cache. This field should be populated with the most recent version_id value - * // returned by the API for the requested tile. - * // - * // If the version id is empty the server always returns a newly rendered tile. - * // If it is provided the server checks if the tile contents would be identical - * // to one that's already on the client, and if so, returns a stripped-down - * // response tile with STATUS_OK_DATA_UNCHANGED instead. + * // Optional version id identifying the tile that is already in the client's cache. This field should be populated with the most recent version_id value returned by the API for the requested tile. If the version id is empty the server always returns a newly rendered tile. If it is provided the server checks if the tile contents would be identical to one that's already on the client, and if so, returns a stripped-down response tile with STATUS_OK_DATA_UNCHANGED instead. * clientTileVersionId: 'placeholder-value', - * // Flag indicating whether detailed highway types should be returned. If this - * // is set, the CONTROLLED_ACCESS_HIGHWAY type may be returned. If not, then - * // these highways will have the generic HIGHWAY type. - * // - * // This exists for backwards compatibility reasons. + * // Flag indicating whether detailed highway types should be returned. If this is set, the CONTROLLED_ACCESS_HIGHWAY type may be returned. If not, then these highways will have the generic HIGHWAY type. This exists for backwards compatibility reasons. * enableDetailedHighwayTypes: 'placeholder-value', - * // Flag indicating whether human-readable names should be returned for - * // features. If this is set, the display_name field on the feature will be - * // filled out. + * // Flag indicating whether human-readable names should be returned for features. If this is set, the display_name field on the feature will be filled out. * enableFeatureNames: 'placeholder-value', - * // Flag indicating whether 3D building models should be enabled. If this is - * // set structures will be returned as 3D modeled volumes rather than 2.5D - * // extruded areas where possible. + * // Flag indicating whether 3D building models should be enabled. If this is set structures will be returned as 3D modeled volumes rather than 2.5D extruded areas where possible. * enableModeledVolumes: 'placeholder-value', * // Flag indicating whether political features should be returned. * enablePoliticalFeatures: 'placeholder-value', - * // Flag indicating whether the returned tile will contain road features that - * // are marked private. Private roads are indicated by the - * // Feature.segment_info.road_info.is_private field. + * // Flag indicating whether the returned tile will contain road features that are marked private. Private roads are indicated by the Feature.segment_info.road_info.is_private field. * enablePrivateRoads: 'placeholder-value', - * // Flag indicating whether unclipped buildings should be returned. If this is - * // set, building render ops will extend beyond the tile boundary. Buildings - * // will only be returned on the tile that contains their centroid. + * // Flag indicating whether unclipped buildings should be returned. If this is set, building render ops will extend beyond the tile boundary. Buildings will only be returned on the tile that contains their centroid. * enableUnclippedBuildings: 'placeholder-value', - * // Required. The BCP-47 language code corresponding to the language in which - * // the name was requested, such as "en-US" or "sr-Latn". - * // - * // For more information, see - * // http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * // Required. The BCP-47 language code corresponding to the language in which the name was requested, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. * languageCode: 'placeholder-value', - * // Required. Resource name of the tile. The tile resource name is prefixed by - * // its collection ID `tiles/` followed by the resource ID, which encodes the - * // tile's global x and y coordinates and zoom level as `@,,z`. - * // For example, `tiles/@1,2,3z`. + * // Required. Resource name of the tile. The tile resource name is prefixed by its collection ID `tiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `tiles/@1,2,3z`. * name: 'featuretiles/my-featuretile', - * // Required. The Unicode country/region code (CLDR) of the location from which - * // the request is coming from, such as "US" and "419". - * // - * // For more information, see - * // http://www.unicode.org/reports/tr35/#unicode_region_subtag. + * // Required. The Unicode country/region code (CLDR) of the location from which the request is coming from, such as "US" and "419". For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag. * regionCode: 'placeholder-value', * }); * console.log(res.data); @@ -580,17 +541,17 @@ export namespace vectortile_v1 { * @param {string=} params.clientInfo.deviceModel Device model as reported by the device. The exact format is platform-dependent. * @param {string=} params.clientInfo.operatingSystem Operating system name and version as reported by the OS. For example, "Mac OS X 10.10.4". The exact format is platform-dependent. * @param {string=} params.clientInfo.platform Platform where the application is running. - * @param {string=} params.clientInfo.userId A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.client_info). - * @param {string=} params.clientTileVersionId Optional version id identifying the tile that is already in the client's cache. This field should be populated with the most recent version_id value returned by the API for the requested tile. If the version id is empty the server always returns a newly rendered tile. If it is provided the server checks if the tile contents would be identical to one that's already on the client, and if so, returns a stripped-down response tile with STATUS_OK_DATA_UNCHANGED instead. - * @param {boolean=} params.enableDetailedHighwayTypes Flag indicating whether detailed highway types should be returned. If this is set, the CONTROLLED_ACCESS_HIGHWAY type may be returned. If not, then these highways will have the generic HIGHWAY type. This exists for backwards compatibility reasons. + * @param {string=} params.clientInfo.userId Required. A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.client_info). + * @param {string=} params.clientTileVersionId Optional version id identifying the tile that is already in the client's cache. This field should be populated with the most recent version_id value returned by the API for the requested tile. If the version id is empty the server always returns a newly rendered tile. If it is provided the server checks if the tile contents would be identical to one that's already on the client, and if so, returns a stripped-down response tile with STATUS_OK_DATA_UNCHANGED instead. + * @param {boolean=} params.enableDetailedHighwayTypes Flag indicating whether detailed highway types should be returned. If this is set, the CONTROLLED_ACCESS_HIGHWAY type may be returned. If not, then these highways will have the generic HIGHWAY type. This exists for backwards compatibility reasons. * @param {boolean=} params.enableFeatureNames Flag indicating whether human-readable names should be returned for features. If this is set, the display_name field on the feature will be filled out. * @param {boolean=} params.enableModeledVolumes Flag indicating whether 3D building models should be enabled. If this is set structures will be returned as 3D modeled volumes rather than 2.5D extruded areas where possible. * @param {boolean=} params.enablePoliticalFeatures Flag indicating whether political features should be returned. * @param {boolean=} params.enablePrivateRoads Flag indicating whether the returned tile will contain road features that are marked private. Private roads are indicated by the Feature.segment_info.road_info.is_private field. * @param {boolean=} params.enableUnclippedBuildings Flag indicating whether unclipped buildings should be returned. If this is set, building render ops will extend beyond the tile boundary. Buildings will only be returned on the tile that contains their centroid. - * @param {string=} params.languageCode Required. The BCP-47 language code corresponding to the language in which the name was requested, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - * @param {string} params.name Required. Resource name of the tile. The tile resource name is prefixed by its collection ID `tiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `tiles/@1,2,3z`. - * @param {string=} params.regionCode Required. The Unicode country/region code (CLDR) of the location from which the request is coming from, such as "US" and "419". For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag. + * @param {string=} params.languageCode Required. The BCP-47 language code corresponding to the language in which the name was requested, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * @param {string} params.name Required. Resource name of the tile. The tile resource name is prefixed by its collection ID `tiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `tiles/@1,2,3z`. + * @param {string=} params.regionCode Required. The Unicode country/region code (CLDR) of the location from which the request is coming from, such as "US" and "419". For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag. * @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 @@ -697,15 +658,15 @@ export namespace vectortile_v1 { */ 'clientInfo.platform'?: string; /** - * A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.client_info). + * Required. A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.client_info). */ 'clientInfo.userId'?: string; /** - * Optional version id identifying the tile that is already in the client's cache. This field should be populated with the most recent version_id value returned by the API for the requested tile. If the version id is empty the server always returns a newly rendered tile. If it is provided the server checks if the tile contents would be identical to one that's already on the client, and if so, returns a stripped-down response tile with STATUS_OK_DATA_UNCHANGED instead. + * Optional version id identifying the tile that is already in the client's cache. This field should be populated with the most recent version_id value returned by the API for the requested tile. If the version id is empty the server always returns a newly rendered tile. If it is provided the server checks if the tile contents would be identical to one that's already on the client, and if so, returns a stripped-down response tile with STATUS_OK_DATA_UNCHANGED instead. */ clientTileVersionId?: string; /** - * Flag indicating whether detailed highway types should be returned. If this is set, the CONTROLLED_ACCESS_HIGHWAY type may be returned. If not, then these highways will have the generic HIGHWAY type. This exists for backwards compatibility reasons. + * Flag indicating whether detailed highway types should be returned. If this is set, the CONTROLLED_ACCESS_HIGHWAY type may be returned. If not, then these highways will have the generic HIGHWAY type. This exists for backwards compatibility reasons. */ enableDetailedHighwayTypes?: boolean; /** @@ -729,15 +690,15 @@ export namespace vectortile_v1 { */ enableUnclippedBuildings?: boolean; /** - * Required. The BCP-47 language code corresponding to the language in which the name was requested, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * Required. The BCP-47 language code corresponding to the language in which the name was requested, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** - * Required. Resource name of the tile. The tile resource name is prefixed by its collection ID `tiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `tiles/@1,2,3z`. + * Required. Resource name of the tile. The tile resource name is prefixed by its collection ID `tiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `tiles/@1,2,3z`. */ name?: string; /** - * Required. The Unicode country/region code (CLDR) of the location from which the request is coming from, such as "US" and "419". For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag. + * Required. The Unicode country/region code (CLDR) of the location from which the request is coming from, such as "US" and "419". For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag. */ regionCode?: string; } @@ -775,62 +736,27 @@ export namespace vectortile_v1 { * * // Do the magic * const res = await vectortile.terraintiles.get({ - * // The precision of terrain altitudes in centimeters. - * // Possible values: between 1 (cm level precision) and 1,000,000 (10-kilometer - * // level precision). + * // The precision of terrain altitudes in centimeters. Possible values: between 1 (cm level precision) and 1,000,000 (10-kilometer level precision). * altitudePrecisionCentimeters: 'placeholder-value', - * // API client name and version. For example, the SDK calling the API. The - * // exact format is up to the client. + * // API client name and version. For example, the SDK calling the API. The exact format is up to the client. * 'clientInfo.apiClient': 'placeholder-value', - * // Application ID, such as the package name on Android and the bundle - * // identifier on iOS platforms. + * // Application ID, such as the package name on Android and the bundle identifier on iOS platforms. * 'clientInfo.applicationId': 'placeholder-value', - * // Application version number, such as "1.2.3". The exact format is - * // application-dependent. + * // Application version number, such as "1.2.3". The exact format is application-dependent. * 'clientInfo.applicationVersion': 'placeholder-value', - * // Device model as reported by the device. The exact format is - * // platform-dependent. + * // Device model as reported by the device. The exact format is platform-dependent. * 'clientInfo.deviceModel': 'placeholder-value', - * // Operating system name and version as reported by the OS. For example, - * // "Mac OS X 10.10.4". The exact format is platform-dependent. + * // Operating system name and version as reported by the OS. For example, "Mac OS X 10.10.4". The exact format is platform-dependent. * 'clientInfo.operatingSystem': 'placeholder-value', * // Platform where the application is running. * 'clientInfo.platform': 'placeholder-value', - * // A client-generated user ID. The ID should be generated and persisted during - * // the first user session or whenever a pre-existing ID is not found. The - * // exact format is up to the client. This must be non-empty in a - * // GetFeatureTileRequest (whether via the header or - * // GetFeatureTileRequest.client_info). + * // Required. A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.client_info). * 'clientInfo.userId': 'placeholder-value', - * // The maximum allowed resolution for the returned elevation heightmap. - * // Possible values: between 1 and 1024 (and not less than - * // min_elevation_resolution_cells). - * // Over-sized heightmaps will be non-uniformly down-sampled such that each - * // edge is no longer than this value. Non-uniformity is chosen to maximise the - * // amount of preserved data. - * // - * // For example: - * // Original resolution: 100px (width) * 30px (height) - * // max_elevation_resolution: 30 - * // New resolution: 30px (width) * 30px (height) + * // The maximum allowed resolution for the returned elevation heightmap. Possible values: between 1 and 1024 (and not less than min_elevation_resolution_cells). Over-sized heightmaps will be non-uniformly down-sampled such that each edge is no longer than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 100px (width) * 30px (height) max_elevation_resolution: 30 New resolution: 30px (width) * 30px (height) * maxElevationResolutionCells: 'placeholder-value', - * // The minimum allowed resolution for the returned elevation heightmap. - * // Possible values: between 0 and 1024 (and not more than - * // max_elevation_resolution_cells). Zero is supported for backward - * // compatibility. - * // Under-sized heightmaps will be non-uniformly up-sampled - * // such that each edge is no shorter than this value. Non-uniformity is chosen - * // to maximise the amount of preserved data. - * // - * // For example: - * // Original resolution: 30px (width) * 10px (height) - * // min_elevation_resolution: 30 - * // New resolution: 30px (width) * 30px (height) + * // The minimum allowed resolution for the returned elevation heightmap. Possible values: between 0 and 1024 (and not more than max_elevation_resolution_cells). Zero is supported for backward compatibility. Under-sized heightmaps will be non-uniformly up-sampled such that each edge is no shorter than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 30px (width) * 10px (height) min_elevation_resolution: 30 New resolution: 30px (width) * 30px (height) * minElevationResolutionCells: 'placeholder-value', - * // Required. Resource name of the tile. The tile resource name is prefixed by - * // its collection ID `terraintiles/` followed by the resource ID, which - * // encodes the tile's global x and y coordinates and zoom level as - * // `@,,z`. For example, `terraintiles/@1,2,3z`. + * // Required. Resource name of the tile. The tile resource name is prefixed by its collection ID `terraintiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `terraintiles/@1,2,3z`. * name: 'terraintiles/my-terraintile', * // Terrain formats that the client understands. * terrainFormats: 'placeholder-value', @@ -862,10 +788,10 @@ export namespace vectortile_v1 { * @param {string=} params.clientInfo.deviceModel Device model as reported by the device. The exact format is platform-dependent. * @param {string=} params.clientInfo.operatingSystem Operating system name and version as reported by the OS. For example, "Mac OS X 10.10.4". The exact format is platform-dependent. * @param {string=} params.clientInfo.platform Platform where the application is running. - * @param {string=} params.clientInfo.userId A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.client_info). - * @param {integer=} params.maxElevationResolutionCells The maximum allowed resolution for the returned elevation heightmap. Possible values: between 1 and 1024 (and not less than min_elevation_resolution_cells). Over-sized heightmaps will be non-uniformly down-sampled such that each edge is no longer than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 100px (width) * 30px (height) max_elevation_resolution: 30 New resolution: 30px (width) * 30px (height) - * @param {integer=} params.minElevationResolutionCells The minimum allowed resolution for the returned elevation heightmap. Possible values: between 0 and 1024 (and not more than max_elevation_resolution_cells). Zero is supported for backward compatibility. Under-sized heightmaps will be non-uniformly up-sampled such that each edge is no shorter than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 30px (width) * 10px (height) min_elevation_resolution: 30 New resolution: 30px (width) * 30px (height) - * @param {string} params.name Required. Resource name of the tile. The tile resource name is prefixed by its collection ID `terraintiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `terraintiles/@1,2,3z`. + * @param {string=} params.clientInfo.userId Required. A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.client_info). + * @param {integer=} params.maxElevationResolutionCells The maximum allowed resolution for the returned elevation heightmap. Possible values: between 1 and 1024 (and not less than min_elevation_resolution_cells). Over-sized heightmaps will be non-uniformly down-sampled such that each edge is no longer than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 100px (width) * 30px (height) max_elevation_resolution: 30 New resolution: 30px (width) * 30px (height) + * @param {integer=} params.minElevationResolutionCells The minimum allowed resolution for the returned elevation heightmap. Possible values: between 0 and 1024 (and not more than max_elevation_resolution_cells). Zero is supported for backward compatibility. Under-sized heightmaps will be non-uniformly up-sampled such that each edge is no shorter than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 30px (width) * 10px (height) min_elevation_resolution: 30 New resolution: 30px (width) * 30px (height) + * @param {string} params.name Required. Resource name of the tile. The tile resource name is prefixed by its collection ID `terraintiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `terraintiles/@1,2,3z`. * @param {string=} params.terrainFormats Terrain formats that the client understands. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -977,19 +903,19 @@ export namespace vectortile_v1 { */ 'clientInfo.platform'?: string; /** - * A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.client_info). + * Required. A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.client_info). */ 'clientInfo.userId'?: string; /** - * The maximum allowed resolution for the returned elevation heightmap. Possible values: between 1 and 1024 (and not less than min_elevation_resolution_cells). Over-sized heightmaps will be non-uniformly down-sampled such that each edge is no longer than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 100px (width) * 30px (height) max_elevation_resolution: 30 New resolution: 30px (width) * 30px (height) + * The maximum allowed resolution for the returned elevation heightmap. Possible values: between 1 and 1024 (and not less than min_elevation_resolution_cells). Over-sized heightmaps will be non-uniformly down-sampled such that each edge is no longer than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 100px (width) * 30px (height) max_elevation_resolution: 30 New resolution: 30px (width) * 30px (height) */ maxElevationResolutionCells?: number; /** - * The minimum allowed resolution for the returned elevation heightmap. Possible values: between 0 and 1024 (and not more than max_elevation_resolution_cells). Zero is supported for backward compatibility. Under-sized heightmaps will be non-uniformly up-sampled such that each edge is no shorter than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 30px (width) * 10px (height) min_elevation_resolution: 30 New resolution: 30px (width) * 30px (height) + * The minimum allowed resolution for the returned elevation heightmap. Possible values: between 0 and 1024 (and not more than max_elevation_resolution_cells). Zero is supported for backward compatibility. Under-sized heightmaps will be non-uniformly up-sampled such that each edge is no shorter than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 30px (width) * 10px (height) min_elevation_resolution: 30 New resolution: 30px (width) * 30px (height) */ minElevationResolutionCells?: number; /** - * Required. Resource name of the tile. The tile resource name is prefixed by its collection ID `terraintiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `terraintiles/@1,2,3z`. + * Required. Resource name of the tile. The tile resource name is prefixed by its collection ID `terraintiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `terraintiles/@1,2,3z`. */ name?: string; /** diff --git a/src/apis/vision/v1.ts b/src/apis/vision/v1.ts index 9c0dc8b59a..d96d8ddba1 100644 --- a/src/apis/vision/v1.ts +++ b/src/apis/vision/v1.ts @@ -140,7 +140,7 @@ export namespace vision_v1 { */ export interface Schema$AddProductToProductSetRequest { /** - * Required. The resource name for the Product to be added to this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * Required. The resource name for the Product to be added to this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ product?: string | null; } @@ -161,7 +161,7 @@ export namespace vision_v1 { */ inputConfig?: Schema$InputConfig; /** - * Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file. + * Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file. */ pages?: number[] | null; } @@ -299,7 +299,7 @@ export namespace vision_v1 { */ export interface Schema$AsyncBatchAnnotateFilesRequest { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string | null; /** @@ -325,7 +325,7 @@ export namespace vision_v1 { */ outputConfig?: Schema$OutputConfig; /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string | null; /** @@ -347,7 +347,7 @@ export namespace vision_v1 { */ export interface Schema$BatchAnnotateFilesRequest { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string | null; /** @@ -369,7 +369,7 @@ export namespace vision_v1 { */ export interface Schema$BatchAnnotateImagesRequest { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string | null; /** @@ -387,7 +387,7 @@ export namespace vision_v1 { responses?: Schema$AnnotateImageResponse[]; } /** - * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$BatchOperationMetadata { /** @@ -412,7 +412,7 @@ export namespace vision_v1 { */ blockType?: string | null; /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -446,11 +446,11 @@ export namespace vision_v1 { */ export interface Schema$CancelOperationRequest {} /** - * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be equal if all their red, green, blue and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... + * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be equal if all their red, green, blue and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... */ export interface Schema$Color { /** - * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). + * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). */ alpha?: number | null; /** @@ -492,7 +492,7 @@ export namespace vision_v1 { */ boundingPoly?: Schema$BoundingPoly; /** - * Confidence of this being a salient region. Range [0, 1]. + * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number | null; /** @@ -514,7 +514,7 @@ export namespace vision_v1 { */ export interface Schema$CropHintsParams { /** - * Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored. + * Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored. */ aspectRatios?: number[] | null; } @@ -554,7 +554,7 @@ export namespace vision_v1 { colors?: Schema$ColorInfo[]; } /** - * 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 {} /** @@ -619,7 +619,7 @@ export namespace vision_v1 { */ detectionConfidence?: number | null; /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix. */ fdBoundingPoly?: Schema$BoundingPoly; /** @@ -685,7 +685,7 @@ export namespace vision_v1 { */ export interface Schema$GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string | null; } @@ -807,7 +807,7 @@ export namespace vision_v1 { */ blockType?: string | null; /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -862,7 +862,7 @@ export namespace vision_v1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** - * Confidence of this being a salient region. Range [0, 1]. + * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number | null; /** @@ -950,7 +950,7 @@ export namespace vision_v1 { */ detectionConfidence?: number | null; /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1012,7 +1012,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string | null; } @@ -1052,7 +1052,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string | null; /** @@ -1133,7 +1133,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number | null; /** @@ -1171,7 +1171,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1217,15 +1217,15 @@ export namespace vision_v1 { */ displayName?: string | null; /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string | null; /** - * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. + * Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ productLabels?: Schema$GoogleCloudVisionV1p1beta1ProductKeyValue[]; } @@ -1361,7 +1361,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1378,7 +1378,7 @@ export namespace vision_v1 { text?: string | null; } /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p1beta1TextAnnotation { /** @@ -1544,7 +1544,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1669,7 +1669,7 @@ export namespace vision_v1 { */ blockType?: string | null; /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -1724,7 +1724,7 @@ export namespace vision_v1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** - * Confidence of this being a salient region. Range [0, 1]. + * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number | null; /** @@ -1812,7 +1812,7 @@ export namespace vision_v1 { */ detectionConfidence?: number | null; /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -1874,7 +1874,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string | null; } @@ -1914,7 +1914,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string | null; /** @@ -1995,7 +1995,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number | null; /** @@ -2033,7 +2033,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2079,15 +2079,15 @@ export namespace vision_v1 { */ displayName?: string | null; /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string | null; /** - * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. + * Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ productLabels?: Schema$GoogleCloudVisionV1p2beta1ProductKeyValue[]; } @@ -2223,7 +2223,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2240,7 +2240,7 @@ export namespace vision_v1 { text?: string | null; } /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p2beta1TextAnnotation { /** @@ -2406,7 +2406,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2523,7 +2523,7 @@ export namespace vision_v1 { responses?: Schema$GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse[]; } /** - * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVisionV1p3beta1BatchOperationMetadata { /** @@ -2548,7 +2548,7 @@ export namespace vision_v1 { */ blockType?: string | null; /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -2603,7 +2603,7 @@ export namespace vision_v1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** - * Confidence of this being a salient region. Range [0, 1]. + * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number | null; /** @@ -2691,7 +2691,7 @@ export namespace vision_v1 { */ detectionConfidence?: number | null; /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -2753,7 +2753,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string | null; } @@ -2789,7 +2789,7 @@ export namespace vision_v1 { dominantColors?: Schema$GoogleCloudVisionV1p3beta1DominantColorsAnnotation; } /** - * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ export interface Schema$GoogleCloudVisionV1p3beta1ImportProductSetsResponse { /** @@ -2797,7 +2797,7 @@ export namespace vision_v1 { */ referenceImages?: Schema$GoogleCloudVisionV1p3beta1ReferenceImage[]; /** - * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } @@ -2806,7 +2806,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string | null; /** @@ -2887,7 +2887,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number | null; /** @@ -2925,7 +2925,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -2971,15 +2971,15 @@ export namespace vision_v1 { */ displayName?: string | null; /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string | null; /** - * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. + * Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ productLabels?: Schema$GoogleCloudVisionV1p3beta1ProductKeyValue[]; } @@ -3090,15 +3090,15 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ReferenceImage { /** - * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly[]; /** - * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string | null; /** - * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } @@ -3132,7 +3132,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3149,7 +3149,7 @@ export namespace vision_v1 { text?: string | null; } /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p3beta1TextAnnotation { /** @@ -3315,7 +3315,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3450,7 +3450,7 @@ export namespace vision_v1 { responses?: Schema$GoogleCloudVisionV1p4beta1AnnotateFileResponse[]; } /** - * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVisionV1p4beta1BatchOperationMetadata { /** @@ -3475,7 +3475,7 @@ export namespace vision_v1 { */ blockType?: string | null; /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -3547,7 +3547,7 @@ export namespace vision_v1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** - * Confidence of this being a salient region. Range [0, 1]. + * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number | null; /** @@ -3635,7 +3635,7 @@ export namespace vision_v1 { */ detectionConfidence?: number | null; /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -3714,7 +3714,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string | null; } @@ -3750,7 +3750,7 @@ export namespace vision_v1 { dominantColors?: Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation; } /** - * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ export interface Schema$GoogleCloudVisionV1p4beta1ImportProductSetsResponse { /** @@ -3758,7 +3758,7 @@ export namespace vision_v1 { */ referenceImages?: Schema$GoogleCloudVisionV1p4beta1ReferenceImage[]; /** - * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } @@ -3767,7 +3767,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string | null; /** @@ -3848,7 +3848,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number | null; /** @@ -3886,7 +3886,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -3932,15 +3932,15 @@ export namespace vision_v1 { */ displayName?: string | null; /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string | null; /** - * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. + * Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ productLabels?: Schema$GoogleCloudVisionV1p4beta1ProductKeyValue[]; } @@ -4051,15 +4051,15 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1ReferenceImage { /** - * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly[]; /** - * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string | null; /** - * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } @@ -4093,7 +4093,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4110,7 +4110,7 @@ export namespace vision_v1 { text?: string | null; } /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotation { /** @@ -4276,7 +4276,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4314,7 +4314,7 @@ export namespace vision_v1 { */ export interface Schema$Image { /** - * Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateImages requests. It does not work for AsyncBatchAnnotateImages requests. + * Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateImages requests. It does not work for AsyncBatchAnnotateImages requests. */ content?: string | null; /** @@ -4374,11 +4374,11 @@ export namespace vision_v1 { */ export interface Schema$ImageSource { /** - * **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. + * **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. */ gcsImageUri?: string | null; /** - * The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence. + * The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence. */ imageUri?: string | null; } @@ -4387,7 +4387,7 @@ export namespace vision_v1 { */ export interface Schema$ImportProductSetsGcsSource { /** - * The Google Cloud Storage URI of the input csv file. The URI must start with `gs://`. The format of the input csv file should be one image per line. In each line, there are 8 columns. 1. image-uri 2. image-id 3. product-set-id 4. product-id 5. product-category 6. product-display-name 7. labels 8. bounding-poly The `image-uri`, `product-set-id`, `product-id`, and `product-category` columns are required. All other columns are optional. If the `ProductSet` or `Product` specified by the `product-set-id` and `product-id` values does not exist, then the system will create a new `ProductSet` or `Product` for the image. In this case, the `product-display-name` column refers to display_name, the `product-category` column refers to product_category, and the `labels` column refers to product_labels. The `image-id` column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image. The `product-display-name` column is optional. If it is empty, the system sets the display_name field for the product to a space (" "). You can update the `display_name` later by using the API. If a `Product` with the specified `product-id` already exists, then the system ignores the `product-display-name`, `product-category`, and `labels` columns. The `labels` column (optional) is a line containing a list of comma-separated key-value pairs, in the following format: "key_1=value_1,key_2=value_2,...,key_n=value_n" The `bounding-poly` column (optional) identifies one region of interest from the image in the same manner as `CreateReferenceImage`. If you do not specify the `bounding-poly` column, then the system will try to detect regions of interest automatically. At most one `bounding-poly` column is allowed per line. If the image contains multiple regions of interest, add a line to the CSV file that includes the same product information, and the `bounding-poly` values for each region of interest. The `bounding-poly` column must contain an even number of comma-separated numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use non-negative integers for absolute bounding polygons, and float values in [0, 1] for normalized bounding polygons. The system will resize the image if the image resolution is too large to process (larger than 20MP). + * The Google Cloud Storage URI of the input csv file. The URI must start with `gs://`. The format of the input csv file should be one image per line. In each line, there are 8 columns. 1. image-uri 2. image-id 3. product-set-id 4. product-id 5. product-category 6. product-display-name 7. labels 8. bounding-poly The `image-uri`, `product-set-id`, `product-id`, and `product-category` columns are required. All other columns are optional. If the `ProductSet` or `Product` specified by the `product-set-id` and `product-id` values does not exist, then the system will create a new `ProductSet` or `Product` for the image. In this case, the `product-display-name` column refers to display_name, the `product-category` column refers to product_category, and the `labels` column refers to product_labels. The `image-id` column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image. The `product-display-name` column is optional. If it is empty, the system sets the display_name field for the product to a space (" "). You can update the `display_name` later by using the API. If a `Product` with the specified `product-id` already exists, then the system ignores the `product-display-name`, `product-category`, and `labels` columns. The `labels` column (optional) is a line containing a list of comma-separated key-value pairs, in the following format: "key_1=value_1,key_2=value_2,...,key_n=value_n" The `bounding-poly` column (optional) identifies one region of interest from the image in the same manner as `CreateReferenceImage`. If you do not specify the `bounding-poly` column, then the system will try to detect regions of interest automatically. At most one `bounding-poly` column is allowed per line. If the image contains multiple regions of interest, add a line to the CSV file that includes the same product information, and the `bounding-poly` values for each region of interest. The `bounding-poly` column must contain an even number of comma-separated numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use non-negative integers for absolute bounding polygons, and float values in [0, 1] for normalized bounding polygons. The system will resize the image if the image resolution is too large to process (larger than 20MP). */ csvFileUri?: string | null; } @@ -4410,7 +4410,7 @@ export namespace vision_v1 { inputConfig?: Schema$ImportProductSetsInputConfig; } /** - * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ export interface Schema$ImportProductSetsResponse { /** @@ -4418,7 +4418,7 @@ export namespace vision_v1 { */ referenceImages?: Schema$ReferenceImage[]; /** - * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } @@ -4427,7 +4427,7 @@ export namespace vision_v1 { */ export interface Schema$InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string | null; /** @@ -4466,7 +4466,7 @@ export namespace vision_v1 { type?: string | null; } /** - * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. */ export interface Schema$LatLng { /** @@ -4641,7 +4641,7 @@ export namespace vision_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; /** @@ -4649,7 +4649,7 @@ export namespace vision_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; } @@ -4675,7 +4675,7 @@ export namespace vision_v1 { */ export interface Schema$OutputConfig { /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number | null; /** @@ -4713,7 +4713,7 @@ export namespace vision_v1 { */ export interface Schema$Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -4759,15 +4759,15 @@ export namespace vision_v1 { */ displayName?: string | null; /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string | null; /** - * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. + * Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ productLabels?: Schema$KeyValue[]; } @@ -4780,7 +4780,7 @@ export namespace vision_v1 { */ boundingPoly?: Schema$BoundingPoly; /** - * The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='. + * The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='. */ filter?: string | null; /** @@ -4788,7 +4788,7 @@ export namespace vision_v1 { */ productCategories?: string[] | null; /** - * The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. + * The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. */ productSet?: string | null; } @@ -4818,15 +4818,15 @@ export namespace vision_v1 { */ displayName?: string | null; /** - * Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet. + * Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet. */ indexError?: Schema$Status; /** - * Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet. + * Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet. */ indexTime?: string | null; /** - * The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet. + * The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet. */ name?: string | null; } @@ -4878,15 +4878,15 @@ export namespace vision_v1 { */ export interface Schema$ReferenceImage { /** - * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$BoundingPoly[]; /** - * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string | null; /** - * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } @@ -4895,7 +4895,7 @@ export namespace vision_v1 { */ export interface Schema$RemoveProductFromProductSetRequest { /** - * Required. The resource name for the Product to be removed from this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * Required. The resource name for the Product to be removed from this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ product?: string | null; } @@ -4942,7 +4942,7 @@ export namespace vision_v1 { violence?: 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 { /** @@ -4950,7 +4950,7 @@ export namespace vision_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; /** @@ -4963,7 +4963,7 @@ export namespace vision_v1 { */ export interface Schema$Symbol { /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -4980,7 +4980,7 @@ export namespace vision_v1 { text?: string | null; } /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$TextAnnotation { /** @@ -5129,7 +5129,7 @@ export namespace vision_v1 { */ export interface Schema$Word { /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -5154,7 +5154,7 @@ export namespace vision_v1 { /** * vision.files.annotate - * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. + * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. * @example * // Before running the sample: * // - Enable the API at: @@ -5608,7 +5608,7 @@ export namespace vision_v1 { /** * vision.images.asyncBatchAnnotate - * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. * @example * // Before running the sample: * // - Enable the API at: @@ -5783,7 +5783,7 @@ export namespace vision_v1 { /** * vision.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: @@ -5933,7 +5933,7 @@ export namespace vision_v1 { /** * vision.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: @@ -6198,7 +6198,7 @@ export namespace vision_v1 { /** * vision.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: @@ -6332,7 +6332,7 @@ export namespace vision_v1 { /** * vision.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: @@ -6543,7 +6543,7 @@ export namespace vision_v1 { /** * vision.projects.files.annotate - * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. + * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. * @example * // Before running the sample: * // - Enable the API at: @@ -6571,18 +6571,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.files.annotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project', * * // Request body metadata @@ -6611,7 +6600,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().BatchAnnotateFilesRequest} 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. @@ -6733,18 +6722,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.files.asyncBatchAnnotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project', * * // Request body metadata @@ -6777,7 +6755,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().AsyncBatchAnnotateFilesRequest} 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. @@ -6866,7 +6844,7 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Files$Annotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -6878,7 +6856,7 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Files$Asyncbatchannotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -6924,18 +6902,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.images.annotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project', * * // Request body metadata @@ -6964,7 +6931,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().BatchAnnotateImagesRequest} 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. @@ -7058,7 +7025,7 @@ export namespace vision_v1 { /** * vision.projects.images.asyncBatchAnnotate - * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. * @example * // Before running the sample: * // - Enable the API at: @@ -7086,18 +7053,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.images.asyncBatchAnnotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project', * * // Request body metadata @@ -7131,7 +7087,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().AsyncBatchAnnotateImagesRequest} 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. @@ -7220,7 +7176,7 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Images$Annotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -7232,7 +7188,7 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Images$Asyncbatchannotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -7271,7 +7227,7 @@ export namespace vision_v1 { /** * vision.projects.locations.files.annotate - * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. + * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. * @example * // Before running the sample: * // - Enable the API at: @@ -7299,18 +7255,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.files.annotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -7339,7 +7284,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().BatchAnnotateFilesRequest} 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. @@ -7461,18 +7406,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.files.asyncBatchAnnotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -7505,7 +7439,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().AsyncBatchAnnotateFilesRequest} 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. @@ -7594,7 +7528,7 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Locations$Files$Annotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -7606,7 +7540,7 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Locations$Files$Asyncbatchannotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -7652,18 +7586,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.images.annotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -7692,7 +7615,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().BatchAnnotateImagesRequest} 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. @@ -7786,7 +7709,7 @@ export namespace vision_v1 { /** * vision.projects.locations.images.asyncBatchAnnotate - * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. * @example * // Before running the sample: * // - Enable the API at: @@ -7814,18 +7737,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.images.asyncBatchAnnotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -7859,7 +7771,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().AsyncBatchAnnotateImagesRequest} 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. @@ -7948,7 +7860,7 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Locations$Images$Annotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -7960,7 +7872,7 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Locations$Images$Asyncbatchannotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -7978,7 +7890,7 @@ export namespace vision_v1 { /** * vision.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: @@ -8132,7 +8044,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.create - * @desc Creates and returns a new product resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is missing or invalid. + * @desc Creates and returns a new product resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is missing or invalid. * @example * // Before running the sample: * // - Enable the API at: @@ -8160,15 +8072,9 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.products.create({ - * // Required. The project in which the Product should be created. - * // - * // Format is - * // `projects/PROJECT_ID/locations/LOC_ID`. + * // Required. The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. * parent: 'projects/my-project/locations/my-location', - * // A user-supplied resource id for this Product. If set, the server will - * // attempt to use this value as the resource id. If it is already in use, an - * // error is returned with code ALREADY_EXISTS. Must be at most 128 characters - * // long. It cannot contain the character `/`. + * // A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. * productId: 'placeholder-value', * * // Request body metadata @@ -8204,7 +8110,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * @param {string} params.parent Required. The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. * @param {string=} params.productId A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. * @param {().Product} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8292,7 +8198,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.delete - * @desc Permanently deletes a product and its reference images. Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work until all related caches are refreshed. + * @desc Permanently deletes a product and its reference images. Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work until all related caches are refreshed. * @example * // Before running the sample: * // - Enable the API at: @@ -8320,10 +8226,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.products.delete({ - * // Required. Resource name of product to delete. - * // - * // Format is: - * // `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * // Required. Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` * name: 'projects/my-project/locations/my-location/products/my-product', * }); * console.log(res.data); @@ -8341,7 +8244,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * @param {string} params.name Required. Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` * @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 @@ -8424,7 +8327,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.get - * @desc Gets information associated with a Product. Possible errors: * Returns NOT_FOUND if the Product does not exist. + * @desc Gets information associated with a Product. Possible errors: * Returns NOT_FOUND if the Product does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -8452,10 +8355,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.products.get({ - * // Required. Resource name of the Product to get. - * // - * // Format is: - * // `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * // Required. Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` * name: 'projects/my-project/locations/my-location/products/my-product', * }); * console.log(res.data); @@ -8479,7 +8379,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * @param {string} params.name Required. Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` * @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 @@ -8562,7 +8462,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.list - * @desc Lists products in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. + * @desc Lists products in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. * @example * // Before running the sample: * // - Enable the API at: @@ -8594,10 +8494,7 @@ export namespace vision_v1 { * pageSize: 'placeholder-value', * // The next_page_token returned from a previous List request, if any. * pageToken: 'placeholder-value', - * // Required. The project OR ProductSet from which Products should be listed. - * // - * // Format: - * // `projects/PROJECT_ID/locations/LOC_ID` + * // Required. The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID` * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); @@ -8620,7 +8517,7 @@ export namespace vision_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of items to return. Default 10, maximum 100. * @param {string=} params.pageToken The next_page_token returned from a previous List request, if any. - * @param {string} params.parent Required. The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID` + * @param {string} params.parent Required. The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID` * @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 @@ -8711,7 +8608,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.patch - * @desc Makes changes to a Product resource. Only the `display_name`, `description`, and `labels` fields can be updated right now. If labels are updated, the change will not be reflected in queries until the next index time. Possible errors: * Returns NOT_FOUND if the Product does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but is missing from the request or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is present in update_mask but is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is present in update_mask. + * @desc Makes changes to a Product resource. Only the `display_name`, `description`, and `labels` fields can be updated right now. If labels are updated, the change will not be reflected in queries until the next index time. Possible errors: * Returns NOT_FOUND if the Product does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but is missing from the request or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is present in update_mask but is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is present in update_mask. * @example * // Before running the sample: * // - Enable the API at: @@ -8739,18 +8636,9 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.products.patch({ - * // The resource name of the product. - * // - * // Format is: - * // `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - * // - * // This field is ignored when creating a product. + * // The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. * name: 'projects/my-project/locations/my-location/products/my-product', - * // The FieldMask that specifies which fields - * // to update. - * // If update_mask isn't specified, all mutable fields are to be updated. - * // Valid mask paths include `product_labels`, `display_name`, and - * // `description`. + * // The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask paths include `product_labels`, `display_name`, and `description`. * updateMask: 'placeholder-value', * * // Request body metadata @@ -8786,7 +8674,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * @param {string} params.name The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. * @param {string=} params.updateMask The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask paths include `product_labels`, `display_name`, and `description`. * @param {().Product} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8871,7 +8759,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.purge - * @desc Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet. If a Product is a member of the specified ProductSet in addition to other ProductSets, the Product will still be deleted. It is recommended to not delete the specified ProductSet until after this operation has completed. It is also recommended to not add any of the Products involved in the batch delete to a new ProductSet while this operation is running because those Products may still end up deleted. It's not possible to undo the PurgeProducts operation. Therefore, it is recommended to keep the csv files used in ImportProductSets (if that was how you originally built the Product Set) before starting PurgeProducts, in case you need to re-import the data after deletion. If the plan is to purge all of the Products from a ProductSet and then re-use the empty ProductSet to re-import new Products into the empty ProductSet, you must wait until the PurgeProducts operation has finished for that ProductSet. The google.longrunning.Operation API can be used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) + * @desc Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet. If a Product is a member of the specified ProductSet in addition to other ProductSets, the Product will still be deleted. It is recommended to not delete the specified ProductSet until after this operation has completed. It is also recommended to not add any of the Products involved in the batch delete to a new ProductSet while this operation is running because those Products may still end up deleted. It's not possible to undo the PurgeProducts operation. Therefore, it is recommended to keep the csv files used in ImportProductSets (if that was how you originally built the Product Set) before starting PurgeProducts, in case you need to re-import the data after deletion. If the plan is to purge all of the Products from a ProductSet and then re-use the empty ProductSet to re-import new Products into the empty ProductSet, you must wait until the PurgeProducts operation has finished for that ProductSet. The google.longrunning.Operation API can be used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) * @example * // Before running the sample: * // - Enable the API at: @@ -8899,9 +8787,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.products.purge({ - * // Required. The project and location in which the Products should be deleted. - * // - * // Format is `projects/PROJECT_ID/locations/LOC_ID`. + * // Required. The project and location in which the Products should be deleted. Format is `projects/PROJECT_ID/locations/LOC_ID`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -8935,7 +8821,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The project and location in which the Products should be deleted. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * @param {string} params.parent Required. The project and location in which the Products should be deleted. Format is `projects/PROJECT_ID/locations/LOC_ID`. * @param {().PurgeProductsRequest} 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. @@ -9024,7 +8910,7 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Locations$Products$Create extends StandardParameters { /** - * Required. The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * Required. The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; /** @@ -9040,14 +8926,14 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Locations$Products$Delete extends StandardParameters { /** - * Required. Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * Required. Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ name?: string; } export interface Params$Resource$Projects$Locations$Products$Get extends StandardParameters { /** - * Required. Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * Required. Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ name?: string; } @@ -9062,14 +8948,14 @@ export namespace vision_v1 { */ pageToken?: string; /** - * Required. The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID` + * Required. The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID` */ parent?: string; } export interface Params$Resource$Projects$Locations$Products$Patch extends StandardParameters { /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** @@ -9085,7 +8971,7 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Locations$Products$Purge extends StandardParameters { /** - * Required. The project and location in which the Products should be deleted. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * Required. The project and location in which the Products should be deleted. Format is `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; @@ -9103,7 +8989,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.referenceImages.create - * @desc Creates and returns a new ReferenceImage resource. The `bounding_poly` field is optional. If `bounding_poly` is not specified, the system will try to detect regions of interest in the image that are compatible with the product_category on the parent product. If it is specified, detection is ALWAYS skipped. The system converts polygons into non-rotated rectangles. Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP). Possible errors: * Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if the product does not exist. * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected. * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons. + * @desc Creates and returns a new ReferenceImage resource. The `bounding_poly` field is optional. If `bounding_poly` is not specified, the system will try to detect regions of interest in the image that are compatible with the product_category on the parent product. If it is specified, detection is ALWAYS skipped. The system converts polygons into non-rotated rectangles. Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP). Possible errors: * Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if the product does not exist. * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected. * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons. * @example * // Before running the sample: * // - Enable the API at: @@ -9131,15 +9017,9 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.products.referenceImages.create({ - * // Required. Resource name of the product in which to create the reference image. - * // - * // Format is - * // `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + * // Required. Resource name of the product in which to create the reference image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. * parent: 'projects/my-project/locations/my-location/products/my-product', - * // A user-supplied resource id for the ReferenceImage to be added. If set, - * // the server will attempt to use this value as the resource id. If it is - * // already in use, an error is returned with code ALREADY_EXISTS. Must be at - * // most 128 characters long. It cannot contain the character `/`. + * // A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. * referenceImageId: 'placeholder-value', * * // Request body metadata @@ -9171,7 +9051,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. Resource name of the product in which to create the reference image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + * @param {string} params.parent Required. Resource name of the product in which to create the reference image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. * @param {string=} params.referenceImageId A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. * @param {().ReferenceImage} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9259,7 +9139,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.referenceImages.delete - * @desc Permanently deletes a reference image. The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed. The actual image files are not deleted from Google Cloud Storage. + * @desc Permanently deletes a reference image. The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed. The actual image files are not deleted from Google Cloud Storage. * @example * // Before running the sample: * // - Enable the API at: @@ -9287,11 +9167,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.products.referenceImages.delete({ - * // Required. The resource name of the reference image to delete. - * // - * // Format is: - * // - * // `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` + * // Required. The resource name of the reference image to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` * name: * 'projects/my-project/locations/my-location/products/my-product/referenceImages/my-referenceImage', * }); @@ -9310,7 +9186,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the reference image to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` + * @param {string} params.name Required. The resource name of the reference image to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` * @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 @@ -9393,7 +9269,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.referenceImages.get - * @desc Gets information associated with a ReferenceImage. Possible errors: * Returns NOT_FOUND if the specified image does not exist. + * @desc Gets information associated with a ReferenceImage. Possible errors: * Returns NOT_FOUND if the specified image does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -9421,11 +9297,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.products.referenceImages.get({ - * // Required. The resource name of the ReferenceImage to get. - * // - * // Format is: - * // - * // `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. + * // Required. The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. * name: * 'projects/my-project/locations/my-location/products/my-product/referenceImages/my-referenceImage', * }); @@ -9448,7 +9320,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. + * @param {string} params.name Required. The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. * @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 @@ -9531,7 +9403,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.referenceImages.list - * @desc Lists reference images. Possible errors: * Returns NOT_FOUND if the parent product does not exist. * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less than 1. + * @desc Lists reference images. Possible errors: * Returns NOT_FOUND if the parent product does not exist. * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less than 1. * @example * // Before running the sample: * // - Enable the API at: @@ -9561,15 +9433,9 @@ export namespace vision_v1 { * const res = await vision.projects.locations.products.referenceImages.list({ * // The maximum number of items to return. Default 10, maximum 100. * pageSize: 'placeholder-value', - * // A token identifying a page of results to be returned. This is the value - * // of `nextPageToken` returned in a previous reference image list request. - * // - * // Defaults to the first page if not specified. + * // A token identifying a page of results to be returned. This is the value of `nextPageToken` returned in a previous reference image list request. Defaults to the first page if not specified. * pageToken: 'placeholder-value', - * // Required. Resource name of the product containing the reference images. - * // - * // Format is - * // `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + * // Required. Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. * parent: 'projects/my-project/locations/my-location/products/my-product', * }); * console.log(res.data); @@ -9592,8 +9458,8 @@ export namespace vision_v1 { * * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of items to return. Default 10, maximum 100. - * @param {string=} params.pageToken A token identifying a page of results to be returned. This is the value of `nextPageToken` returned in a previous reference image list request. Defaults to the first page if not specified. - * @param {string} params.parent Required. Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + * @param {string=} params.pageToken A token identifying a page of results to be returned. This is the value of `nextPageToken` returned in a previous reference image list request. Defaults to the first page if not specified. + * @param {string} params.parent Required. Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. * @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 @@ -9688,7 +9554,7 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Locations$Products$Referenceimages$Create extends StandardParameters { /** - * Required. Resource name of the product in which to create the reference image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + * Required. Resource name of the product in which to create the reference image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. */ parent?: string; /** @@ -9704,14 +9570,14 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Locations$Products$Referenceimages$Delete extends StandardParameters { /** - * Required. The resource name of the reference image to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` + * Required. The resource name of the reference image to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` */ name?: string; } export interface Params$Resource$Projects$Locations$Products$Referenceimages$Get extends StandardParameters { /** - * Required. The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. + * Required. The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. */ name?: string; } @@ -9722,11 +9588,11 @@ export namespace vision_v1 { */ pageSize?: number; /** - * A token identifying a page of results to be returned. This is the value of `nextPageToken` returned in a previous reference image list request. Defaults to the first page if not specified. + * A token identifying a page of results to be returned. This is the value of `nextPageToken` returned in a previous reference image list request. Defaults to the first page if not specified. */ pageToken?: string; /** - * Required. Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + * Required. Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. */ parent?: string; } @@ -9743,7 +9609,7 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.addProduct - * @desc Adds a Product to the specified ProductSet. If the Product is already present, no change is made. One Product can be added to at most 100 ProductSets. Possible errors: * Returns NOT_FOUND if the Product or the ProductSet doesn't exist. + * @desc Adds a Product to the specified ProductSet. If the Product is already present, no change is made. One Product can be added to at most 100 ProductSets. Possible errors: * Returns NOT_FOUND if the Product or the ProductSet doesn't exist. * @example * // Before running the sample: * // - Enable the API at: @@ -9771,10 +9637,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.productSets.addProduct({ - * // Required. The resource name for the ProductSet to modify. - * // - * // Format is: - * // `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * // Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * name: 'projects/my-project/locations/my-location/productSets/my-productSet', * * // Request body metadata @@ -9800,7 +9663,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * @param {string} params.name Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * @param {().AddProductToProductSetRequest} 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. @@ -9887,7 +9750,7 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.create - * @desc Creates and returns a new ProductSet resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters. + * @desc Creates and returns a new ProductSet resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters. * @example * // Before running the sample: * // - Enable the API at: @@ -9915,14 +9778,9 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.productSets.create({ - * // Required. The project in which the ProductSet should be created. - * // - * // Format is `projects/PROJECT_ID/locations/LOC_ID`. + * // Required. The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. * parent: 'projects/my-project/locations/my-location', - * // A user-supplied resource id for this ProductSet. If set, the server will - * // attempt to use this value as the resource id. If it is already in use, an - * // error is returned with code ALREADY_EXISTS. Must be at most 128 characters - * // long. It cannot contain the character `/`. + * // A user-supplied resource id for this ProductSet. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. * productSetId: 'placeholder-value', * * // Request body metadata @@ -9956,7 +9814,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * @param {string} params.parent Required. The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. * @param {string=} params.productSetId A user-supplied resource id for this ProductSet. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. * @param {().ProductSet} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10044,7 +9902,7 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.delete - * @desc Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted. The actual image files are not deleted from Google Cloud Storage. + * @desc Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted. The actual image files are not deleted from Google Cloud Storage. * @example * // Before running the sample: * // - Enable the API at: @@ -10072,10 +9930,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.productSets.delete({ - * // Required. Resource name of the ProductSet to delete. - * // - * // Format is: - * // `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * // Required. Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * name: 'projects/my-project/locations/my-location/productSets/my-productSet', * }); * console.log(res.data); @@ -10093,7 +9948,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * @param {string} params.name Required. Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * @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 @@ -10176,7 +10031,7 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.get - * @desc Gets information associated with a ProductSet. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist. + * @desc Gets information associated with a ProductSet. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -10204,10 +10059,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.productSets.get({ - * // Required. Resource name of the ProductSet to get. - * // - * // Format is: - * // `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * // Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * name: 'projects/my-project/locations/my-location/productSets/my-productSet', * }); * console.log(res.data); @@ -10230,7 +10082,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * @param {string} params.name Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * @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 @@ -10313,7 +10165,7 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.import - * @desc Asynchronous API that imports a list of reference images to specified product sets based on a list of image information. The google.longrunning.Operation API can be used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) `Operation.response` contains `ImportProductSetsResponse`. (results) The input source of this method is a csv file on Google Cloud Storage. For the format of the csv file please see ImportProductSetsGcsSource.csv_file_uri. + * @desc Asynchronous API that imports a list of reference images to specified product sets based on a list of image information. The google.longrunning.Operation API can be used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) `Operation.response` contains `ImportProductSetsResponse`. (results) The input source of this method is a csv file on Google Cloud Storage. For the format of the csv file please see ImportProductSetsGcsSource.csv_file_uri. * @example * // Before running the sample: * // - Enable the API at: @@ -10341,9 +10193,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.productSets.import({ - * // Required. The project in which the ProductSets should be imported. - * // - * // Format is `projects/PROJECT_ID/locations/LOC_ID`. + * // Required. The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -10375,7 +10225,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * @param {string} params.parent Required. The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`. * @param {().ImportProductSetsRequest} 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. @@ -10462,7 +10312,7 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.list - * @desc Lists ProductSets in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1. + * @desc Lists ProductSets in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1. * @example * // Before running the sample: * // - Enable the API at: @@ -10494,9 +10344,7 @@ export namespace vision_v1 { * pageSize: 'placeholder-value', * // The next_page_token returned from a previous List request, if any. * pageToken: 'placeholder-value', - * // Required. The project from which ProductSets should be listed. - * // - * // Format is `projects/PROJECT_ID/locations/LOC_ID`. + * // Required. The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`. * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); @@ -10519,7 +10367,7 @@ export namespace vision_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of items to return. Default 10, maximum 100. * @param {string=} params.pageToken The next_page_token returned from a previous List request, if any. - * @param {string} params.parent Required. The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * @param {string} params.parent Required. The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`. * @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 @@ -10610,7 +10458,7 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.patch - * @desc Makes changes to a ProductSet resource. Only display_name can be updated currently. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but missing from the request or longer than 4096 characters. + * @desc Makes changes to a ProductSet resource. Only display_name can be updated currently. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but missing from the request or longer than 4096 characters. * @example * // Before running the sample: * // - Enable the API at: @@ -10638,17 +10486,9 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.productSets.patch({ - * // The resource name of the ProductSet. - * // - * // Format is: - * // `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. - * // - * // This field is ignored when creating a ProductSet. + * // The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet. * name: 'projects/my-project/locations/my-location/productSets/my-productSet', - * // The FieldMask that specifies which fields to - * // update. - * // If update_mask isn't specified, all mutable fields are to be updated. - * // Valid mask path is `display_name`. + * // The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask path is `display_name`. * updateMask: 'placeholder-value', * * // Request body metadata @@ -10682,7 +10522,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet. + * @param {string} params.name The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet. * @param {string=} params.updateMask The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask path is `display_name`. * @param {().ProductSet} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10795,10 +10635,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.productSets.removeProduct({ - * // Required. The resource name for the ProductSet to modify. - * // - * // Format is: - * // `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * // Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * name: 'projects/my-project/locations/my-location/productSets/my-productSet', * * // Request body metadata @@ -10824,7 +10661,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * @param {string} params.name Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * @param {().RemoveProductFromProductSetRequest} 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. @@ -10913,7 +10750,7 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Locations$Productsets$Addproduct extends StandardParameters { /** - * Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; @@ -10925,7 +10762,7 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Locations$Productsets$Create extends StandardParameters { /** - * Required. The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * Required. The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; /** @@ -10941,21 +10778,21 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Locations$Productsets$Delete extends StandardParameters { /** - * Required. Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * Required. Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; } export interface Params$Resource$Projects$Locations$Productsets$Get extends StandardParameters { /** - * Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; } export interface Params$Resource$Projects$Locations$Productsets$Import extends StandardParameters { /** - * Required. The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * Required. The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; @@ -10975,14 +10812,14 @@ export namespace vision_v1 { */ pageToken?: string; /** - * Required. The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * Required. The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; } export interface Params$Resource$Projects$Locations$Productsets$Patch extends StandardParameters { /** - * The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet. + * The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet. */ name?: string; /** @@ -10998,7 +10835,7 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Locations$Productsets$Removeproduct extends StandardParameters { /** - * Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; @@ -11016,7 +10853,7 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.products.list - * @desc Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. + * @desc Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. * @example * // Before running the sample: * // - Enable the API at: @@ -11044,10 +10881,7 @@ export namespace vision_v1 { * * // Do the magic * const res = await vision.projects.locations.productSets.products.list({ - * // Required. The ProductSet resource for which to retrieve Products. - * // - * // Format is: - * // `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * // Required. The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * name: 'projects/my-project/locations/my-location/productSets/my-productSet', * // The maximum number of items to return. Default 10, maximum 100. * pageSize: 'placeholder-value', @@ -11072,7 +10906,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * @param {string} params.name Required. The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * @param {integer=} params.pageSize The maximum number of items to return. Default 10, maximum 100. * @param {string=} params.pageToken The next_page_token returned from a previous List request, if any. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11171,7 +11005,7 @@ export namespace vision_v1 { export interface Params$Resource$Projects$Locations$Productsets$Products$List extends StandardParameters { /** - * Required. The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * Required. The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; /** @@ -11192,7 +11026,7 @@ export namespace vision_v1 { /** * vision.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. + * @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: diff --git a/src/apis/vision/v1p1beta1.ts b/src/apis/vision/v1p1beta1.ts index eda6254a08..c5379b0ba1 100644 --- a/src/apis/vision/v1p1beta1.ts +++ b/src/apis/vision/v1p1beta1.ts @@ -250,7 +250,7 @@ export namespace vision_v1p1beta1 { responses?: Schema$AnnotateFileResponse[]; } /** - * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$BatchOperationMetadata { /** @@ -275,7 +275,7 @@ export namespace vision_v1p1beta1 { */ blockType?: string | null; /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -305,11 +305,11 @@ export namespace vision_v1p1beta1 { vertices?: Schema$Vertex[]; } /** - * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be equal if all their red, green, blue and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... + * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be equal if all their red, green, blue and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... */ export interface Schema$Color { /** - * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). + * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). */ alpha?: number | null; /** @@ -351,7 +351,7 @@ export namespace vision_v1p1beta1 { */ boundingPoly?: Schema$BoundingPoly; /** - * Confidence of this being a salient region. Range [0, 1]. + * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number | null; /** @@ -465,7 +465,7 @@ export namespace vision_v1p1beta1 { */ detectionConfidence?: number | null; /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix. */ fdBoundingPoly?: Schema$BoundingPoly; /** @@ -514,7 +514,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string | null; } @@ -544,7 +544,7 @@ export namespace vision_v1p1beta1 { */ inputConfig?: Schema$GoogleCloudVisionV1p1beta1InputConfig; /** - * Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file. + * Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file. */ pages?: number[] | null; } @@ -682,7 +682,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string | null; /** @@ -708,7 +708,7 @@ export namespace vision_v1p1beta1 { */ outputConfig?: Schema$GoogleCloudVisionV1p1beta1OutputConfig; /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string | null; /** @@ -721,7 +721,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string | null; /** @@ -743,7 +743,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string | null; /** @@ -769,7 +769,7 @@ export namespace vision_v1p1beta1 { */ blockType?: string | null; /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -824,7 +824,7 @@ export namespace vision_v1p1beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** - * Confidence of this being a salient region. Range [0, 1]. + * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number | null; /** @@ -846,7 +846,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1CropHintsParams { /** - * Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored. + * Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored. */ aspectRatios?: number[] | null; } @@ -921,7 +921,7 @@ export namespace vision_v1p1beta1 { */ detectionConfidence?: number | null; /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1000,7 +1000,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string | null; } @@ -1018,7 +1018,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Image { /** - * Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateImages requests. It does not work for AsyncBatchAnnotateImages requests. + * Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateImages requests. It does not work for AsyncBatchAnnotateImages requests. */ content?: string | null; /** @@ -1078,11 +1078,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1ImageSource { /** - * **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. + * **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. */ gcsImageUri?: string | null; /** - * The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence. + * The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence. */ imageUri?: string | null; } @@ -1091,7 +1091,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string | null; /** @@ -1185,7 +1185,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number | null; /** @@ -1223,7 +1223,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1269,15 +1269,15 @@ export namespace vision_v1p1beta1 { */ displayName?: string | null; /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string | null; /** - * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. + * Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ productLabels?: Schema$GoogleCloudVisionV1p1beta1ProductKeyValue[]; } @@ -1303,7 +1303,7 @@ export namespace vision_v1p1beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** - * The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='. + * The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='. */ filter?: string | null; /** @@ -1311,7 +1311,7 @@ export namespace vision_v1p1beta1 { */ productCategories?: string[] | null; /** - * The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. + * The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. */ productSet?: string | null; } @@ -1434,7 +1434,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1451,7 +1451,7 @@ export namespace vision_v1p1beta1 { text?: string | null; } /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p1beta1TextAnnotation { /** @@ -1626,7 +1626,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1751,7 +1751,7 @@ export namespace vision_v1p1beta1 { */ blockType?: string | null; /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -1806,7 +1806,7 @@ export namespace vision_v1p1beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** - * Confidence of this being a salient region. Range [0, 1]. + * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number | null; /** @@ -1894,7 +1894,7 @@ export namespace vision_v1p1beta1 { */ detectionConfidence?: number | null; /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -1956,7 +1956,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string | null; } @@ -1996,7 +1996,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string | null; /** @@ -2077,7 +2077,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number | null; /** @@ -2115,7 +2115,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2161,15 +2161,15 @@ export namespace vision_v1p1beta1 { */ displayName?: string | null; /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string | null; /** - * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. + * Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ productLabels?: Schema$GoogleCloudVisionV1p2beta1ProductKeyValue[]; } @@ -2305,7 +2305,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2322,7 +2322,7 @@ export namespace vision_v1p1beta1 { text?: string | null; } /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p2beta1TextAnnotation { /** @@ -2488,7 +2488,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2605,7 +2605,7 @@ export namespace vision_v1p1beta1 { responses?: Schema$GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse[]; } /** - * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVisionV1p3beta1BatchOperationMetadata { /** @@ -2630,7 +2630,7 @@ export namespace vision_v1p1beta1 { */ blockType?: string | null; /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -2685,7 +2685,7 @@ export namespace vision_v1p1beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** - * Confidence of this being a salient region. Range [0, 1]. + * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number | null; /** @@ -2773,7 +2773,7 @@ export namespace vision_v1p1beta1 { */ detectionConfidence?: number | null; /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -2835,7 +2835,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string | null; } @@ -2871,7 +2871,7 @@ export namespace vision_v1p1beta1 { dominantColors?: Schema$GoogleCloudVisionV1p3beta1DominantColorsAnnotation; } /** - * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ export interface Schema$GoogleCloudVisionV1p3beta1ImportProductSetsResponse { /** @@ -2879,7 +2879,7 @@ export namespace vision_v1p1beta1 { */ referenceImages?: Schema$GoogleCloudVisionV1p3beta1ReferenceImage[]; /** - * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } @@ -2888,7 +2888,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string | null; /** @@ -2969,7 +2969,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number | null; /** @@ -3007,7 +3007,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3053,15 +3053,15 @@ export namespace vision_v1p1beta1 { */ displayName?: string | null; /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string | null; /** - * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. + * Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ productLabels?: Schema$GoogleCloudVisionV1p3beta1ProductKeyValue[]; } @@ -3172,15 +3172,15 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ReferenceImage { /** - * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly[]; /** - * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string | null; /** - * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } @@ -3214,7 +3214,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3231,7 +3231,7 @@ export namespace vision_v1p1beta1 { text?: string | null; } /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p3beta1TextAnnotation { /** @@ -3397,7 +3397,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3532,7 +3532,7 @@ export namespace vision_v1p1beta1 { responses?: Schema$GoogleCloudVisionV1p4beta1AnnotateFileResponse[]; } /** - * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVisionV1p4beta1BatchOperationMetadata { /** @@ -3557,7 +3557,7 @@ export namespace vision_v1p1beta1 { */ blockType?: string | null; /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -3629,7 +3629,7 @@ export namespace vision_v1p1beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** - * Confidence of this being a salient region. Range [0, 1]. + * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number | null; /** @@ -3717,7 +3717,7 @@ export namespace vision_v1p1beta1 { */ detectionConfidence?: number | null; /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -3796,7 +3796,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string | null; } @@ -3832,7 +3832,7 @@ export namespace vision_v1p1beta1 { dominantColors?: Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation; } /** - * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ export interface Schema$GoogleCloudVisionV1p4beta1ImportProductSetsResponse { /** @@ -3840,7 +3840,7 @@ export namespace vision_v1p1beta1 { */ referenceImages?: Schema$GoogleCloudVisionV1p4beta1ReferenceImage[]; /** - * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } @@ -3849,7 +3849,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string | null; /** @@ -3930,7 +3930,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number | null; /** @@ -3968,7 +3968,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4014,15 +4014,15 @@ export namespace vision_v1p1beta1 { */ displayName?: string | null; /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string | null; /** - * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. + * Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ productLabels?: Schema$GoogleCloudVisionV1p4beta1ProductKeyValue[]; } @@ -4133,15 +4133,15 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1ReferenceImage { /** - * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly[]; /** - * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string | null; /** - * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } @@ -4175,7 +4175,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4192,7 +4192,7 @@ export namespace vision_v1p1beta1 { text?: string | null; } /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotation { /** @@ -4358,7 +4358,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4414,7 +4414,7 @@ export namespace vision_v1p1beta1 { dominantColors?: Schema$DominantColorsAnnotation; } /** - * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ export interface Schema$ImportProductSetsResponse { /** @@ -4422,7 +4422,7 @@ export namespace vision_v1p1beta1 { */ referenceImages?: Schema$ReferenceImage[]; /** - * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } @@ -4431,7 +4431,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string | null; /** @@ -4470,7 +4470,7 @@ export namespace vision_v1p1beta1 { type?: string | null; } /** - * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. */ export interface Schema$LatLng { /** @@ -4563,7 +4563,7 @@ export namespace vision_v1p1beta1 { */ 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; /** @@ -4571,7 +4571,7 @@ export namespace vision_v1p1beta1 { */ 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; } @@ -4597,7 +4597,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$OutputConfig { /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number | null; /** @@ -4635,7 +4635,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -4681,15 +4681,15 @@ export namespace vision_v1p1beta1 { */ displayName?: string | null; /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string | null; /** - * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. + * Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ productLabels?: Schema$KeyValue[]; } @@ -4732,15 +4732,15 @@ export namespace vision_v1p1beta1 { */ export interface Schema$ReferenceImage { /** - * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$BoundingPoly[]; /** - * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string | null; /** - * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } @@ -4787,7 +4787,7 @@ export namespace vision_v1p1beta1 { violence?: 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 { /** @@ -4795,7 +4795,7 @@ export namespace vision_v1p1beta1 { */ 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; /** @@ -4808,7 +4808,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$Symbol { /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -4825,7 +4825,7 @@ export namespace vision_v1p1beta1 { text?: string | null; } /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$TextAnnotation { /** @@ -4965,7 +4965,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$Word { /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -4990,7 +4990,7 @@ export namespace vision_v1p1beta1 { /** * vision.files.annotate - * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. + * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. * @example * // Before running the sample: * // - Enable the API at: @@ -5485,7 +5485,7 @@ export namespace vision_v1p1beta1 { /** * vision.images.asyncBatchAnnotate - * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. * @example * // Before running the sample: * // - Enable the API at: @@ -5664,7 +5664,7 @@ export namespace vision_v1p1beta1 { /** * vision.projects.files.annotate - * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. + * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. * @example * // Before running the sample: * // - Enable the API at: @@ -5692,18 +5692,7 @@ export namespace vision_v1p1beta1 { * * // Do the magic * const res = await vision.projects.files.annotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project', * * // Request body metadata @@ -5732,7 +5721,7 @@ export namespace vision_v1p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest} 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. @@ -5873,18 +5862,7 @@ export namespace vision_v1p1beta1 { * * // Do the magic * const res = await vision.projects.files.asyncBatchAnnotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project', * * // Request body metadata @@ -5917,7 +5895,7 @@ export namespace vision_v1p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest} 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. @@ -6005,7 +5983,7 @@ export namespace vision_v1p1beta1 { export interface Params$Resource$Projects$Files$Annotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -6017,7 +5995,7 @@ export namespace vision_v1p1beta1 { export interface Params$Resource$Projects$Files$Asyncbatchannotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -6063,18 +6041,7 @@ export namespace vision_v1p1beta1 { * * // Do the magic * const res = await vision.projects.images.annotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project', * * // Request body metadata @@ -6103,7 +6070,7 @@ export namespace vision_v1p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest} 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. @@ -6216,7 +6183,7 @@ export namespace vision_v1p1beta1 { /** * vision.projects.images.asyncBatchAnnotate - * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. * @example * // Before running the sample: * // - Enable the API at: @@ -6244,18 +6211,7 @@ export namespace vision_v1p1beta1 { * * // Do the magic * const res = await vision.projects.images.asyncBatchAnnotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project', * * // Request body metadata @@ -6289,7 +6245,7 @@ export namespace vision_v1p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest} 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. @@ -6377,7 +6333,7 @@ export namespace vision_v1p1beta1 { export interface Params$Resource$Projects$Images$Annotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -6389,7 +6345,7 @@ export namespace vision_v1p1beta1 { export interface Params$Resource$Projects$Images$Asyncbatchannotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -6418,7 +6374,7 @@ export namespace vision_v1p1beta1 { /** * vision.projects.locations.files.annotate - * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. + * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. * @example * // Before running the sample: * // - Enable the API at: @@ -6446,18 +6402,7 @@ export namespace vision_v1p1beta1 { * * // Do the magic * const res = await vision.projects.locations.files.annotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -6486,7 +6431,7 @@ export namespace vision_v1p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest} 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. @@ -6627,18 +6572,7 @@ export namespace vision_v1p1beta1 { * * // Do the magic * const res = await vision.projects.locations.files.asyncBatchAnnotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -6671,7 +6605,7 @@ export namespace vision_v1p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest} 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. @@ -6759,7 +6693,7 @@ export namespace vision_v1p1beta1 { export interface Params$Resource$Projects$Locations$Files$Annotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -6771,7 +6705,7 @@ export namespace vision_v1p1beta1 { export interface Params$Resource$Projects$Locations$Files$Asyncbatchannotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -6817,18 +6751,7 @@ export namespace vision_v1p1beta1 { * * // Do the magic * const res = await vision.projects.locations.images.annotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -6857,7 +6780,7 @@ export namespace vision_v1p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest} 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. @@ -6970,7 +6893,7 @@ export namespace vision_v1p1beta1 { /** * vision.projects.locations.images.asyncBatchAnnotate - * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. * @example * // Before running the sample: * // - Enable the API at: @@ -6998,18 +6921,7 @@ export namespace vision_v1p1beta1 { * * // Do the magic * const res = await vision.projects.locations.images.asyncBatchAnnotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -7043,7 +6955,7 @@ export namespace vision_v1p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest} 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. @@ -7131,7 +7043,7 @@ export namespace vision_v1p1beta1 { export interface Params$Resource$Projects$Locations$Images$Annotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -7143,7 +7055,7 @@ export namespace vision_v1p1beta1 { export interface Params$Resource$Projects$Locations$Images$Asyncbatchannotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; diff --git a/src/apis/vision/v1p2beta1.ts b/src/apis/vision/v1p2beta1.ts index 89c4f17951..afb89dbed0 100644 --- a/src/apis/vision/v1p2beta1.ts +++ b/src/apis/vision/v1p2beta1.ts @@ -250,7 +250,7 @@ export namespace vision_v1p2beta1 { responses?: Schema$AnnotateFileResponse[]; } /** - * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$BatchOperationMetadata { /** @@ -275,7 +275,7 @@ export namespace vision_v1p2beta1 { */ blockType?: string | null; /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -305,11 +305,11 @@ export namespace vision_v1p2beta1 { vertices?: Schema$Vertex[]; } /** - * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be equal if all their red, green, blue and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... + * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be equal if all their red, green, blue and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... */ export interface Schema$Color { /** - * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). + * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). */ alpha?: number | null; /** @@ -351,7 +351,7 @@ export namespace vision_v1p2beta1 { */ boundingPoly?: Schema$BoundingPoly; /** - * Confidence of this being a salient region. Range [0, 1]. + * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number | null; /** @@ -465,7 +465,7 @@ export namespace vision_v1p2beta1 { */ detectionConfidence?: number | null; /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix. */ fdBoundingPoly?: Schema$BoundingPoly; /** @@ -514,7 +514,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string | null; } @@ -636,7 +636,7 @@ export namespace vision_v1p2beta1 { */ blockType?: string | null; /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -691,7 +691,7 @@ export namespace vision_v1p2beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** - * Confidence of this being a salient region. Range [0, 1]. + * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number | null; /** @@ -779,7 +779,7 @@ export namespace vision_v1p2beta1 { */ detectionConfidence?: number | null; /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -841,7 +841,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string | null; } @@ -881,7 +881,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string | null; /** @@ -962,7 +962,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number | null; /** @@ -1000,7 +1000,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1046,15 +1046,15 @@ export namespace vision_v1p2beta1 { */ displayName?: string | null; /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string | null; /** - * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. + * Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ productLabels?: Schema$GoogleCloudVisionV1p1beta1ProductKeyValue[]; } @@ -1190,7 +1190,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1207,7 +1207,7 @@ export namespace vision_v1p2beta1 { text?: string | null; } /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p1beta1TextAnnotation { /** @@ -1373,7 +1373,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1406,7 +1406,7 @@ export namespace vision_v1p2beta1 { */ inputConfig?: Schema$GoogleCloudVisionV1p2beta1InputConfig; /** - * Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file. + * Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file. */ pages?: number[] | null; } @@ -1544,7 +1544,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string | null; /** @@ -1570,7 +1570,7 @@ export namespace vision_v1p2beta1 { */ outputConfig?: Schema$GoogleCloudVisionV1p2beta1OutputConfig; /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string | null; /** @@ -1583,7 +1583,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string | null; /** @@ -1605,7 +1605,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string | null; /** @@ -1631,7 +1631,7 @@ export namespace vision_v1p2beta1 { */ blockType?: string | null; /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -1686,7 +1686,7 @@ export namespace vision_v1p2beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** - * Confidence of this being a salient region. Range [0, 1]. + * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number | null; /** @@ -1708,7 +1708,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1CropHintsParams { /** - * Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored. + * Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored. */ aspectRatios?: number[] | null; } @@ -1783,7 +1783,7 @@ export namespace vision_v1p2beta1 { */ detectionConfidence?: number | null; /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -1862,7 +1862,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string | null; } @@ -1880,7 +1880,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Image { /** - * Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateImages requests. It does not work for AsyncBatchAnnotateImages requests. + * Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateImages requests. It does not work for AsyncBatchAnnotateImages requests. */ content?: string | null; /** @@ -1940,11 +1940,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1ImageSource { /** - * **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. + * **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. */ gcsImageUri?: string | null; /** - * The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence. + * The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence. */ imageUri?: string | null; } @@ -1953,7 +1953,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string | null; /** @@ -2047,7 +2047,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number | null; /** @@ -2085,7 +2085,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2131,15 +2131,15 @@ export namespace vision_v1p2beta1 { */ displayName?: string | null; /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string | null; /** - * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. + * Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ productLabels?: Schema$GoogleCloudVisionV1p2beta1ProductKeyValue[]; } @@ -2165,7 +2165,7 @@ export namespace vision_v1p2beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** - * The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='. + * The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='. */ filter?: string | null; /** @@ -2173,7 +2173,7 @@ export namespace vision_v1p2beta1 { */ productCategories?: string[] | null; /** - * The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. + * The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. */ productSet?: string | null; } @@ -2296,7 +2296,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2313,7 +2313,7 @@ export namespace vision_v1p2beta1 { text?: string | null; } /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p2beta1TextAnnotation { /** @@ -2488,7 +2488,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2605,7 +2605,7 @@ export namespace vision_v1p2beta1 { responses?: Schema$GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse[]; } /** - * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVisionV1p3beta1BatchOperationMetadata { /** @@ -2630,7 +2630,7 @@ export namespace vision_v1p2beta1 { */ blockType?: string | null; /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -2685,7 +2685,7 @@ export namespace vision_v1p2beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** - * Confidence of this being a salient region. Range [0, 1]. + * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number | null; /** @@ -2773,7 +2773,7 @@ export namespace vision_v1p2beta1 { */ detectionConfidence?: number | null; /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -2835,7 +2835,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string | null; } @@ -2871,7 +2871,7 @@ export namespace vision_v1p2beta1 { dominantColors?: Schema$GoogleCloudVisionV1p3beta1DominantColorsAnnotation; } /** - * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ export interface Schema$GoogleCloudVisionV1p3beta1ImportProductSetsResponse { /** @@ -2879,7 +2879,7 @@ export namespace vision_v1p2beta1 { */ referenceImages?: Schema$GoogleCloudVisionV1p3beta1ReferenceImage[]; /** - * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } @@ -2888,7 +2888,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string | null; /** @@ -2969,7 +2969,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number | null; /** @@ -3007,7 +3007,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3053,15 +3053,15 @@ export namespace vision_v1p2beta1 { */ displayName?: string | null; /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string | null; /** - * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. + * Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ productLabels?: Schema$GoogleCloudVisionV1p3beta1ProductKeyValue[]; } @@ -3172,15 +3172,15 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ReferenceImage { /** - * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly[]; /** - * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string | null; /** - * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } @@ -3214,7 +3214,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3231,7 +3231,7 @@ export namespace vision_v1p2beta1 { text?: string | null; } /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p3beta1TextAnnotation { /** @@ -3397,7 +3397,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3532,7 +3532,7 @@ export namespace vision_v1p2beta1 { responses?: Schema$GoogleCloudVisionV1p4beta1AnnotateFileResponse[]; } /** - * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVisionV1p4beta1BatchOperationMetadata { /** @@ -3557,7 +3557,7 @@ export namespace vision_v1p2beta1 { */ blockType?: string | null; /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -3629,7 +3629,7 @@ export namespace vision_v1p2beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** - * Confidence of this being a salient region. Range [0, 1]. + * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number | null; /** @@ -3717,7 +3717,7 @@ export namespace vision_v1p2beta1 { */ detectionConfidence?: number | null; /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -3796,7 +3796,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string | null; } @@ -3832,7 +3832,7 @@ export namespace vision_v1p2beta1 { dominantColors?: Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation; } /** - * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ export interface Schema$GoogleCloudVisionV1p4beta1ImportProductSetsResponse { /** @@ -3840,7 +3840,7 @@ export namespace vision_v1p2beta1 { */ referenceImages?: Schema$GoogleCloudVisionV1p4beta1ReferenceImage[]; /** - * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } @@ -3849,7 +3849,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string | null; /** @@ -3930,7 +3930,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number | null; /** @@ -3968,7 +3968,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4014,15 +4014,15 @@ export namespace vision_v1p2beta1 { */ displayName?: string | null; /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string | null; /** - * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. + * Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ productLabels?: Schema$GoogleCloudVisionV1p4beta1ProductKeyValue[]; } @@ -4133,15 +4133,15 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1ReferenceImage { /** - * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly[]; /** - * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string | null; /** - * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } @@ -4175,7 +4175,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4192,7 +4192,7 @@ export namespace vision_v1p2beta1 { text?: string | null; } /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotation { /** @@ -4358,7 +4358,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4414,7 +4414,7 @@ export namespace vision_v1p2beta1 { dominantColors?: Schema$DominantColorsAnnotation; } /** - * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ export interface Schema$ImportProductSetsResponse { /** @@ -4422,7 +4422,7 @@ export namespace vision_v1p2beta1 { */ referenceImages?: Schema$ReferenceImage[]; /** - * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } @@ -4431,7 +4431,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string | null; /** @@ -4470,7 +4470,7 @@ export namespace vision_v1p2beta1 { type?: string | null; } /** - * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. */ export interface Schema$LatLng { /** @@ -4563,7 +4563,7 @@ export namespace vision_v1p2beta1 { */ 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; /** @@ -4571,7 +4571,7 @@ export namespace vision_v1p2beta1 { */ 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; } @@ -4597,7 +4597,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$OutputConfig { /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number | null; /** @@ -4635,7 +4635,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -4681,15 +4681,15 @@ export namespace vision_v1p2beta1 { */ displayName?: string | null; /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string | null; /** - * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. + * Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ productLabels?: Schema$KeyValue[]; } @@ -4732,15 +4732,15 @@ export namespace vision_v1p2beta1 { */ export interface Schema$ReferenceImage { /** - * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$BoundingPoly[]; /** - * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string | null; /** - * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } @@ -4787,7 +4787,7 @@ export namespace vision_v1p2beta1 { violence?: 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 { /** @@ -4795,7 +4795,7 @@ export namespace vision_v1p2beta1 { */ 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; /** @@ -4808,7 +4808,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$Symbol { /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -4825,7 +4825,7 @@ export namespace vision_v1p2beta1 { text?: string | null; } /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$TextAnnotation { /** @@ -4965,7 +4965,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$Word { /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -4990,7 +4990,7 @@ export namespace vision_v1p2beta1 { /** * vision.files.annotate - * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. + * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. * @example * // Before running the sample: * // - Enable the API at: @@ -5485,7 +5485,7 @@ export namespace vision_v1p2beta1 { /** * vision.images.asyncBatchAnnotate - * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. * @example * // Before running the sample: * // - Enable the API at: @@ -5664,7 +5664,7 @@ export namespace vision_v1p2beta1 { /** * vision.projects.files.annotate - * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. + * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. * @example * // Before running the sample: * // - Enable the API at: @@ -5692,18 +5692,7 @@ export namespace vision_v1p2beta1 { * * // Do the magic * const res = await vision.projects.files.annotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project', * * // Request body metadata @@ -5732,7 +5721,7 @@ export namespace vision_v1p2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest} 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. @@ -5873,18 +5862,7 @@ export namespace vision_v1p2beta1 { * * // Do the magic * const res = await vision.projects.files.asyncBatchAnnotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project', * * // Request body metadata @@ -5917,7 +5895,7 @@ export namespace vision_v1p2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest} 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. @@ -6005,7 +5983,7 @@ export namespace vision_v1p2beta1 { export interface Params$Resource$Projects$Files$Annotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -6017,7 +5995,7 @@ export namespace vision_v1p2beta1 { export interface Params$Resource$Projects$Files$Asyncbatchannotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -6063,18 +6041,7 @@ export namespace vision_v1p2beta1 { * * // Do the magic * const res = await vision.projects.images.annotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project', * * // Request body metadata @@ -6103,7 +6070,7 @@ export namespace vision_v1p2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest} 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. @@ -6216,7 +6183,7 @@ export namespace vision_v1p2beta1 { /** * vision.projects.images.asyncBatchAnnotate - * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. * @example * // Before running the sample: * // - Enable the API at: @@ -6244,18 +6211,7 @@ export namespace vision_v1p2beta1 { * * // Do the magic * const res = await vision.projects.images.asyncBatchAnnotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project', * * // Request body metadata @@ -6289,7 +6245,7 @@ export namespace vision_v1p2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest} 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. @@ -6377,7 +6333,7 @@ export namespace vision_v1p2beta1 { export interface Params$Resource$Projects$Images$Annotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -6389,7 +6345,7 @@ export namespace vision_v1p2beta1 { export interface Params$Resource$Projects$Images$Asyncbatchannotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -6418,7 +6374,7 @@ export namespace vision_v1p2beta1 { /** * vision.projects.locations.files.annotate - * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. + * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. * @example * // Before running the sample: * // - Enable the API at: @@ -6446,18 +6402,7 @@ export namespace vision_v1p2beta1 { * * // Do the magic * const res = await vision.projects.locations.files.annotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -6486,7 +6431,7 @@ export namespace vision_v1p2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest} 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. @@ -6627,18 +6572,7 @@ export namespace vision_v1p2beta1 { * * // Do the magic * const res = await vision.projects.locations.files.asyncBatchAnnotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -6671,7 +6605,7 @@ export namespace vision_v1p2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest} 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. @@ -6759,7 +6693,7 @@ export namespace vision_v1p2beta1 { export interface Params$Resource$Projects$Locations$Files$Annotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -6771,7 +6705,7 @@ export namespace vision_v1p2beta1 { export interface Params$Resource$Projects$Locations$Files$Asyncbatchannotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -6817,18 +6751,7 @@ export namespace vision_v1p2beta1 { * * // Do the magic * const res = await vision.projects.locations.images.annotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -6857,7 +6780,7 @@ export namespace vision_v1p2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest} 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. @@ -6970,7 +6893,7 @@ export namespace vision_v1p2beta1 { /** * vision.projects.locations.images.asyncBatchAnnotate - * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. * @example * // Before running the sample: * // - Enable the API at: @@ -6998,18 +6921,7 @@ export namespace vision_v1p2beta1 { * * // Do the magic * const res = await vision.projects.locations.images.asyncBatchAnnotate({ - * // Optional. Target project and location to make a call. - * // - * // Format: `projects/{project-id}/locations/{location-id}`. - * // - * // If no parent is specified, a region will be chosen automatically. - * // - * // Supported location-ids: - * // `us`: USA country only, - * // `asia`: East asia areas, like Japan, Taiwan, - * // `eu`: The European Union. - * // - * // Example: `projects/project-A/locations/eu`. + * // Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata @@ -7043,7 +6955,7 @@ export namespace vision_v1p2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * @param {string} params.parent Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. * @param {().GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest} 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. @@ -7131,7 +7043,7 @@ export namespace vision_v1p2beta1 { export interface Params$Resource$Projects$Locations$Images$Annotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; @@ -7143,7 +7055,7 @@ export namespace vision_v1p2beta1 { export interface Params$Resource$Projects$Locations$Images$Asyncbatchannotate extends StandardParameters { /** - * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. + * Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. */ parent?: string; diff --git a/src/apis/websecurityscanner/v1.ts b/src/apis/websecurityscanner/v1.ts index bf00f30dad..3bbe2a4a15 100644 --- a/src/apis/websecurityscanner/v1.ts +++ b/src/apis/websecurityscanner/v1.ts @@ -179,7 +179,7 @@ export namespace websecurityscanner_v1 { username?: 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 {} /** @@ -666,8 +666,7 @@ export namespace websecurityscanner_v1 { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.create({ - * // Required. The parent resource name where the scan is created, which should be a - * // project resource name in the format 'projects/{projectId}'. + * // Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'. * parent: 'projects/my-project', * * // Request body metadata @@ -830,8 +829,7 @@ export namespace websecurityscanner_v1 { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.delete({ - * // Required. The resource name of the ScanConfig to be deleted. The name follows the - * // format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * // Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. * name: 'projects/my-project/scanConfigs/my-scanConfig', * }); * console.log(res.data); @@ -958,8 +956,7 @@ export namespace websecurityscanner_v1 { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.get({ - * // Required. The resource name of the ScanConfig to be returned. The name follows the - * // format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * // Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. * name: 'projects/my-project/scanConfigs/my-scanConfig', * }); * console.log(res.data); @@ -1099,16 +1096,11 @@ export namespace websecurityscanner_v1 { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.list({ - * // The maximum number of ScanConfigs to return, can be limited by server. - * // If not specified or not positive, the implementation will select a - * // reasonable value. + * // The maximum number of ScanConfigs to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * pageSize: 'placeholder-value', - * // A token identifying a page of results to be returned. This should be a - * // `next_page_token` value returned from a previous List request. - * // If unspecified, the first page of results is returned. + * // A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * pageToken: 'placeholder-value', - * // Required. The parent resource name, which should be a project resource name in the - * // format 'projects/{projectId}'. + * // Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. * parent: 'projects/my-project', * }); * console.log(res.data); @@ -1248,13 +1240,9 @@ export namespace websecurityscanner_v1 { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.patch({ - * // The resource name of the ScanConfig. The name follows the format of - * // 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are - * // generated by the system. + * // The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. * name: 'projects/my-project/scanConfigs/my-scanConfig', - * // Required. The update mask applies to the resource. For the `FieldMask` definition, - * // see - * // https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * // Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask * updateMask: 'placeholder-value', * * // Request body metadata @@ -1415,8 +1403,7 @@ export namespace websecurityscanner_v1 { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.start({ - * // Required. The resource name of the ScanConfig to be used. The name follows the - * // format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * // Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. * name: 'projects/my-project/scanConfigs/my-scanConfig', * * // Request body metadata @@ -1651,9 +1638,7 @@ export namespace websecurityscanner_v1 { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.get({ - * // Required. The resource name of the ScanRun to be returned. The name follows the - * // format of - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * // Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * name: 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun', * }); * console.log(res.data); @@ -1792,16 +1777,11 @@ export namespace websecurityscanner_v1 { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.list({ - * // The maximum number of ScanRuns to return, can be limited by server. - * // If not specified or not positive, the implementation will select a - * // reasonable value. + * // The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * pageSize: 'placeholder-value', - * // A token identifying a page of results to be returned. This should be a - * // `next_page_token` value returned from a previous List request. - * // If unspecified, the first page of results is returned. + * // A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * pageToken: 'placeholder-value', - * // Required. The parent resource name, which should be a scan resource name in the - * // format 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * // Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. * parent: 'projects/my-project/scanConfigs/my-scanConfig', * }); * console.log(res.data); @@ -1941,9 +1921,7 @@ export namespace websecurityscanner_v1 { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.stop({ - * // Required. The resource name of the ScanRun to be stopped. The name follows the - * // format of - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * // Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * name: 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun', * * // Request body metadata @@ -2132,17 +2110,11 @@ export namespace websecurityscanner_v1 { * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.crawledUrls.list( * { - * // The maximum number of CrawledUrls to return, can be limited by server. - * // If not specified or not positive, the implementation will select a - * // reasonable value. + * // The maximum number of CrawledUrls to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * pageSize: 'placeholder-value', - * // A token identifying a page of results to be returned. This should be a - * // `next_page_token` value returned from a previous List request. - * // If unspecified, the first page of results is returned. + * // A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * pageToken: 'placeholder-value', - * // Required. The parent resource name, which should be a scan run resource name in the - * // format - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * // Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * parent: * 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun', * } @@ -2308,9 +2280,7 @@ export namespace websecurityscanner_v1 { * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.findings.get( * { - * // Required. The resource name of the Finding to be returned. The name follows the - * // format of - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. + * // Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. * name: * 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun/findings/my-finding', * } @@ -2458,22 +2428,13 @@ export namespace websecurityscanner_v1 { * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.findings.list( * { - * // The filter expression. The expression must be in the format: - * // . - * // Supported field: 'finding_type'. - * // Supported operator: '='. + * // The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. * filter: 'placeholder-value', - * // The maximum number of Findings to return, can be limited by server. - * // If not specified or not positive, the implementation will select a - * // reasonable value. + * // The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * pageSize: 'placeholder-value', - * // A token identifying a page of results to be returned. This should be a - * // `next_page_token` value returned from a previous List request. - * // If unspecified, the first page of results is returned. + * // A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * pageToken: 'placeholder-value', - * // Required. The parent resource name, which should be a scan run resource name in the - * // format - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * // Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * parent: * 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun', * } @@ -2496,7 +2457,7 @@ export namespace websecurityscanner_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. + * @param {string=} params.filter The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. * @param {integer=} params.pageSize The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * @param {string=} params.pageToken A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * @param {string} params.parent Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. @@ -2600,7 +2561,7 @@ export namespace websecurityscanner_v1 { export interface Params$Resource$Projects$Scanconfigs$Scanruns$Findings$List extends StandardParameters { /** - * The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. + * The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. */ filter?: string; /** @@ -2651,9 +2612,7 @@ export namespace websecurityscanner_v1 { * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list( * { - * // Required. The parent resource name, which should be a scan run resource name in the - * // format - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * // Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * parent: * 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun', * } diff --git a/src/apis/websecurityscanner/v1alpha.ts b/src/apis/websecurityscanner/v1alpha.ts index e75c0c8566..797e2b082f 100644 --- a/src/apis/websecurityscanner/v1alpha.ts +++ b/src/apis/websecurityscanner/v1alpha.ts @@ -175,7 +175,7 @@ export namespace websecurityscanner_v1alpha { username?: 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 {} /** @@ -560,8 +560,7 @@ export namespace websecurityscanner_v1alpha { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.create({ - * // Required. The parent resource name where the scan is created, which should be a - * // project resource name in the format 'projects/{projectId}'. + * // Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'. * parent: 'projects/my-project', * * // Request body metadata @@ -720,8 +719,7 @@ export namespace websecurityscanner_v1alpha { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.delete({ - * // Required. The resource name of the ScanConfig to be deleted. The name follows the - * // format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * // Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. * name: 'projects/my-project/scanConfigs/my-scanConfig', * }); * console.log(res.data); @@ -848,8 +846,7 @@ export namespace websecurityscanner_v1alpha { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.get({ - * // Required. The resource name of the ScanConfig to be returned. The name follows the - * // format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * // Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. * name: 'projects/my-project/scanConfigs/my-scanConfig', * }); * console.log(res.data); @@ -987,16 +984,11 @@ export namespace websecurityscanner_v1alpha { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.list({ - * // The maximum number of ScanConfigs to return, can be limited by server. - * // If not specified or not positive, the implementation will select a - * // reasonable value. + * // The maximum number of ScanConfigs to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * pageSize: 'placeholder-value', - * // A token identifying a page of results to be returned. This should be a - * // `next_page_token` value returned from a previous List request. - * // If unspecified, the first page of results is returned. + * // A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * pageToken: 'placeholder-value', - * // Required. The parent resource name, which should be a project resource name in the - * // format 'projects/{projectId}'. + * // Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. * parent: 'projects/my-project', * }); * console.log(res.data); @@ -1136,13 +1128,9 @@ export namespace websecurityscanner_v1alpha { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.patch({ - * // The resource name of the ScanConfig. The name follows the format of - * // 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are - * // generated by the system. + * // The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. * name: 'projects/my-project/scanConfigs/my-scanConfig', - * // Required. The update mask applies to the resource. For the `FieldMask` definition, - * // see - * // https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * // Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask * updateMask: 'placeholder-value', * * // Request body metadata @@ -1299,8 +1287,7 @@ export namespace websecurityscanner_v1alpha { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.start({ - * // Required. The resource name of the ScanConfig to be used. The name follows the - * // format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * // Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. * name: 'projects/my-project/scanConfigs/my-scanConfig', * * // Request body metadata @@ -1536,9 +1523,7 @@ export namespace websecurityscanner_v1alpha { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.get({ - * // Required. The resource name of the ScanRun to be returned. The name follows the - * // format of - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * // Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * name: 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun', * }); * console.log(res.data); @@ -1675,16 +1660,11 @@ export namespace websecurityscanner_v1alpha { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.list({ - * // The maximum number of ScanRuns to return, can be limited by server. - * // If not specified or not positive, the implementation will select a - * // reasonable value. + * // The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * pageSize: 'placeholder-value', - * // A token identifying a page of results to be returned. This should be a - * // `next_page_token` value returned from a previous List request. - * // If unspecified, the first page of results is returned. + * // A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * pageToken: 'placeholder-value', - * // Required. The parent resource name, which should be a scan resource name in the - * // format 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * // Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. * parent: 'projects/my-project/scanConfigs/my-scanConfig', * }); * console.log(res.data); @@ -1824,9 +1804,7 @@ export namespace websecurityscanner_v1alpha { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.stop({ - * // Required. The resource name of the ScanRun to be stopped. The name follows the - * // format of - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * // Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * name: 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun', * * // Request body metadata @@ -2016,17 +1994,11 @@ export namespace websecurityscanner_v1alpha { * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.crawledUrls.list( * { - * // The maximum number of CrawledUrls to return, can be limited by server. - * // If not specified or not positive, the implementation will select a - * // reasonable value. + * // The maximum number of CrawledUrls to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * pageSize: 'placeholder-value', - * // A token identifying a page of results to be returned. This should be a - * // `next_page_token` value returned from a previous List request. - * // If unspecified, the first page of results is returned. + * // A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * pageToken: 'placeholder-value', - * // Required. The parent resource name, which should be a scan run resource name in the - * // format - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * // Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * parent: * 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun', * } @@ -2192,9 +2164,7 @@ export namespace websecurityscanner_v1alpha { * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.findings.get( * { - * // Required. The resource name of the Finding to be returned. The name follows the - * // format of - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. + * // Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. * name: * 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun/findings/my-finding', * } @@ -2340,22 +2310,13 @@ export namespace websecurityscanner_v1alpha { * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.findings.list( * { - * // Required. The filter expression. The expression must be in the format: - * // . - * // Supported field: 'finding_type'. - * // Supported operator: '='. + * // Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. * filter: 'placeholder-value', - * // The maximum number of Findings to return, can be limited by server. - * // If not specified or not positive, the implementation will select a - * // reasonable value. + * // The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * pageSize: 'placeholder-value', - * // A token identifying a page of results to be returned. This should be a - * // `next_page_token` value returned from a previous List request. - * // If unspecified, the first page of results is returned. + * // A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * pageToken: 'placeholder-value', - * // Required. The parent resource name, which should be a scan run resource name in the - * // format - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * // Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * parent: * 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun', * } @@ -2378,7 +2339,7 @@ export namespace websecurityscanner_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. + * @param {string=} params.filter Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. * @param {integer=} params.pageSize The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * @param {string=} params.pageToken A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * @param {string} params.parent Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. @@ -2482,7 +2443,7 @@ export namespace websecurityscanner_v1alpha { export interface Params$Resource$Projects$Scanconfigs$Scanruns$Findings$List extends StandardParameters { /** - * Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. + * Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. */ filter?: string; /** @@ -2533,9 +2494,7 @@ export namespace websecurityscanner_v1alpha { * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list( * { - * // Required. The parent resource name, which should be a scan run resource name in the - * // format - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * // Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * parent: * 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun', * } diff --git a/src/apis/websecurityscanner/v1beta.ts b/src/apis/websecurityscanner/v1beta.ts index 5c454d25e0..6996dec6a3 100644 --- a/src/apis/websecurityscanner/v1beta.ts +++ b/src/apis/websecurityscanner/v1beta.ts @@ -179,7 +179,7 @@ export namespace websecurityscanner_v1beta { username?: 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 {} /** @@ -666,8 +666,7 @@ export namespace websecurityscanner_v1beta { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.create({ - * // Required. The parent resource name where the scan is created, which should be a - * // project resource name in the format 'projects/{projectId}'. + * // Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'. * parent: 'projects/my-project', * * // Request body metadata @@ -834,8 +833,7 @@ export namespace websecurityscanner_v1beta { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.delete({ - * // Required. The resource name of the ScanConfig to be deleted. The name follows the - * // format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * // Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. * name: 'projects/my-project/scanConfigs/my-scanConfig', * }); * console.log(res.data); @@ -962,8 +960,7 @@ export namespace websecurityscanner_v1beta { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.get({ - * // Required. The resource name of the ScanConfig to be returned. The name follows the - * // format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * // Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. * name: 'projects/my-project/scanConfigs/my-scanConfig', * }); * console.log(res.data); @@ -1105,16 +1102,11 @@ export namespace websecurityscanner_v1beta { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.list({ - * // The maximum number of ScanConfigs to return, can be limited by server. - * // If not specified or not positive, the implementation will select a - * // reasonable value. + * // The maximum number of ScanConfigs to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * pageSize: 'placeholder-value', - * // A token identifying a page of results to be returned. This should be a - * // `next_page_token` value returned from a previous List request. - * // If unspecified, the first page of results is returned. + * // A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * pageToken: 'placeholder-value', - * // Required. The parent resource name, which should be a project resource name in the - * // format 'projects/{projectId}'. + * // Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. * parent: 'projects/my-project', * }); * console.log(res.data); @@ -1254,13 +1246,9 @@ export namespace websecurityscanner_v1beta { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.patch({ - * // The resource name of the ScanConfig. The name follows the format of - * // 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are - * // generated by the system. + * // The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. * name: 'projects/my-project/scanConfigs/my-scanConfig', - * // Required. The update mask applies to the resource. For the `FieldMask` definition, - * // see - * // https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * // Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask * updateMask: 'placeholder-value', * * // Request body metadata @@ -1425,8 +1413,7 @@ export namespace websecurityscanner_v1beta { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.start({ - * // Required. The resource name of the ScanConfig to be used. The name follows the - * // format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * // Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. * name: 'projects/my-project/scanConfigs/my-scanConfig', * * // Request body metadata @@ -1664,9 +1651,7 @@ export namespace websecurityscanner_v1beta { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.get({ - * // Required. The resource name of the ScanRun to be returned. The name follows the - * // format of - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * // Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * name: 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun', * }); * console.log(res.data); @@ -1805,16 +1790,11 @@ export namespace websecurityscanner_v1beta { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.list({ - * // The maximum number of ScanRuns to return, can be limited by server. - * // If not specified or not positive, the implementation will select a - * // reasonable value. + * // The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * pageSize: 'placeholder-value', - * // A token identifying a page of results to be returned. This should be a - * // `next_page_token` value returned from a previous List request. - * // If unspecified, the first page of results is returned. + * // A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * pageToken: 'placeholder-value', - * // Required. The parent resource name, which should be a scan resource name in the - * // format 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * // Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. * parent: 'projects/my-project/scanConfigs/my-scanConfig', * }); * console.log(res.data); @@ -1954,9 +1934,7 @@ export namespace websecurityscanner_v1beta { * * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.stop({ - * // Required. The resource name of the ScanRun to be stopped. The name follows the - * // format of - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * // Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * name: 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun', * * // Request body metadata @@ -2148,17 +2126,11 @@ export namespace websecurityscanner_v1beta { * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.crawledUrls.list( * { - * // The maximum number of CrawledUrls to return, can be limited by server. - * // If not specified or not positive, the implementation will select a - * // reasonable value. + * // The maximum number of CrawledUrls to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * pageSize: 'placeholder-value', - * // A token identifying a page of results to be returned. This should be a - * // `next_page_token` value returned from a previous List request. - * // If unspecified, the first page of results is returned. + * // A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * pageToken: 'placeholder-value', - * // Required. The parent resource name, which should be a scan run resource name in the - * // format - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * // Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * parent: * 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun', * } @@ -2324,9 +2296,7 @@ export namespace websecurityscanner_v1beta { * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.findings.get( * { - * // Required. The resource name of the Finding to be returned. The name follows the - * // format of - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. + * // Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. * name: * 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun/findings/my-finding', * } @@ -2474,22 +2444,13 @@ export namespace websecurityscanner_v1beta { * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.findings.list( * { - * // Required. The filter expression. The expression must be in the format: - * // . - * // Supported field: 'finding_type'. - * // Supported operator: '='. + * // Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. * filter: 'placeholder-value', - * // The maximum number of Findings to return, can be limited by server. - * // If not specified or not positive, the implementation will select a - * // reasonable value. + * // The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * pageSize: 'placeholder-value', - * // A token identifying a page of results to be returned. This should be a - * // `next_page_token` value returned from a previous List request. - * // If unspecified, the first page of results is returned. + * // A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * pageToken: 'placeholder-value', - * // Required. The parent resource name, which should be a scan run resource name in the - * // format - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * // Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * parent: * 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun', * } @@ -2512,7 +2473,7 @@ export namespace websecurityscanner_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. + * @param {string=} params.filter Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. * @param {integer=} params.pageSize The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * @param {string=} params.pageToken A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * @param {string} params.parent Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. @@ -2616,7 +2577,7 @@ export namespace websecurityscanner_v1beta { export interface Params$Resource$Projects$Scanconfigs$Scanruns$Findings$List extends StandardParameters { /** - * Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. + * Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. */ filter?: string; /** @@ -2667,9 +2628,7 @@ export namespace websecurityscanner_v1beta { * // Do the magic * const res = await websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list( * { - * // Required. The parent resource name, which should be a scan run resource name in the - * // format - * // 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * // Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * parent: * 'projects/my-project/scanConfigs/my-scanConfig/scanRuns/my-scanRun', * }