From 6c3059dd28bf1ed931cf4d845a413721f811c42c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:13 +0000 Subject: [PATCH 01/31] feat(aiplatform): update the API #### aiplatform:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.reasoningEngines.resources.sessions.resources.events.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.reasoningEngines.resources.sessions.resources.events.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.reasoningEngines.resources.sessions.resources.events.methods.list.parameters.orderBy.type - resources.reasoningEngines.resources.sandboxEnvironments.methods.create.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.create.flatPath - resources.reasoningEngines.resources.sandboxEnvironments.methods.create.httpMethod - resources.reasoningEngines.resources.sandboxEnvironments.methods.create.id - resources.reasoningEngines.resources.sandboxEnvironments.methods.create.parameterOrder - resources.reasoningEngines.resources.sandboxEnvironments.methods.create.parameters.parent.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.create.parameters.parent.location - resources.reasoningEngines.resources.sandboxEnvironments.methods.create.parameters.parent.pattern - resources.reasoningEngines.resources.sandboxEnvironments.methods.create.parameters.parent.required - resources.reasoningEngines.resources.sandboxEnvironments.methods.create.parameters.parent.type - resources.reasoningEngines.resources.sandboxEnvironments.methods.create.path - resources.reasoningEngines.resources.sandboxEnvironments.methods.create.request.$ref - resources.reasoningEngines.resources.sandboxEnvironments.methods.create.response.$ref - resources.reasoningEngines.resources.sandboxEnvironments.methods.create.scopes - resources.reasoningEngines.resources.sandboxEnvironments.methods.delete.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.delete.flatPath - resources.reasoningEngines.resources.sandboxEnvironments.methods.delete.httpMethod - resources.reasoningEngines.resources.sandboxEnvironments.methods.delete.id - resources.reasoningEngines.resources.sandboxEnvironments.methods.delete.parameterOrder - resources.reasoningEngines.resources.sandboxEnvironments.methods.delete.parameters.name.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.delete.parameters.name.location - resources.reasoningEngines.resources.sandboxEnvironments.methods.delete.parameters.name.pattern - resources.reasoningEngines.resources.sandboxEnvironments.methods.delete.parameters.name.required - resources.reasoningEngines.resources.sandboxEnvironments.methods.delete.parameters.name.type - resources.reasoningEngines.resources.sandboxEnvironments.methods.delete.path - resources.reasoningEngines.resources.sandboxEnvironments.methods.delete.response.$ref - resources.reasoningEngines.resources.sandboxEnvironments.methods.delete.scopes - resources.reasoningEngines.resources.sandboxEnvironments.methods.execute.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.execute.flatPath - resources.reasoningEngines.resources.sandboxEnvironments.methods.execute.httpMethod - resources.reasoningEngines.resources.sandboxEnvironments.methods.execute.id - resources.reasoningEngines.resources.sandboxEnvironments.methods.execute.parameterOrder - resources.reasoningEngines.resources.sandboxEnvironments.methods.execute.parameters.name.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.execute.parameters.name.location - resources.reasoningEngines.resources.sandboxEnvironments.methods.execute.parameters.name.pattern - resources.reasoningEngines.resources.sandboxEnvironments.methods.execute.parameters.name.required - resources.reasoningEngines.resources.sandboxEnvironments.methods.execute.parameters.name.type - resources.reasoningEngines.resources.sandboxEnvironments.methods.execute.path - resources.reasoningEngines.resources.sandboxEnvironments.methods.execute.request.$ref - resources.reasoningEngines.resources.sandboxEnvironments.methods.execute.response.$ref - resources.reasoningEngines.resources.sandboxEnvironments.methods.execute.scopes - resources.reasoningEngines.resources.sandboxEnvironments.methods.get.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.get.flatPath - resources.reasoningEngines.resources.sandboxEnvironments.methods.get.httpMethod - resources.reasoningEngines.resources.sandboxEnvironments.methods.get.id - resources.reasoningEngines.resources.sandboxEnvironments.methods.get.parameterOrder - resources.reasoningEngines.resources.sandboxEnvironments.methods.get.parameters.name.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.get.parameters.name.location - resources.reasoningEngines.resources.sandboxEnvironments.methods.get.parameters.name.pattern - resources.reasoningEngines.resources.sandboxEnvironments.methods.get.parameters.name.required - resources.reasoningEngines.resources.sandboxEnvironments.methods.get.parameters.name.type - resources.reasoningEngines.resources.sandboxEnvironments.methods.get.path - resources.reasoningEngines.resources.sandboxEnvironments.methods.get.response.$ref - resources.reasoningEngines.resources.sandboxEnvironments.methods.get.scopes - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.flatPath - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.httpMethod - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.id - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.parameterOrder - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.parameters.filter.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.parameters.filter.location - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.parameters.filter.type - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.parameters.pageSize.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.parameters.pageSize.format - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.parameters.pageSize.location - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.parameters.pageSize.type - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.parameters.pageToken.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.parameters.pageToken.location - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.parameters.pageToken.type - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.parameters.parent.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.parameters.parent.location - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.parameters.parent.pattern - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.parameters.parent.required - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.parameters.parent.type - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.path - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.response.$ref - resources.reasoningEngines.resources.sandboxEnvironments.methods.list.scopes - resources.reasoningEngines.resources.sessions.resources.events.methods.list.parameters.orderBy.description - resources.reasoningEngines.resources.sessions.resources.events.methods.list.parameters.orderBy.location - resources.reasoningEngines.resources.sessions.resources.events.methods.list.parameters.orderBy.type - schemas.GoogleCloudAiplatformV1beta1AggregationResult.properties.customCodeExecutionResult.$ref - schemas.GoogleCloudAiplatformV1beta1AggregationResult.properties.customCodeExecutionResult.description - schemas.GoogleCloudAiplatformV1beta1CustomCodeExecutionResult.description - schemas.GoogleCloudAiplatformV1beta1CustomCodeExecutionResult.id - schemas.GoogleCloudAiplatformV1beta1CustomCodeExecutionResult.properties.score.description - schemas.GoogleCloudAiplatformV1beta1CustomCodeExecutionResult.properties.score.format - schemas.GoogleCloudAiplatformV1beta1CustomCodeExecutionResult.properties.score.readOnly - schemas.GoogleCloudAiplatformV1beta1CustomCodeExecutionResult.properties.score.type - schemas.GoogleCloudAiplatformV1beta1CustomCodeExecutionResult.type - schemas.GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec.description - schemas.GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec.id - schemas.GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec.properties.evaluationFunction.description - schemas.GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec.properties.evaluationFunction.type - schemas.GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec.type - schemas.GoogleCloudAiplatformV1beta1Memory.properties.revisionLabels.additionalProperties.type - schemas.GoogleCloudAiplatformV1beta1Memory.properties.revisionLabels.description - schemas.GoogleCloudAiplatformV1beta1Memory.properties.revisionLabels.type - schemas.GoogleCloudAiplatformV1beta1Metric.properties.customCodeExecutionSpec.$ref - schemas.GoogleCloudAiplatformV1beta1Metric.properties.customCodeExecutionSpec.description - schemas.GoogleCloudAiplatformV1beta1RagCorpus.properties.satisfiesPzi.description - schemas.GoogleCloudAiplatformV1beta1RagCorpus.properties.satisfiesPzi.readOnly - schemas.GoogleCloudAiplatformV1beta1RagCorpus.properties.satisfiesPzi.type - schemas.GoogleCloudAiplatformV1beta1RagCorpus.properties.satisfiesPzs.description - schemas.GoogleCloudAiplatformV1beta1RagCorpus.properties.satisfiesPzs.readOnly - schemas.GoogleCloudAiplatformV1beta1RagCorpus.properties.satisfiesPzs.type - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpec.properties.agentCard.additionalProperties.description - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpec.properties.agentCard.additionalProperties.type - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpec.properties.agentCard.description - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpec.properties.agentCard.type The following keys were changed: - endpoints - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description - schemas.GoogleCloudAiplatformV1beta1Blob.description - schemas.GoogleCloudAiplatformV1beta1Blob.properties.data.description - schemas.GoogleCloudAiplatformV1beta1Blob.properties.displayName.description - schemas.GoogleCloudAiplatformV1beta1Candidate.properties.avgLogprobs.description - schemas.GoogleCloudAiplatformV1beta1Candidate.properties.citationMetadata.description - schemas.GoogleCloudAiplatformV1beta1Candidate.properties.content.description - schemas.GoogleCloudAiplatformV1beta1Candidate.properties.finishMessage.description - schemas.GoogleCloudAiplatformV1beta1Candidate.properties.finishReason.description - schemas.GoogleCloudAiplatformV1beta1Candidate.properties.finishReason.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1Candidate.properties.groundingMetadata.description - schemas.GoogleCloudAiplatformV1beta1Candidate.properties.index.description - schemas.GoogleCloudAiplatformV1beta1Candidate.properties.logprobsResult.description - schemas.GoogleCloudAiplatformV1beta1Candidate.properties.safetyRatings.description - schemas.GoogleCloudAiplatformV1beta1Candidate.properties.urlContextMetadata.description - schemas.GoogleCloudAiplatformV1beta1Citation.description - schemas.GoogleCloudAiplatformV1beta1Citation.properties.endIndex.description - schemas.GoogleCloudAiplatformV1beta1Citation.properties.license.description - schemas.GoogleCloudAiplatformV1beta1Citation.properties.publicationDate.description - schemas.GoogleCloudAiplatformV1beta1Citation.properties.startIndex.description - schemas.GoogleCloudAiplatformV1beta1Citation.properties.title.description - schemas.GoogleCloudAiplatformV1beta1Citation.properties.uri.description - schemas.GoogleCloudAiplatformV1beta1CitationMetadata.description - schemas.GoogleCloudAiplatformV1beta1CitationMetadata.properties.citations.description - schemas.GoogleCloudAiplatformV1beta1Content.description - schemas.GoogleCloudAiplatformV1beta1Content.properties.parts.description - schemas.GoogleCloudAiplatformV1beta1Content.properties.role.description - schemas.GoogleCloudAiplatformV1beta1FileData.description - schemas.GoogleCloudAiplatformV1beta1FileData.properties.displayName.description - schemas.GoogleCloudAiplatformV1beta1FileData.properties.fileUri.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.audioTimestamp.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.candidateCount.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.enableAffectiveDialog.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.frequencyPenalty.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.logprobs.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.maxOutputTokens.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.mediaResolution.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.presencePenalty.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.responseJsonSchema.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.responseLogprobs.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.responseMimeType.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.responseModalities.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.responseSchema.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.seed.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.stopSequences.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.temperature.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.thinkingConfig.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.topK.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.topP.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig.properties.autoMode.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig.properties.manualMode.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode.properties.modelRoutingPreference.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode.properties.modelName.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig.properties.includeThoughts.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig.properties.thinkingBudget.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunk.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunk.properties.maps.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunk.properties.retrievedContext.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunk.properties.web.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMaps.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMaps.properties.placeAnswerSources.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMaps.properties.placeId.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMaps.properties.text.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMaps.properties.title.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMaps.properties.uri.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources.properties.reviewSnippets.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.properties.reviewId.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.properties.title.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext.properties.documentName.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext.properties.ragChunk.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext.properties.text.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext.properties.title.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext.properties.uri.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkWeb.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkWeb.properties.domain.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkWeb.properties.title.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkWeb.properties.uri.description - schemas.GoogleCloudAiplatformV1beta1GroundingMetadata.description - schemas.GoogleCloudAiplatformV1beta1GroundingMetadata.properties.googleMapsWidgetContextToken.description - schemas.GoogleCloudAiplatformV1beta1GroundingMetadata.properties.groundingChunks.description - schemas.GoogleCloudAiplatformV1beta1GroundingMetadata.properties.groundingSupports.description - schemas.GoogleCloudAiplatformV1beta1GroundingMetadata.properties.retrievalMetadata.description - schemas.GoogleCloudAiplatformV1beta1GroundingMetadata.properties.retrievalQueries.description - schemas.GoogleCloudAiplatformV1beta1GroundingMetadata.properties.searchEntryPoint.description - schemas.GoogleCloudAiplatformV1beta1GroundingMetadata.properties.sourceFlaggingUris.description - schemas.GoogleCloudAiplatformV1beta1GroundingMetadata.properties.webSearchQueries.description - schemas.GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri.description - schemas.GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri.properties.flagContentUri.description - schemas.GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri.properties.sourceId.description - schemas.GoogleCloudAiplatformV1beta1GroundingSupport.description - schemas.GoogleCloudAiplatformV1beta1GroundingSupport.properties.confidenceScores.description - schemas.GoogleCloudAiplatformV1beta1GroundingSupport.properties.groundingChunkIndices.description - schemas.GoogleCloudAiplatformV1beta1GroundingSupport.properties.segment.description - schemas.GoogleCloudAiplatformV1beta1ImageConfig.description - schemas.GoogleCloudAiplatformV1beta1ImageConfig.properties.personGeneration.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1LogprobsResult.description - schemas.GoogleCloudAiplatformV1beta1LogprobsResult.properties.chosenCandidates.description - schemas.GoogleCloudAiplatformV1beta1LogprobsResult.properties.topCandidates.description - schemas.GoogleCloudAiplatformV1beta1LogprobsResultCandidate.description - schemas.GoogleCloudAiplatformV1beta1LogprobsResultCandidate.properties.logProbability.description - schemas.GoogleCloudAiplatformV1beta1LogprobsResultCandidate.properties.token.description - schemas.GoogleCloudAiplatformV1beta1LogprobsResultCandidate.properties.tokenId.description - schemas.GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates.description - schemas.GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates.properties.candidates.description - schemas.GoogleCloudAiplatformV1beta1ModalityTokenCount.description - schemas.GoogleCloudAiplatformV1beta1ModalityTokenCount.properties.modality.description - schemas.GoogleCloudAiplatformV1beta1ModalityTokenCount.properties.modality.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1ModalityTokenCount.properties.tokenCount.description - schemas.GoogleCloudAiplatformV1beta1ModelArmorConfig.description - schemas.GoogleCloudAiplatformV1beta1ModelArmorConfig.properties.promptTemplateName.description - schemas.GoogleCloudAiplatformV1beta1ModelArmorConfig.properties.responseTemplateName.description - schemas.GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig.description - schemas.GoogleCloudAiplatformV1beta1Part.description - schemas.GoogleCloudAiplatformV1beta1Part.properties.codeExecutionResult.description - schemas.GoogleCloudAiplatformV1beta1Part.properties.executableCode.description - schemas.GoogleCloudAiplatformV1beta1Part.properties.fileData.description - schemas.GoogleCloudAiplatformV1beta1Part.properties.functionCall.description - schemas.GoogleCloudAiplatformV1beta1Part.properties.functionResponse.description - schemas.GoogleCloudAiplatformV1beta1Part.properties.inlineData.description - schemas.GoogleCloudAiplatformV1beta1Part.properties.text.description - schemas.GoogleCloudAiplatformV1beta1Part.properties.thought.description - schemas.GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig.description - schemas.GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig.properties.voiceName.description - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec.properties.pythonVersion.description - schemas.GoogleCloudAiplatformV1beta1RetrievalMetadata.description - schemas.GoogleCloudAiplatformV1beta1RetrievalMetadata.properties.googleSearchDynamicRetrievalScore.description - schemas.GoogleCloudAiplatformV1beta1SafetyRating.description - schemas.GoogleCloudAiplatformV1beta1SafetyRating.properties.blocked.description - schemas.GoogleCloudAiplatformV1beta1SafetyRating.properties.category.description - schemas.GoogleCloudAiplatformV1beta1SafetyRating.properties.category.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1SafetyRating.properties.overwrittenThreshold.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1SafetyRating.properties.probability.description - schemas.GoogleCloudAiplatformV1beta1SafetyRating.properties.probability.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1SafetyRating.properties.probabilityScore.description - schemas.GoogleCloudAiplatformV1beta1SafetyRating.properties.severity.description - schemas.GoogleCloudAiplatformV1beta1SafetyRating.properties.severity.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1SafetyRating.properties.severityScore.description - schemas.GoogleCloudAiplatformV1beta1SafetySetting.description - schemas.GoogleCloudAiplatformV1beta1SafetySetting.properties.category.description - schemas.GoogleCloudAiplatformV1beta1SafetySetting.properties.category.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1SafetySetting.properties.method.description - schemas.GoogleCloudAiplatformV1beta1SafetySetting.properties.threshold.description - schemas.GoogleCloudAiplatformV1beta1SafetySetting.properties.threshold.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1SearchEntryPoint.description - schemas.GoogleCloudAiplatformV1beta1SearchEntryPoint.properties.renderedContent.description - schemas.GoogleCloudAiplatformV1beta1SearchEntryPoint.properties.sdkBlob.description - schemas.GoogleCloudAiplatformV1beta1Segment.description - schemas.GoogleCloudAiplatformV1beta1Segment.properties.endIndex.description - schemas.GoogleCloudAiplatformV1beta1Segment.properties.partIndex.description - schemas.GoogleCloudAiplatformV1beta1Segment.properties.startIndex.description - schemas.GoogleCloudAiplatformV1beta1Segment.properties.text.description - schemas.GoogleCloudAiplatformV1beta1SpeakerVoiceConfig.description - schemas.GoogleCloudAiplatformV1beta1SpeechConfig.description - schemas.GoogleCloudAiplatformV1beta1SpeechConfig.properties.languageCode.description - schemas.GoogleCloudAiplatformV1beta1SpeechConfig.properties.voiceConfig.description - schemas.GoogleCloudAiplatformV1beta1UrlContextMetadata.description - schemas.GoogleCloudAiplatformV1beta1UrlContextMetadata.properties.urlMetadata.description - schemas.GoogleCloudAiplatformV1beta1UrlMetadata.description - schemas.GoogleCloudAiplatformV1beta1UrlMetadata.properties.retrievedUrl.description - schemas.GoogleCloudAiplatformV1beta1UrlMetadata.properties.urlRetrievalStatus.description - schemas.GoogleCloudAiplatformV1beta1UrlMetadata.properties.urlRetrievalStatus.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1VideoMetadata.description - schemas.GoogleCloudAiplatformV1beta1VideoMetadata.properties.fps.description - schemas.GoogleCloudAiplatformV1beta1VoiceConfig.description - schemas.GoogleCloudAiplatformV1beta1VoiceConfig.properties.prebuiltVoiceConfig.description #### aiplatform:v1 The following keys were added: - schemas.GoogleCloudAiplatformV1CustomCodeExecutionSpec.description - schemas.GoogleCloudAiplatformV1CustomCodeExecutionSpec.id - schemas.GoogleCloudAiplatformV1CustomCodeExecutionSpec.properties.evaluationFunction.description - schemas.GoogleCloudAiplatformV1CustomCodeExecutionSpec.properties.evaluationFunction.type - schemas.GoogleCloudAiplatformV1CustomCodeExecutionSpec.type - schemas.GoogleCloudAiplatformV1DatasetDistribution.description - schemas.GoogleCloudAiplatformV1DatasetDistribution.id - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.buckets.description - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.buckets.items.$ref - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.buckets.readOnly - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.buckets.type - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.max.description - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.max.format - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.max.readOnly - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.max.type - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.mean.description - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.mean.format - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.mean.readOnly - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.mean.type - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.median.description - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.median.format - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.median.readOnly - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.median.type - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.min.description - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.min.format - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.min.readOnly - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.min.type - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.p5.description - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.p5.format - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.p5.readOnly - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.p5.type - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.p95.description - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.p95.format - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.p95.readOnly - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.p95.type - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.sum.description - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.sum.format - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.sum.readOnly - schemas.GoogleCloudAiplatformV1DatasetDistribution.properties.sum.type - schemas.GoogleCloudAiplatformV1DatasetDistribution.type - schemas.GoogleCloudAiplatformV1DatasetDistributionDistributionBucket.description - schemas.GoogleCloudAiplatformV1DatasetDistributionDistributionBucket.id - schemas.GoogleCloudAiplatformV1DatasetDistributionDistributionBucket.properties.count.description - schemas.GoogleCloudAiplatformV1DatasetDistributionDistributionBucket.properties.count.format - schemas.GoogleCloudAiplatformV1DatasetDistributionDistributionBucket.properties.count.readOnly - schemas.GoogleCloudAiplatformV1DatasetDistributionDistributionBucket.properties.count.type - schemas.GoogleCloudAiplatformV1DatasetDistributionDistributionBucket.properties.left.description - schemas.GoogleCloudAiplatformV1DatasetDistributionDistributionBucket.properties.left.format - schemas.GoogleCloudAiplatformV1DatasetDistributionDistributionBucket.properties.left.readOnly - schemas.GoogleCloudAiplatformV1DatasetDistributionDistributionBucket.properties.left.type - schemas.GoogleCloudAiplatformV1DatasetDistributionDistributionBucket.properties.right.description - schemas.GoogleCloudAiplatformV1DatasetDistributionDistributionBucket.properties.right.format - schemas.GoogleCloudAiplatformV1DatasetDistributionDistributionBucket.properties.right.readOnly - schemas.GoogleCloudAiplatformV1DatasetDistributionDistributionBucket.properties.right.type - schemas.GoogleCloudAiplatformV1DatasetDistributionDistributionBucket.type - schemas.GoogleCloudAiplatformV1GeminiPreferenceExample.description - schemas.GoogleCloudAiplatformV1GeminiPreferenceExample.id - schemas.GoogleCloudAiplatformV1GeminiPreferenceExample.properties.completions.description - schemas.GoogleCloudAiplatformV1GeminiPreferenceExample.properties.completions.items.$ref - schemas.GoogleCloudAiplatformV1GeminiPreferenceExample.properties.completions.type - schemas.GoogleCloudAiplatformV1GeminiPreferenceExample.properties.contents.description - schemas.GoogleCloudAiplatformV1GeminiPreferenceExample.properties.contents.items.$ref - schemas.GoogleCloudAiplatformV1GeminiPreferenceExample.properties.contents.type - schemas.GoogleCloudAiplatformV1GeminiPreferenceExample.type - schemas.GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion.description - schemas.GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion.id - schemas.GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion.properties.completion.$ref - schemas.GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion.properties.completion.description - schemas.GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion.properties.score.description - schemas.GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion.properties.score.format - schemas.GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion.properties.score.type - schemas.GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion.type - schemas.GoogleCloudAiplatformV1Metric.properties.customCodeExecutionSpec.$ref - schemas.GoogleCloudAiplatformV1Metric.properties.customCodeExecutionSpec.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.id - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.droppedExampleIndices.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.droppedExampleIndices.items.format - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.droppedExampleIndices.items.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.droppedExampleIndices.readOnly - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.droppedExampleIndices.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.droppedExampleReasons.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.droppedExampleReasons.items.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.droppedExampleReasons.readOnly - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.droppedExampleReasons.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.scoreVariancePerExampleDistribution.$ref - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.scoreVariancePerExampleDistribution.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.scoreVariancePerExampleDistribution.readOnly - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.scoresDistribution.$ref - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.scoresDistribution.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.scoresDistribution.readOnly - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.totalBillableTokenCount.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.totalBillableTokenCount.format - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.totalBillableTokenCount.readOnly - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.totalBillableTokenCount.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.tuningDatasetExampleCount.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.tuningDatasetExampleCount.format - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.tuningDatasetExampleCount.readOnly - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.tuningDatasetExampleCount.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.tuningStepCount.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.tuningStepCount.format - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.tuningStepCount.readOnly - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.tuningStepCount.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.userDatasetExamples.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.userDatasetExamples.items.$ref - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.userDatasetExamples.readOnly - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.userDatasetExamples.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.userInputTokenDistribution.$ref - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.userInputTokenDistribution.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.userInputTokenDistribution.readOnly - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.userOutputTokenDistribution.$ref - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.userOutputTokenDistribution.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.properties.userOutputTokenDistribution.readOnly - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters.id - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters.properties.adapterSize.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters.properties.adapterSize.enum - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters.properties.adapterSize.enumDescriptions - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters.properties.adapterSize.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters.properties.beta.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters.properties.beta.format - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters.properties.beta.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters.properties.epochCount.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters.properties.epochCount.format - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters.properties.epochCount.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters.properties.learningRateMultiplier.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters.properties.learningRateMultiplier.format - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters.properties.learningRateMultiplier.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationSpec.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationSpec.id - schemas.GoogleCloudAiplatformV1PreferenceOptimizationSpec.properties.exportLastCheckpointOnly.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationSpec.properties.exportLastCheckpointOnly.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationSpec.properties.hyperParameters.$ref - schemas.GoogleCloudAiplatformV1PreferenceOptimizationSpec.properties.hyperParameters.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationSpec.properties.trainingDatasetUri.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationSpec.properties.trainingDatasetUri.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationSpec.properties.validationDatasetUri.description - schemas.GoogleCloudAiplatformV1PreferenceOptimizationSpec.properties.validationDatasetUri.type - schemas.GoogleCloudAiplatformV1PreferenceOptimizationSpec.type - schemas.GoogleCloudAiplatformV1RagCorpus.properties.satisfiesPzi.description - schemas.GoogleCloudAiplatformV1RagCorpus.properties.satisfiesPzi.readOnly - schemas.GoogleCloudAiplatformV1RagCorpus.properties.satisfiesPzi.type - schemas.GoogleCloudAiplatformV1RagCorpus.properties.satisfiesPzs.description - schemas.GoogleCloudAiplatformV1RagCorpus.properties.satisfiesPzs.readOnly - schemas.GoogleCloudAiplatformV1RagCorpus.properties.satisfiesPzs.type - schemas.GoogleCloudAiplatformV1TuningDataStats.properties.preferenceOptimizationDataStats.$ref - schemas.GoogleCloudAiplatformV1TuningDataStats.properties.preferenceOptimizationDataStats.description - schemas.GoogleCloudAiplatformV1TuningDataStats.properties.preferenceOptimizationDataStats.readOnly - schemas.GoogleCloudAiplatformV1TuningJob.properties.preferenceOptimizationSpec.$ref - schemas.GoogleCloudAiplatformV1TuningJob.properties.preferenceOptimizationSpec.description The following keys were changed: - endpoints - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description - schemas.GoogleCloudAiplatformV1Blob.description - schemas.GoogleCloudAiplatformV1Blob.properties.data.description - schemas.GoogleCloudAiplatformV1Blob.properties.displayName.description - schemas.GoogleCloudAiplatformV1Candidate.properties.avgLogprobs.description - schemas.GoogleCloudAiplatformV1Candidate.properties.citationMetadata.description - schemas.GoogleCloudAiplatformV1Candidate.properties.content.description - schemas.GoogleCloudAiplatformV1Candidate.properties.finishMessage.description - schemas.GoogleCloudAiplatformV1Candidate.properties.finishReason.description - schemas.GoogleCloudAiplatformV1Candidate.properties.finishReason.enumDescriptions - schemas.GoogleCloudAiplatformV1Candidate.properties.groundingMetadata.description - schemas.GoogleCloudAiplatformV1Candidate.properties.index.description - schemas.GoogleCloudAiplatformV1Candidate.properties.logprobsResult.description - schemas.GoogleCloudAiplatformV1Candidate.properties.safetyRatings.description - schemas.GoogleCloudAiplatformV1Candidate.properties.urlContextMetadata.description - schemas.GoogleCloudAiplatformV1Citation.description - schemas.GoogleCloudAiplatformV1Citation.properties.endIndex.description - schemas.GoogleCloudAiplatformV1Citation.properties.license.description - schemas.GoogleCloudAiplatformV1Citation.properties.publicationDate.description - schemas.GoogleCloudAiplatformV1Citation.properties.startIndex.description - schemas.GoogleCloudAiplatformV1Citation.properties.title.description - schemas.GoogleCloudAiplatformV1Citation.properties.uri.description - schemas.GoogleCloudAiplatformV1CitationMetadata.description - schemas.GoogleCloudAiplatformV1CitationMetadata.properties.citations.description - schemas.GoogleCloudAiplatformV1Content.description - schemas.GoogleCloudAiplatformV1Content.properties.parts.description - schemas.GoogleCloudAiplatformV1Content.properties.role.description - schemas.GoogleCloudAiplatformV1FileData.description - schemas.GoogleCloudAiplatformV1FileData.properties.displayName.description - schemas.GoogleCloudAiplatformV1FileData.properties.fileUri.description - schemas.GoogleCloudAiplatformV1GenerationConfig.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.audioTimestamp.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.candidateCount.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.enableAffectiveDialog.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.frequencyPenalty.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.logprobs.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.maxOutputTokens.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.mediaResolution.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.presencePenalty.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.responseJsonSchema.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.responseLogprobs.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.responseMimeType.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.responseModalities.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.responseSchema.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.seed.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.stopSequences.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.temperature.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.thinkingConfig.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.topK.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.topP.description - schemas.GoogleCloudAiplatformV1GenerationConfigRoutingConfig.description - schemas.GoogleCloudAiplatformV1GenerationConfigRoutingConfig.properties.autoMode.description - schemas.GoogleCloudAiplatformV1GenerationConfigRoutingConfig.properties.manualMode.description - schemas.GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode.description - schemas.GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode.properties.modelRoutingPreference.enumDescriptions - schemas.GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode.description - schemas.GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode.properties.modelName.description - schemas.GoogleCloudAiplatformV1GenerationConfigThinkingConfig.description - schemas.GoogleCloudAiplatformV1GenerationConfigThinkingConfig.properties.includeThoughts.description - schemas.GoogleCloudAiplatformV1GenerationConfigThinkingConfig.properties.thinkingBudget.description - schemas.GoogleCloudAiplatformV1GroundingChunk.description - schemas.GoogleCloudAiplatformV1GroundingChunk.properties.maps.description - schemas.GoogleCloudAiplatformV1GroundingChunk.properties.retrievedContext.description - schemas.GoogleCloudAiplatformV1GroundingChunk.properties.web.description - schemas.GoogleCloudAiplatformV1GroundingChunkMaps.description - schemas.GoogleCloudAiplatformV1GroundingChunkMaps.properties.placeAnswerSources.description - schemas.GoogleCloudAiplatformV1GroundingChunkMaps.properties.placeId.description - schemas.GoogleCloudAiplatformV1GroundingChunkMaps.properties.text.description - schemas.GoogleCloudAiplatformV1GroundingChunkMaps.properties.title.description - schemas.GoogleCloudAiplatformV1GroundingChunkMaps.properties.uri.description - schemas.GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources.description - schemas.GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources.properties.reviewSnippets.description - schemas.GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.description - schemas.GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.properties.reviewId.description - schemas.GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.properties.title.description - schemas.GoogleCloudAiplatformV1GroundingChunkRetrievedContext.description - schemas.GoogleCloudAiplatformV1GroundingChunkRetrievedContext.properties.documentName.description - schemas.GoogleCloudAiplatformV1GroundingChunkRetrievedContext.properties.ragChunk.description - schemas.GoogleCloudAiplatformV1GroundingChunkRetrievedContext.properties.text.description - schemas.GoogleCloudAiplatformV1GroundingChunkRetrievedContext.properties.title.description - schemas.GoogleCloudAiplatformV1GroundingChunkRetrievedContext.properties.uri.description - schemas.GoogleCloudAiplatformV1GroundingChunkWeb.description - schemas.GoogleCloudAiplatformV1GroundingChunkWeb.properties.domain.description - schemas.GoogleCloudAiplatformV1GroundingChunkWeb.properties.title.description - schemas.GoogleCloudAiplatformV1GroundingChunkWeb.properties.uri.description - schemas.GoogleCloudAiplatformV1GroundingMetadata.description - schemas.GoogleCloudAiplatformV1GroundingMetadata.properties.googleMapsWidgetContextToken.description - schemas.GoogleCloudAiplatformV1GroundingMetadata.properties.groundingChunks.description - schemas.GoogleCloudAiplatformV1GroundingMetadata.properties.groundingSupports.description - schemas.GoogleCloudAiplatformV1GroundingMetadata.properties.retrievalMetadata.description - schemas.GoogleCloudAiplatformV1GroundingMetadata.properties.searchEntryPoint.description - schemas.GoogleCloudAiplatformV1GroundingMetadata.properties.sourceFlaggingUris.description - schemas.GoogleCloudAiplatformV1GroundingMetadata.properties.webSearchQueries.description - schemas.GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri.description - schemas.GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri.properties.flagContentUri.description - schemas.GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri.properties.sourceId.description - schemas.GoogleCloudAiplatformV1GroundingSupport.description - schemas.GoogleCloudAiplatformV1GroundingSupport.properties.confidenceScores.description - schemas.GoogleCloudAiplatformV1GroundingSupport.properties.groundingChunkIndices.description - schemas.GoogleCloudAiplatformV1GroundingSupport.properties.segment.description - schemas.GoogleCloudAiplatformV1ImageConfig.description - schemas.GoogleCloudAiplatformV1ImageConfig.properties.personGeneration.enumDescriptions - schemas.GoogleCloudAiplatformV1LogprobsResult.description - schemas.GoogleCloudAiplatformV1LogprobsResult.properties.chosenCandidates.description - schemas.GoogleCloudAiplatformV1LogprobsResult.properties.topCandidates.description - schemas.GoogleCloudAiplatformV1LogprobsResultCandidate.description - schemas.GoogleCloudAiplatformV1LogprobsResultCandidate.properties.logProbability.description - schemas.GoogleCloudAiplatformV1LogprobsResultCandidate.properties.token.description - schemas.GoogleCloudAiplatformV1LogprobsResultCandidate.properties.tokenId.description - schemas.GoogleCloudAiplatformV1LogprobsResultTopCandidates.description - schemas.GoogleCloudAiplatformV1LogprobsResultTopCandidates.properties.candidates.description - schemas.GoogleCloudAiplatformV1ModalityTokenCount.description - schemas.GoogleCloudAiplatformV1ModalityTokenCount.properties.modality.description - schemas.GoogleCloudAiplatformV1ModalityTokenCount.properties.modality.enumDescriptions - schemas.GoogleCloudAiplatformV1ModalityTokenCount.properties.tokenCount.description - schemas.GoogleCloudAiplatformV1ModelArmorConfig.description - schemas.GoogleCloudAiplatformV1ModelArmorConfig.properties.promptTemplateName.description - schemas.GoogleCloudAiplatformV1ModelArmorConfig.properties.responseTemplateName.description - schemas.GoogleCloudAiplatformV1MultiSpeakerVoiceConfig.description - schemas.GoogleCloudAiplatformV1Part.description - schemas.GoogleCloudAiplatformV1Part.properties.codeExecutionResult.description - schemas.GoogleCloudAiplatformV1Part.properties.executableCode.description - schemas.GoogleCloudAiplatformV1Part.properties.fileData.description - schemas.GoogleCloudAiplatformV1Part.properties.functionCall.description - schemas.GoogleCloudAiplatformV1Part.properties.functionResponse.description - schemas.GoogleCloudAiplatformV1Part.properties.inlineData.description - schemas.GoogleCloudAiplatformV1Part.properties.text.description - schemas.GoogleCloudAiplatformV1Part.properties.thought.description - schemas.GoogleCloudAiplatformV1PrebuiltVoiceConfig.description - schemas.GoogleCloudAiplatformV1PrebuiltVoiceConfig.properties.voiceName.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec.properties.pythonVersion.description - schemas.GoogleCloudAiplatformV1RetrievalMetadata.description - schemas.GoogleCloudAiplatformV1RetrievalMetadata.properties.googleSearchDynamicRetrievalScore.description - schemas.GoogleCloudAiplatformV1SafetyRating.description - schemas.GoogleCloudAiplatformV1SafetyRating.properties.blocked.description - schemas.GoogleCloudAiplatformV1SafetyRating.properties.category.description - schemas.GoogleCloudAiplatformV1SafetyRating.properties.category.enumDescriptions - schemas.GoogleCloudAiplatformV1SafetyRating.properties.overwrittenThreshold.enumDescriptions - schemas.GoogleCloudAiplatformV1SafetyRating.properties.probability.description - schemas.GoogleCloudAiplatformV1SafetyRating.properties.probability.enumDescriptions - schemas.GoogleCloudAiplatformV1SafetyRating.properties.probabilityScore.description - schemas.GoogleCloudAiplatformV1SafetyRating.properties.severity.description - schemas.GoogleCloudAiplatformV1SafetyRating.properties.severity.enumDescriptions - schemas.GoogleCloudAiplatformV1SafetyRating.properties.severityScore.description - schemas.GoogleCloudAiplatformV1SafetySetting.description - schemas.GoogleCloudAiplatformV1SafetySetting.properties.category.description - schemas.GoogleCloudAiplatformV1SafetySetting.properties.category.enumDescriptions - schemas.GoogleCloudAiplatformV1SafetySetting.properties.method.description - schemas.GoogleCloudAiplatformV1SafetySetting.properties.threshold.description - schemas.GoogleCloudAiplatformV1SafetySetting.properties.threshold.enumDescriptions - schemas.GoogleCloudAiplatformV1SearchEntryPoint.description - schemas.GoogleCloudAiplatformV1SearchEntryPoint.properties.renderedContent.description - schemas.GoogleCloudAiplatformV1SearchEntryPoint.properties.sdkBlob.description - schemas.GoogleCloudAiplatformV1Segment.description - schemas.GoogleCloudAiplatformV1Segment.properties.endIndex.description - schemas.GoogleCloudAiplatformV1Segment.properties.partIndex.description - schemas.GoogleCloudAiplatformV1Segment.properties.startIndex.description - schemas.GoogleCloudAiplatformV1Segment.properties.text.description - schemas.GoogleCloudAiplatformV1SpeakerVoiceConfig.description - schemas.GoogleCloudAiplatformV1SpeechConfig.description - schemas.GoogleCloudAiplatformV1SpeechConfig.properties.languageCode.description - schemas.GoogleCloudAiplatformV1SpeechConfig.properties.voiceConfig.description - schemas.GoogleCloudAiplatformV1UrlContextMetadata.description - schemas.GoogleCloudAiplatformV1UrlContextMetadata.properties.urlMetadata.description - schemas.GoogleCloudAiplatformV1UrlMetadata.description - schemas.GoogleCloudAiplatformV1UrlMetadata.properties.retrievedUrl.description - schemas.GoogleCloudAiplatformV1UrlMetadata.properties.urlRetrievalStatus.description - schemas.GoogleCloudAiplatformV1UrlMetadata.properties.urlRetrievalStatus.enumDescriptions - schemas.GoogleCloudAiplatformV1VideoMetadata.description - schemas.GoogleCloudAiplatformV1VideoMetadata.properties.fps.description - schemas.GoogleCloudAiplatformV1VoiceConfig.description - schemas.GoogleCloudAiplatformV1VoiceConfig.properties.prebuiltVoiceConfig.description --- discovery/aiplatform-v1.json | 763 +++++++++++++++++++++--------- discovery/aiplatform-v1beta1.json | 691 ++++++++++++++++++--------- src/apis/aiplatform/v1.ts | 529 ++++++++++++++------- 3 files changed, 1352 insertions(+), 631 deletions(-) diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index 2a1baf3fbf4..87283d20e70 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -104,6 +104,11 @@ "endpointUrl": "https://europe-west10-aiplatform.googleapis.com/", "location": "europe-west10" }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west15-aiplatform.googleapis.com/", + "location": "europe-west15" + }, { "description": "Locational Endpoint", "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/", @@ -6561,7 +6566,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -28598,7 +28603,7 @@ } } }, - "revision": "20251027", + "revision": "20251028", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -30463,16 +30468,16 @@ "type": "object" }, "GoogleCloudAiplatformV1Blob": { - "description": "Content blob.", + "description": "A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video.", "id": "GoogleCloudAiplatformV1Blob", "properties": { "data": { - "description": "Required. Raw bytes.", + "description": "Required. The raw bytes of the data.", "format": "byte", "type": "string" }, "displayName": { - "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", + "description": "Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.", "type": "string" }, "mimeType": { @@ -30686,28 +30691,28 @@ "id": "GoogleCloudAiplatformV1Candidate", "properties": { "avgLogprobs": { - "description": "Output only. Average log probability score of the candidate.", + "description": "Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response.", "format": "double", "readOnly": true, "type": "number" }, "citationMetadata": { "$ref": "GoogleCloudAiplatformV1CitationMetadata", - "description": "Output only. Source attribution of the generated content.", + "description": "Output only. A collection of citations that apply to the generated content.", "readOnly": true }, "content": { "$ref": "GoogleCloudAiplatformV1Content", - "description": "Output only. Content parts of the candidate.", + "description": "Output only. The content of the candidate.", "readOnly": true }, "finishMessage": { - "description": "Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.", + "description": "Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set.", "readOnly": true, "type": "string" }, "finishReason": { - "description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.", + "description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating.", "enum": [ "FINISH_REASON_UNSPECIFIED", "STOP", @@ -30729,44 +30734,44 @@ ], "enumDescriptions": [ "The finish reason is unspecified.", - "Token generation reached a natural stopping point or a configured stop sequence.", - "Token generation reached the configured maximum output tokens.", - "Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, content is empty if content filters blocks the output.", - "The token generation stopped because of potential recitation.", - "All other reasons that stopped the token generation.", - "Token generation stopped because the content contains forbidden terms.", - "Token generation stopped for potentially containing prohibited content.", - "Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).", - "The function call generated by the model is syntaxtically invalid (e.g. the function call generated is not parsable).", + "The model reached a natural stopping point or a configured stop sequence.", + "The model generated the maximum number of tokens allowed by the `max_output_tokens` parameter.", + "The model stopped generating because the content potentially violates safety policies. NOTE: When streaming, the `content` field is empty if content filters block the output.", + "The model stopped generating because the content may be a recitation from a source.", + "The model stopped generating for a reason not otherwise specified.", + "The model stopped generating because the content contains a term from a configured blocklist.", + "The model stopped generating because the content may be prohibited.", + "The model stopped generating because the content may contain sensitive personally identifiable information (SPII).", + "The model generated a function call that is syntactically invalid and can't be parsed.", "The model response was blocked by Model Armor.", - "Token generation stopped because generated images has safety violations.", - "Image generation stopped because generated images has other prohibited content.", - "Image generation stopped due to recitation.", - "Image generation stopped because of other miscellaneous issue.", - "The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration).", - "The model was expected to generate an image, but none was generated." + "The generated image potentially violates safety policies.", + "The generated image may contain prohibited content.", + "The generated image may be a recitation from a source.", + "The image generation stopped for a reason not otherwise specified.", + "The model generated a function call that is semantically invalid. This can happen, for example, if function calling is not enabled or the generated function is not in the function declaration.", + "The model was expected to generate an image, but didn't." ], "readOnly": true, "type": "string" }, "groundingMetadata": { "$ref": "GoogleCloudAiplatformV1GroundingMetadata", - "description": "Output only. Metadata specifies sources used to ground generated content.", + "description": "Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.", "readOnly": true }, "index": { - "description": "Output only. Index of the candidate.", + "description": "Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1.", "format": "int32", "readOnly": true, "type": "integer" }, "logprobsResult": { "$ref": "GoogleCloudAiplatformV1LogprobsResult", - "description": "Output only. Log-likelihood scores for the response tokens and top tokens", + "description": "Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential \"hallucinations\".", "readOnly": true }, "safetyRatings": { - "description": "Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.", + "description": "Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.", "items": { "$ref": "GoogleCloudAiplatformV1SafetyRating" }, @@ -30775,7 +30780,7 @@ }, "urlContextMetadata": { "$ref": "GoogleCloudAiplatformV1UrlContextMetadata", - "description": "Output only. Metadata related to url context retrieval tool.", + "description": "Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.", "readOnly": true } }, @@ -30893,38 +30898,38 @@ "type": "object" }, "GoogleCloudAiplatformV1Citation": { - "description": "Source attributions for content.", + "description": "A citation for a piece of generatedcontent.", "id": "GoogleCloudAiplatformV1Citation", "properties": { "endIndex": { - "description": "Output only. End index into the content.", + "description": "Output only. The end index of the citation in the content.", "format": "int32", "readOnly": true, "type": "integer" }, "license": { - "description": "Output only. License of the attribution.", + "description": "Output only. The license of the source of the citation.", "readOnly": true, "type": "string" }, "publicationDate": { "$ref": "GoogleTypeDate", - "description": "Output only. Publication date of the attribution.", + "description": "Output only. The publication date of the source of the citation.", "readOnly": true }, "startIndex": { - "description": "Output only. Start index into the content.", + "description": "Output only. The start index of the citation in the content.", "format": "int32", "readOnly": true, "type": "integer" }, "title": { - "description": "Output only. Title of the attribution.", + "description": "Output only. The title of the source of the citation.", "readOnly": true, "type": "string" }, "uri": { - "description": "Output only. Url reference of the attribution.", + "description": "Output only. The URI of the source of the citation.", "readOnly": true, "type": "string" } @@ -30932,11 +30937,11 @@ "type": "object" }, "GoogleCloudAiplatformV1CitationMetadata": { - "description": "A collection of source attributions for a piece of content.", + "description": "A collection of citations that apply to a piece of generated content.", "id": "GoogleCloudAiplatformV1CitationMetadata", "properties": { "citations": { - "description": "Output only. List of citations.", + "description": "Output only. A list of citations for the content.", "items": { "$ref": "GoogleCloudAiplatformV1Citation" }, @@ -31300,18 +31305,18 @@ "type": "object" }, "GoogleCloudAiplatformV1Content": { - "description": "The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.", + "description": "The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.", "id": "GoogleCloudAiplatformV1Content", "properties": { "parts": { - "description": "Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.", + "description": "Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.", "items": { "$ref": "GoogleCloudAiplatformV1Part" }, "type": "array" }, "role": { - "description": "Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.", + "description": "Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.", "type": "string" } }, @@ -31992,6 +31997,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1CustomCodeExecutionSpec": { + "description": "Specificies a metric that is populated by evaluating user-defined Python code.", + "id": "GoogleCloudAiplatformV1CustomCodeExecutionSpec", + "properties": { + "evaluationFunction": { + "description": "Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text=\"The answer is 4.\"), reference=EvaluationInstance.InstanceData(text=\"4\") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ```", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1CustomJob": { "description": "Represents a job that runs custom workloads such as a Docker container or a Python package. A CustomJob can have multiple worker pools and each worker pool can have its own machine and input spec. A CustomJob will be cleaned up once the job enters terminal state (failed or succeeded).", "id": "GoogleCloudAiplatformV1CustomJob", @@ -32490,6 +32506,88 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1DatasetDistribution": { + "description": "Distribution computed over a tuning dataset.", + "id": "GoogleCloudAiplatformV1DatasetDistribution", + "properties": { + "buckets": { + "description": "Output only. Defines the histogram bucket.", + "items": { + "$ref": "GoogleCloudAiplatformV1DatasetDistributionDistributionBucket" + }, + "readOnly": true, + "type": "array" + }, + "max": { + "description": "Output only. The maximum of the population values.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "mean": { + "description": "Output only. The arithmetic mean of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "median": { + "description": "Output only. The median of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "min": { + "description": "Output only. The minimum of the population values.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "p5": { + "description": "Output only. The 5th percentile of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "p95": { + "description": "Output only. The 95th percentile of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "sum": { + "description": "Output only. Sum of a given population of values.", + "format": "double", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1DatasetDistributionDistributionBucket": { + "description": "Dataset bucket used to create a histogram for the distribution given a population of values.", + "id": "GoogleCloudAiplatformV1DatasetDistributionDistributionBucket", + "properties": { + "count": { + "description": "Output only. Number of values in the bucket.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "left": { + "description": "Output only. Left bound of the bucket.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "right": { + "description": "Output only. Right bound of the bucket.", + "format": "double", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1DatasetVersion": { "description": "Describes the dataset version.", "id": "GoogleCloudAiplatformV1DatasetVersion", @@ -37525,15 +37623,15 @@ "type": "object" }, "GoogleCloudAiplatformV1FileData": { - "description": "URI based data.", + "description": "URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage.", "id": "GoogleCloudAiplatformV1FileData", "properties": { "displayName": { - "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", + "description": "Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.", "type": "string" }, "fileUri": { - "description": "Required. URI.", + "description": "Required. The URI of the file in Google Cloud Storage.", "type": "string" }, "mimeType": { @@ -38057,6 +38155,43 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1GeminiPreferenceExample": { + "description": "Input example for preference optimization.", + "id": "GoogleCloudAiplatformV1GeminiPreferenceExample", + "properties": { + "completions": { + "description": "List of completions for a given prompt.", + "items": { + "$ref": "GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion" + }, + "type": "array" + }, + "contents": { + "description": "Multi-turn contents that represents the Prompt.", + "items": { + "$ref": "GoogleCloudAiplatformV1Content" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion": { + "description": "Completion and its preference score.", + "id": "GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion", + "properties": { + "completion": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Single turn completion for the given prompt." + }, + "score": { + "description": "The score for the given completion.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig": { "description": "Configuration for GenAiAdvancedFeatures.", "id": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig", @@ -38467,24 +38602,24 @@ "type": "object" }, "GoogleCloudAiplatformV1GenerationConfig": { - "description": "Generation config.", + "description": "Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output.", "id": "GoogleCloudAiplatformV1GenerationConfig", "properties": { "audioTimestamp": { - "description": "Optional. If enabled, audio timestamp will be included in the request to the model.", + "description": "Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.", "type": "boolean" }, "candidateCount": { - "description": "Optional. Number of candidates to generate.", + "description": "Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.", "format": "int32", "type": "integer" }, "enableAffectiveDialog": { - "description": "Optional. If enabled, the model will detect emotions and adapt its responses accordingly.", + "description": "Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.", "type": "boolean" }, "frequencyPenalty": { - "description": "Optional. Frequency penalties.", + "description": "Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].", "format": "float", "type": "number" }, @@ -38493,17 +38628,17 @@ "description": "Optional. Config for image generation features." }, "logprobs": { - "description": "Optional. Logit probabilities.", + "description": "Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.", "format": "int32", "type": "integer" }, "maxOutputTokens": { - "description": "Optional. The maximum number of output tokens to generate per message.", + "description": "Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.", "format": "int32", "type": "integer" }, "mediaResolution": { - "description": "Optional. If specified, the media resolution specified will be used.", + "description": "Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.", "enum": [ "MEDIA_RESOLUTION_UNSPECIFIED", "MEDIA_RESOLUTION_LOW", @@ -38519,24 +38654,24 @@ "type": "string" }, "presencePenalty": { - "description": "Optional. Positive penalties.", + "description": "Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].", "format": "float", "type": "number" }, "responseJsonSchema": { - "description": "Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.", + "description": "Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.", "type": "any" }, "responseLogprobs": { - "description": "Optional. If true, export the logprobs results in response.", + "description": "Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.", "type": "boolean" }, "responseMimeType": { - "description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.", + "description": "Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.", "type": "string" }, "responseModalities": { - "description": "Optional. The modalities of the response.", + "description": "Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.", "items": { "enum": [ "MODALITY_UNSPECIFIED", @@ -38556,14 +38691,14 @@ }, "responseSchema": { "$ref": "GoogleCloudAiplatformV1Schema", - "description": "Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response." + "description": "Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`." }, "routingConfig": { "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfig", "description": "Optional. Routing configuration." }, "seed": { - "description": "Optional. Seed.", + "description": "Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the \"random\" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.", "format": "int32", "type": "integer" }, @@ -38572,28 +38707,28 @@ "description": "Optional. The speech generation config." }, "stopSequences": { - "description": "Optional. Stop sequences.", + "description": "Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use [\"\\n\", \"###\"] to stop generation at a new line or a specific marker.", "items": { "type": "string" }, "type": "array" }, "temperature": { - "description": "Optional. Controls the randomness of predictions.", + "description": "Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].", "format": "float", "type": "number" }, "thinkingConfig": { "$ref": "GoogleCloudAiplatformV1GenerationConfigThinkingConfig", - "description": "Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking." + "description": "Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking." }, "topK": { - "description": "Optional. If specified, top-k sampling will be used.", + "description": "Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.", "format": "float", "type": "number" }, "topP": { - "description": "Optional. If specified, nucleus sampling will be used.", + "description": "Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.", "format": "float", "type": "number" } @@ -38601,22 +38736,22 @@ "type": "object" }, "GoogleCloudAiplatformV1GenerationConfigRoutingConfig": { - "description": "The configuration for routing the request to a specific model.", + "description": "The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name.", "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfig", "properties": { "autoMode": { "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode", - "description": "Automated routing." + "description": "In this mode, the model is selected automatically based on the content of the request." }, "manualMode": { "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode", - "description": "Manual routing." + "description": "In this mode, the model is specified manually." } }, "type": "object" }, "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode": { - "description": "When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.", + "description": "The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.", "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode", "properties": { "modelRoutingPreference": { @@ -38629,9 +38764,9 @@ ], "enumDescriptions": [ "Unspecified model routing preference.", - "Prefer higher quality over low cost.", - "Balanced model routing preference.", - "Prefer lower cost over higher quality." + "The model will be selected to prioritize the quality of the response.", + "The model will be selected to balance quality and cost.", + "The model will be selected to prioritize the cost of the request." ], "type": "string" } @@ -38639,26 +38774,26 @@ "type": "object" }, "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode": { - "description": "When manual routing is set, the specified model will be used directly.", + "description": "The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided.", "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode", "properties": { "modelName": { - "description": "The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).", + "description": "The name of the model to use. Only public LLM models are accepted.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1GenerationConfigThinkingConfig": { - "description": "Config for thinking features.", + "description": "Configuration for the model's thinking features. \"Thinking\" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response.", "id": "GoogleCloudAiplatformV1GenerationConfigThinkingConfig", "properties": { "includeThoughts": { - "description": "Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.", + "description": "Optional. If true, the model will include its thoughts in the response. \"Thoughts\" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.", "type": "boolean" }, "thinkingBudget": { - "description": "Optional. Indicates the thinking budget in tokens.", + "description": "Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.", "format": "int32", "type": "integer" } @@ -38831,57 +38966,57 @@ "type": "object" }, "GoogleCloudAiplatformV1GroundingChunk": { - "description": "Grounding chunk.", + "description": "A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.", "id": "GoogleCloudAiplatformV1GroundingChunk", "properties": { "maps": { "$ref": "GoogleCloudAiplatformV1GroundingChunkMaps", - "description": "Grounding chunk from Google Maps." + "description": "A grounding chunk from Google Maps. See the `Maps` message for details." }, "retrievedContext": { "$ref": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext", - "description": "Grounding chunk from context retrieved by the retrieval tools." + "description": "A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details" }, "web": { "$ref": "GoogleCloudAiplatformV1GroundingChunkWeb", - "description": "Grounding chunk from the web." + "description": "A grounding chunk from a web page, typically from Google Search. See the `Web` message for details." } }, "type": "object" }, "GoogleCloudAiplatformV1GroundingChunkMaps": { - "description": "Chunk from Google Maps.", + "description": "A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information.", "id": "GoogleCloudAiplatformV1GroundingChunkMaps", "properties": { "placeAnswerSources": { "$ref": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources", - "description": "Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content." + "description": "The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content." }, "placeId": { - "description": "This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.", + "description": "This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.", "type": "string" }, "text": { - "description": "Text of the place answer.", + "description": "The text of the place answer.", "type": "string" }, "title": { - "description": "Title of the place.", + "description": "The title of the place.", "type": "string" }, "uri": { - "description": "URI reference of the place.", + "description": "The URI of the place.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources": { - "description": "Sources used to generate the place answer.", + "description": "The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.", "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources", "properties": { "reviewSnippets": { - "description": "Snippets of reviews that are used to generate the answer.", + "description": "Snippets of reviews that were used to generate the answer.", "items": { "$ref": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet" }, @@ -38891,7 +39026,7 @@ "type": "object" }, "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": { - "description": "Encapsulates a review snippet.", + "description": "A review snippet that is used to generate the answer.", "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet", "properties": { "googleMapsUri": { @@ -38899,81 +39034,81 @@ "type": "string" }, "reviewId": { - "description": "Id of the review referencing the place.", + "description": "The ID of the review that is being referenced.", "type": "string" }, "title": { - "description": "Title of the review.", + "description": "The title of the review.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1GroundingChunkRetrievedContext": { - "description": "Chunk from context retrieved by the retrieval tools.", + "description": "Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.", "id": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext", "properties": { "documentName": { - "description": "Output only. The full document name for the referenced Vertex AI Search document.", + "description": "Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.", "readOnly": true, "type": "string" }, "ragChunk": { "$ref": "GoogleCloudAiplatformV1RagChunk", - "description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool." + "description": "Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used." }, "text": { - "description": "Text of the attribution.", + "description": "The content of the retrieved data source.", "type": "string" }, "title": { - "description": "Title of the attribution.", + "description": "The title of the retrieved data source.", "type": "string" }, "uri": { - "description": "URI reference of the attribution.", + "description": "The URI of the retrieved data source.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1GroundingChunkWeb": { - "description": "Chunk from the web.", + "description": "A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information.", "id": "GoogleCloudAiplatformV1GroundingChunkWeb", "properties": { "domain": { - "description": "Domain of the (original) URI.", + "description": "The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.", "type": "string" }, "title": { - "description": "Title of the chunk.", + "description": "The title of the web page that contains the evidence.", "type": "string" }, "uri": { - "description": "URI reference of the chunk.", + "description": "The URI of the web page that contains the evidence.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1GroundingMetadata": { - "description": "Metadata returned to client when grounding is enabled.", + "description": "Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources.", "id": "GoogleCloudAiplatformV1GroundingMetadata", "properties": { "googleMapsWidgetContextToken": { - "description": "Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.", + "description": "Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.", "readOnly": true, "type": "string" }, "groundingChunks": { - "description": "List of supporting references retrieved from specified grounding source.", + "description": "A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.", "items": { "$ref": "GoogleCloudAiplatformV1GroundingChunk" }, "type": "array" }, "groundingSupports": { - "description": "Optional. List of grounding support.", + "description": "Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.", "items": { "$ref": "GoogleCloudAiplatformV1GroundingSupport" }, @@ -38981,15 +39116,15 @@ }, "retrievalMetadata": { "$ref": "GoogleCloudAiplatformV1RetrievalMetadata", - "description": "Optional. Output only. Retrieval metadata.", + "description": "Optional. Output only. Metadata related to the retrieval grounding source.", "readOnly": true }, "searchEntryPoint": { "$ref": "GoogleCloudAiplatformV1SearchEntryPoint", - "description": "Optional. Google search entry for the following-up web searches." + "description": "Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search." }, "sourceFlaggingUris": { - "description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.", + "description": "Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.", "items": { "$ref": "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri" }, @@ -38997,7 +39132,7 @@ "type": "array" }, "webSearchQueries": { - "description": "Optional. Web search queries for the following-up web search.", + "description": "Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.", "items": { "type": "string" }, @@ -39007,26 +39142,26 @@ "type": "object" }, "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri": { - "description": "Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.", + "description": "A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.", "id": "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri", "properties": { "flagContentUri": { - "description": "A link where users can flag a problem with the source (place or review).", + "description": "The URI that can be used to flag the content.", "type": "string" }, "sourceId": { - "description": "Id of the place or review.", + "description": "The ID of the place or review.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1GroundingSupport": { - "description": "Grounding support.", + "description": "A collection of supporting references for a segment of the model's response.", "id": "GoogleCloudAiplatformV1GroundingSupport", "properties": { "confidenceScores": { - "description": "Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.", + "description": "The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.", "items": { "format": "float", "type": "number" @@ -39034,7 +39169,7 @@ "type": "array" }, "groundingChunkIndices": { - "description": "A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.", + "description": "A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.", "items": { "format": "int32", "type": "integer" @@ -39043,7 +39178,7 @@ }, "segment": { "$ref": "GoogleCloudAiplatformV1Segment", - "description": "Segment of the content this support belongs to." + "description": "The content segment that this support message applies to." } }, "type": "object" @@ -39193,7 +39328,7 @@ "type": "object" }, "GoogleCloudAiplatformV1ImageConfig": { - "description": "Config for image generation features.", + "description": "Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people.", "id": "GoogleCloudAiplatformV1ImageConfig", "properties": { "aspectRatio": { @@ -39213,10 +39348,10 @@ "ALLOW_NONE" ], "enumDescriptions": [ - "Generation images of people unspecified.", - "Generate images that include adults and children.", - "Generate images of adults, but not children.", - "Block generation of images of people." + "The default behavior is unspecified. The model will decide whether to generate images of people.", + "Allows the model to generate images of people, including adults and children.", + "Allows the model to generate images of adults, but not children.", + "Prevents the model from generating images of people." ], "type": "string" } @@ -41145,18 +41280,18 @@ "type": "object" }, "GoogleCloudAiplatformV1LogprobsResult": { - "description": "Logprobs Result", + "description": "The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is \"hallucinating\" or generating factually incorrect information.", "id": "GoogleCloudAiplatformV1LogprobsResult", "properties": { "chosenCandidates": { - "description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.", + "description": "A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`.", "items": { "$ref": "GoogleCloudAiplatformV1LogprobsResultCandidate" }, "type": "array" }, "topCandidates": { - "description": "Length = total number of decoding steps.", + "description": "A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps.", "items": { "$ref": "GoogleCloudAiplatformV1LogprobsResultTopCandidates" }, @@ -41166,20 +41301,20 @@ "type": "object" }, "GoogleCloudAiplatformV1LogprobsResultCandidate": { - "description": "Candidate for the logprobs token and score.", + "description": "A single token and its associated log probability.", "id": "GoogleCloudAiplatformV1LogprobsResultCandidate", "properties": { "logProbability": { - "description": "The candidate's log probability.", + "description": "The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.", "format": "float", "type": "number" }, "token": { - "description": "The candidate's token string value.", + "description": "The token's string representation.", "type": "string" }, "tokenId": { - "description": "The candidate's token id value.", + "description": "The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary.", "format": "int32", "type": "integer" } @@ -41187,11 +41322,11 @@ "type": "object" }, "GoogleCloudAiplatformV1LogprobsResultTopCandidates": { - "description": "Candidates with top log probabilities at each decoding step.", + "description": "A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.", "id": "GoogleCloudAiplatformV1LogprobsResultTopCandidates", "properties": { "candidates": { - "description": "Sorted by log probability in descending order.", + "description": "The list of candidate tokens, sorted by log probability in descending order.", "items": { "$ref": "GoogleCloudAiplatformV1LogprobsResultCandidate" }, @@ -41547,6 +41682,10 @@ "$ref": "GoogleCloudAiplatformV1BleuSpec", "description": "Spec for bleu metric." }, + "customCodeExecutionSpec": { + "$ref": "GoogleCloudAiplatformV1CustomCodeExecutionSpec", + "description": "Spec for Custom Code Execution metric." + }, "exactMatchSpec": { "$ref": "GoogleCloudAiplatformV1ExactMatchSpec", "description": "Spec for exact match metric." @@ -41929,11 +42068,11 @@ "type": "object" }, "GoogleCloudAiplatformV1ModalityTokenCount": { - "description": "Represents token counting info for a single modality.", + "description": "Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.", "id": "GoogleCloudAiplatformV1ModalityTokenCount", "properties": { "modality": { - "description": "The modality associated with this token count.", + "description": "The modality that this token count applies to.", "enum": [ "MODALITY_UNSPECIFIED", "TEXT", @@ -41943,17 +42082,17 @@ "DOCUMENT" ], "enumDescriptions": [ - "Unspecified modality.", - "Plain text.", - "Image.", - "Video.", - "Audio.", - "Document, e.g. PDF." + "When a modality is not specified, it is treated as `TEXT`.", + "The `Part` contains plain text.", + "The `Part` contains an image.", + "The `Part` contains a video.", + "The `Part` contains audio.", + "The `Part` contains a document, such as a PDF." ], "type": "string" }, "tokenCount": { - "description": "Number of tokens.", + "description": "The number of tokens counted for this modality.", "format": "int32", "type": "integer" } @@ -42165,15 +42304,15 @@ "type": "object" }, "GoogleCloudAiplatformV1ModelArmorConfig": { - "description": "Configuration for Model Armor integrations of prompt and responses.", + "description": "Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks.", "id": "GoogleCloudAiplatformV1ModelArmorConfig", "properties": { "promptTemplateName": { - "description": "Optional. The name of the Model Armor template to use for prompt sanitization.", + "description": "Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.", "type": "string" }, "responseTemplateName": { - "description": "Optional. The name of the Model Armor template to use for response sanitization.", + "description": "Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.", "type": "string" } }, @@ -43159,7 +43298,7 @@ "type": "object" }, "GoogleCloudAiplatformV1MultiSpeakerVoiceConfig": { - "description": "Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request.", + "description": "Configuration for a multi-speaker text-to-speech request.", "id": "GoogleCloudAiplatformV1MultiSpeakerVoiceConfig", "properties": { "speakerVoiceConfigs": { @@ -44906,39 +45045,39 @@ "type": "object" }, "GoogleCloudAiplatformV1Part": { - "description": "A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", + "description": "A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", "id": "GoogleCloudAiplatformV1Part", "properties": { "codeExecutionResult": { "$ref": "GoogleCloudAiplatformV1CodeExecutionResult", - "description": "Optional. Result of executing the [ExecutableCode]." + "description": "Optional. The result of executing the ExecutableCode." }, "executableCode": { "$ref": "GoogleCloudAiplatformV1ExecutableCode", - "description": "Optional. Code generated by the model that is meant to be executed." + "description": "Optional. Code generated by the model that is intended to be executed." }, "fileData": { "$ref": "GoogleCloudAiplatformV1FileData", - "description": "Optional. URI based data." + "description": "Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage." }, "functionCall": { "$ref": "GoogleCloudAiplatformV1FunctionCall", - "description": "Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values." + "description": "Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function." }, "functionResponse": { "$ref": "GoogleCloudAiplatformV1FunctionResponse", - "description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model." + "description": "Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted." }, "inlineData": { "$ref": "GoogleCloudAiplatformV1Blob", - "description": "Optional. Inlined bytes data." + "description": "Optional. The inline data content of the part. This can be used to include images, audio, or video in a request." }, "text": { - "description": "Optional. Text part (can be code).", + "description": "Optional. The text content of the part.", "type": "string" }, "thought": { - "description": "Optional. Indicates if the part is thought from the model.", + "description": "Optional. Indicates whether the `part` represents the model's thought process or reasoning.", "type": "boolean" }, "thoughtSignature": { @@ -45708,11 +45847,11 @@ "type": "object" }, "GoogleCloudAiplatformV1PrebuiltVoiceConfig": { - "description": "The configuration for the prebuilt speaker to use.", + "description": "Configuration for a prebuilt voice.", "id": "GoogleCloudAiplatformV1PrebuiltVoiceConfig", "properties": { "voiceName": { - "description": "The name of the preset voice to use.", + "description": "The name of the prebuilt voice to use.", "type": "string" } }, @@ -45868,6 +46007,143 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1PreferenceOptimizationDataStats": { + "description": "Statistics computed for datasets used for preference optimization.", + "id": "GoogleCloudAiplatformV1PreferenceOptimizationDataStats", + "properties": { + "droppedExampleIndices": { + "description": "Output only. A partial sample of the indices (starting from 1) of the dropped examples.", + "items": { + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "droppedExampleReasons": { + "description": "Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "scoreVariancePerExampleDistribution": { + "$ref": "GoogleCloudAiplatformV1DatasetDistribution", + "description": "Output only. Dataset distributions for scores variance per example.", + "readOnly": true + }, + "scoresDistribution": { + "$ref": "GoogleCloudAiplatformV1DatasetDistribution", + "description": "Output only. Dataset distributions for scores.", + "readOnly": true + }, + "totalBillableTokenCount": { + "description": "Output only. Number of billable tokens in the tuning dataset.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "tuningDatasetExampleCount": { + "description": "Output only. Number of examples in the tuning dataset.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "tuningStepCount": { + "description": "Output only. Number of tuning steps for this Tuning Job.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "userDatasetExamples": { + "description": "Output only. Sample user examples in the training dataset.", + "items": { + "$ref": "GoogleCloudAiplatformV1GeminiPreferenceExample" + }, + "readOnly": true, + "type": "array" + }, + "userInputTokenDistribution": { + "$ref": "GoogleCloudAiplatformV1DatasetDistribution", + "description": "Output only. Dataset distributions for the user input tokens.", + "readOnly": true + }, + "userOutputTokenDistribution": { + "$ref": "GoogleCloudAiplatformV1DatasetDistribution", + "description": "Output only. Dataset distributions for the user output tokens.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters": { + "description": "Hyperparameters for Preference Optimization.", + "id": "GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters", + "properties": { + "adapterSize": { + "description": "Optional. Adapter size for preference optimization.", + "enum": [ + "ADAPTER_SIZE_UNSPECIFIED", + "ADAPTER_SIZE_ONE", + "ADAPTER_SIZE_TWO", + "ADAPTER_SIZE_FOUR", + "ADAPTER_SIZE_EIGHT", + "ADAPTER_SIZE_SIXTEEN", + "ADAPTER_SIZE_THIRTY_TWO" + ], + "enumDescriptions": [ + "Adapter size is unspecified.", + "Adapter size 1.", + "Adapter size 2.", + "Adapter size 4.", + "Adapter size 8.", + "Adapter size 16.", + "Adapter size 32." + ], + "type": "string" + }, + "beta": { + "description": "Optional. Weight for KL Divergence regularization.", + "format": "double", + "type": "number" + }, + "epochCount": { + "description": "Optional. Number of complete passes the model makes over the entire training dataset during training.", + "format": "int64", + "type": "string" + }, + "learningRateMultiplier": { + "description": "Optional. Multiplier for adjusting the default learning rate.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PreferenceOptimizationSpec": { + "description": "Tuning Spec for Preference Optimization.", + "id": "GoogleCloudAiplatformV1PreferenceOptimizationSpec", + "properties": { + "exportLastCheckpointOnly": { + "description": "Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.", + "type": "boolean" + }, + "hyperParameters": { + "$ref": "GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters", + "description": "Optional. Hyperparameters for Preference Optimization." + }, + "trainingDatasetUri": { + "description": "Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.", + "type": "string" + }, + "validationDatasetUri": { + "description": "Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1Presets": { "description": "Preset configuration for example-based explanations", "id": "GoogleCloudAiplatformV1Presets", @@ -47165,6 +47441,16 @@ "readOnly": true, "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this RagCorpus was last updated.", "format": "google-datetime", @@ -48040,7 +48326,7 @@ "type": "string" }, "pythonVersion": { - "description": "Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10.", + "description": "Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10.", "type": "string" }, "requirementsGcsUri": { @@ -48380,11 +48666,11 @@ "type": "object" }, "GoogleCloudAiplatformV1RetrievalMetadata": { - "description": "Metadata related to retrieval in the grounding flow.", + "description": "Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled.", "id": "GoogleCloudAiplatformV1RetrievalMetadata", "properties": { "googleSearchDynamicRetrievalScore": { - "description": "Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.", + "description": "Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.", "format": "float", "type": "number" } @@ -48768,16 +49054,16 @@ "type": "object" }, "GoogleCloudAiplatformV1SafetyRating": { - "description": "Safety rating corresponding to the generated content.", + "description": "A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.", "id": "GoogleCloudAiplatformV1SafetyRating", "properties": { "blocked": { - "description": "Output only. Indicates whether the content was filtered out because of this rating.", + "description": "Output only. Indicates whether the content was blocked because of this rating.", "readOnly": true, "type": "boolean" }, "category": { - "description": "Output only. Harm category.", + "description": "Output only. The harm category of this rating.", "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", @@ -48805,17 +49091,17 @@ false ], "enumDescriptions": [ - "The harm category is unspecified.", - "The harm category is hate speech.", - "The harm category is dangerous content.", - "The harm category is harassment.", - "The harm category is sexually explicit content.", + "Default value. This value is unused.", + "Content that promotes violence or incites hatred against individuals or groups based on certain attributes.", + "Content that promotes, facilitates, or enables dangerous activities.", + "Abusive, threatening, or content intended to bully, torment, or ridicule.", + "Content that contains sexually explicit material.", "Deprecated: Election filter is not longer supported. The harm category is civic integrity.", - "The harm category is image hate.", - "The harm category is image dangerous content.", - "The harm category is image harassment.", - "The harm category is image sexually explicit content.", - "The harm category is for jailbreak prompts." + "Images that contain hate speech.", + "Images that contain dangerous content.", + "Images that contain harassment.", + "Images that contain sexually explicit content.", + "Prompts designed to bypass safety filters." ], "readOnly": true, "type": "string" @@ -48831,18 +49117,18 @@ "OFF" ], "enumDescriptions": [ - "Unspecified harm block threshold.", - "Block low threshold and above (i.e. block more).", - "Block medium threshold and above.", - "Block only high threshold (i.e. block less).", - "Block none.", - "Turn off the safety filter." + "The harm block threshold is unspecified.", + "Block content with a low harm probability or higher.", + "Block content with a medium harm probability or higher.", + "Block content with a high harm probability.", + "Do not block any content, regardless of its harm probability.", + "Turn off the safety filter entirely." ], "readOnly": true, "type": "string" }, "probability": { - "description": "Output only. Harm probability levels in the content.", + "description": "Output only. The probability of harm for this category.", "enum": [ "HARM_PROBABILITY_UNSPECIFIED", "NEGLIGIBLE", @@ -48851,23 +49137,23 @@ "HIGH" ], "enumDescriptions": [ - "Harm probability unspecified.", - "Negligible level of harm.", - "Low level of harm.", - "Medium level of harm.", - "High level of harm." + "The harm probability is unspecified.", + "The harm probability is negligible.", + "The harm probability is low.", + "The harm probability is medium.", + "The harm probability is high." ], "readOnly": true, "type": "string" }, "probabilityScore": { - "description": "Output only. Harm probability score.", + "description": "Output only. The probability score of harm for this category.", "format": "float", "readOnly": true, "type": "number" }, "severity": { - "description": "Output only. Harm severity levels in the content.", + "description": "Output only. The severity of harm for this category.", "enum": [ "HARM_SEVERITY_UNSPECIFIED", "HARM_SEVERITY_NEGLIGIBLE", @@ -48876,17 +49162,17 @@ "HARM_SEVERITY_HIGH" ], "enumDescriptions": [ - "Harm severity unspecified.", - "Negligible level of harm severity.", - "Low level of harm severity.", - "Medium level of harm severity.", - "High level of harm severity." + "The harm severity is unspecified.", + "The harm severity is negligible.", + "The harm severity is low.", + "The harm severity is medium.", + "The harm severity is high." ], "readOnly": true, "type": "string" }, "severityScore": { - "description": "Output only. Harm severity score.", + "description": "Output only. The severity score of harm for this category.", "format": "float", "readOnly": true, "type": "number" @@ -48919,11 +49205,11 @@ "type": "object" }, "GoogleCloudAiplatformV1SafetySetting": { - "description": "Safety settings.", + "description": "A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.", "id": "GoogleCloudAiplatformV1SafetySetting", "properties": { "category": { - "description": "Required. Harm category.", + "description": "Required. The harm category to be blocked.", "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", @@ -48951,22 +49237,22 @@ false ], "enumDescriptions": [ - "The harm category is unspecified.", - "The harm category is hate speech.", - "The harm category is dangerous content.", - "The harm category is harassment.", - "The harm category is sexually explicit content.", + "Default value. This value is unused.", + "Content that promotes violence or incites hatred against individuals or groups based on certain attributes.", + "Content that promotes, facilitates, or enables dangerous activities.", + "Abusive, threatening, or content intended to bully, torment, or ridicule.", + "Content that contains sexually explicit material.", "Deprecated: Election filter is not longer supported. The harm category is civic integrity.", - "The harm category is image hate.", - "The harm category is image dangerous content.", - "The harm category is image harassment.", - "The harm category is image sexually explicit content.", - "The harm category is for jailbreak prompts." + "Images that contain hate speech.", + "Images that contain dangerous content.", + "Images that contain harassment.", + "Images that contain sexually explicit content.", + "Prompts designed to bypass safety filters." ], "type": "string" }, "method": { - "description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.", + "description": "Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.", "enum": [ "HARM_BLOCK_METHOD_UNSPECIFIED", "SEVERITY", @@ -48980,7 +49266,7 @@ "type": "string" }, "threshold": { - "description": "Required. The harm block threshold.", + "description": "Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.", "enum": [ "HARM_BLOCK_THRESHOLD_UNSPECIFIED", "BLOCK_LOW_AND_ABOVE", @@ -48990,12 +49276,12 @@ "OFF" ], "enumDescriptions": [ - "Unspecified harm block threshold.", - "Block low threshold and above (i.e. block more).", - "Block medium threshold and above.", - "Block only high threshold (i.e. block less).", - "Block none.", - "Turn off the safety filter." + "The harm block threshold is unspecified.", + "Block content with a low harm probability or higher.", + "Block content with a medium harm probability or higher.", + "Block content with a high harm probability.", + "Do not block any content, regardless of its harm probability.", + "Turn off the safety filter entirely." ], "type": "string" } @@ -53600,15 +53886,15 @@ "type": "object" }, "GoogleCloudAiplatformV1SearchEntryPoint": { - "description": "Google search entry point.", + "description": "An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application.", "id": "GoogleCloudAiplatformV1SearchEntryPoint", "properties": { "renderedContent": { - "description": "Optional. Web content snippet that can be embedded in a web page or an app webview.", + "description": "Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.", "type": "string" }, "sdkBlob": { - "description": "Optional. Base64 encoded JSON representing array of tuple.", + "description": "Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.", "format": "byte", "type": "string" } @@ -53816,29 +54102,29 @@ "type": "object" }, "GoogleCloudAiplatformV1Segment": { - "description": "Segment of the content.", + "description": "A segment of the content.", "id": "GoogleCloudAiplatformV1Segment", "properties": { "endIndex": { - "description": "Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.", + "description": "Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.", "format": "int32", "readOnly": true, "type": "integer" }, "partIndex": { - "description": "Output only. The index of a Part object within its parent Content object.", + "description": "Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.", "format": "int32", "readOnly": true, "type": "integer" }, "startIndex": { - "description": "Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.", + "description": "Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.", "format": "int32", "readOnly": true, "type": "integer" }, "text": { - "description": "Output only. The text corresponding to the segment from the response.", + "description": "Output only. The text of the segment.", "readOnly": true, "type": "string" } @@ -54004,7 +54290,7 @@ "type": "object" }, "GoogleCloudAiplatformV1SpeakerVoiceConfig": { - "description": "Configuration for a single speaker in a multi speaker setup.", + "description": "Configuration for a single speaker in a multi-speaker setup.", "id": "GoogleCloudAiplatformV1SpeakerVoiceConfig", "properties": { "speaker": { @@ -54105,11 +54391,11 @@ "type": "object" }, "GoogleCloudAiplatformV1SpeechConfig": { - "description": "The speech generation config.", + "description": "Configuration for speech generation.", "id": "GoogleCloudAiplatformV1SpeechConfig", "properties": { "languageCode": { - "description": "Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.", + "description": "Optional. The language code (ISO 639-1) for the speech synthesis.", "type": "string" }, "multiSpeakerVoiceConfig": { @@ -54118,7 +54404,7 @@ }, "voiceConfig": { "$ref": "GoogleCloudAiplatformV1VoiceConfig", - "description": "The configuration for the speaker to use." + "description": "The configuration for the voice to use." } }, "type": "object" @@ -57158,6 +57444,11 @@ "description": "The tuning data statistic values for TuningJob.", "id": "GoogleCloudAiplatformV1TuningDataStats", "properties": { + "preferenceOptimizationDataStats": { + "$ref": "GoogleCloudAiplatformV1PreferenceOptimizationDataStats", + "description": "Output only. Statistics for preference optimization.", + "readOnly": true + }, "supervisedTuningDataStats": { "$ref": "GoogleCloudAiplatformV1SupervisedTuningDataStats", "description": "The SFT Tuning data stats." @@ -57219,6 +57510,10 @@ "$ref": "GoogleCloudAiplatformV1PreTunedModel", "description": "The pre-tuned model for continuous tuning." }, + "preferenceOptimizationSpec": { + "$ref": "GoogleCloudAiplatformV1PreferenceOptimizationSpec", + "description": "Tuning Spec for Preference Optimization." + }, "serviceAccount": { "description": "The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.", "type": "string" @@ -57689,11 +57984,11 @@ "type": "object" }, "GoogleCloudAiplatformV1UrlContextMetadata": { - "description": "Metadata related to url context retrieval tool.", + "description": "Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.", "id": "GoogleCloudAiplatformV1UrlContextMetadata", "properties": { "urlMetadata": { - "description": "Output only. List of url context.", + "description": "Output only. A list of URL metadata, with one entry for each URL retrieved by the tool.", "items": { "$ref": "GoogleCloudAiplatformV1UrlMetadata" }, @@ -57704,15 +57999,15 @@ "type": "object" }, "GoogleCloudAiplatformV1UrlMetadata": { - "description": "Context of the a single url retrieval.", + "description": "The metadata for a single URL retrieval.", "id": "GoogleCloudAiplatformV1UrlMetadata", "properties": { "retrievedUrl": { - "description": "Retrieved url by the tool.", + "description": "The URL retrieved by the tool.", "type": "string" }, "urlRetrievalStatus": { - "description": "Status of the url retrieval.", + "description": "The status of the URL retrieval.", "enum": [ "URL_RETRIEVAL_STATUS_UNSPECIFIED", "URL_RETRIEVAL_STATUS_SUCCESS", @@ -57720,8 +58015,8 @@ ], "enumDescriptions": [ "Default value. This value is unused.", - "Url retrieval is successful.", - "Url retrieval is failed due to error." + "The URL was retrieved successfully.", + "The URL retrieval failed." ], "type": "string" } @@ -57961,7 +58256,7 @@ "type": "object" }, "GoogleCloudAiplatformV1VideoMetadata": { - "description": "Metadata describes the input video content.", + "description": "Provides metadata for a video, including the start and end offsets for clipping and the frame rate.", "id": "GoogleCloudAiplatformV1VideoMetadata", "properties": { "endOffset": { @@ -57970,7 +58265,7 @@ "type": "string" }, "fps": { - "description": "Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].", + "description": "Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].", "format": "double", "type": "number" }, @@ -57983,12 +58278,12 @@ "type": "object" }, "GoogleCloudAiplatformV1VoiceConfig": { - "description": "The configuration for the voice to use.", + "description": "Configuration for a voice.", "id": "GoogleCloudAiplatformV1VoiceConfig", "properties": { "prebuiltVoiceConfig": { "$ref": "GoogleCloudAiplatformV1PrebuiltVoiceConfig", - "description": "The configuration for the prebuilt voice to use." + "description": "The configuration for a prebuilt voice." } }, "type": "object" diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index cbd325365ff..d1112940ea6 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -104,6 +104,11 @@ "endpointUrl": "https://europe-west10-aiplatform.googleapis.com/", "location": "europe-west10" }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west15-aiplatform.googleapis.com/", + "location": "europe-west15" + }, { "description": "Locational Endpoint", "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/", @@ -8439,7 +8444,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -29005,6 +29010,11 @@ "location": "query", "type": "string" }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.", "format": "int32", @@ -35119,6 +35129,155 @@ } }, "sandboxEnvironments": { + "methods": { + "create": { + "description": "Creates a SandboxEnvironment in a given reasoning engine.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/sandboxEnvironments", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specific SandboxEnvironment.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "execute": { + "description": "Executes using a sandbox environment.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.execute", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:execute", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of the specific SandboxEnvironment.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SandboxEnvironments in a given reasoning engine.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/sandboxEnvironments", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -35484,6 +35643,11 @@ "location": "query", "type": "string" }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.", "format": "int32", @@ -37251,7 +37415,7 @@ } } }, - "revision": "20251027", + "revision": "20251028", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -37862,6 +38026,10 @@ "$ref": "GoogleCloudAiplatformV1beta1BleuMetricValue", "description": "Results for bleu metric." }, + "customCodeExecutionResult": { + "$ref": "GoogleCloudAiplatformV1beta1CustomCodeExecutionResult", + "description": "Result for code execution metric." + }, "exactMatchMetricValue": { "$ref": "GoogleCloudAiplatformV1beta1ExactMatchMetricValue", "description": "Results for exact match metric." @@ -39387,16 +39555,16 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Blob": { - "description": "Content blob.", + "description": "A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video.", "id": "GoogleCloudAiplatformV1beta1Blob", "properties": { "data": { - "description": "Required. Raw bytes.", + "description": "Required. The raw bytes of the data.", "format": "byte", "type": "string" }, "displayName": { - "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", + "description": "Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.", "type": "string" }, "mimeType": { @@ -39610,28 +39778,28 @@ "id": "GoogleCloudAiplatformV1beta1Candidate", "properties": { "avgLogprobs": { - "description": "Output only. Average log probability score of the candidate.", + "description": "Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response.", "format": "double", "readOnly": true, "type": "number" }, "citationMetadata": { "$ref": "GoogleCloudAiplatformV1beta1CitationMetadata", - "description": "Output only. Source attribution of the generated content.", + "description": "Output only. A collection of citations that apply to the generated content.", "readOnly": true }, "content": { "$ref": "GoogleCloudAiplatformV1beta1Content", - "description": "Output only. Content parts of the candidate.", + "description": "Output only. The content of the candidate.", "readOnly": true }, "finishMessage": { - "description": "Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.", + "description": "Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set.", "readOnly": true, "type": "string" }, "finishReason": { - "description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.", + "description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating.", "enum": [ "FINISH_REASON_UNSPECIFIED", "STOP", @@ -39653,44 +39821,44 @@ ], "enumDescriptions": [ "The finish reason is unspecified.", - "Token generation reached a natural stopping point or a configured stop sequence.", - "Token generation reached the configured maximum output tokens.", - "Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, content is empty if content filters blocks the output.", - "The token generation stopped because of potential recitation.", - "All other reasons that stopped the token generation.", - "Token generation stopped because the content contains forbidden terms.", - "Token generation stopped for potentially containing prohibited content.", - "Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).", - "The function call generated by the model is syntaxtically invalid (e.g. the function call generated is not parsable).", + "The model reached a natural stopping point or a configured stop sequence.", + "The model generated the maximum number of tokens allowed by the `max_output_tokens` parameter.", + "The model stopped generating because the content potentially violates safety policies. NOTE: When streaming, the `content` field is empty if content filters block the output.", + "The model stopped generating because the content may be a recitation from a source.", + "The model stopped generating for a reason not otherwise specified.", + "The model stopped generating because the content contains a term from a configured blocklist.", + "The model stopped generating because the content may be prohibited.", + "The model stopped generating because the content may contain sensitive personally identifiable information (SPII).", + "The model generated a function call that is syntactically invalid and can't be parsed.", "The model response was blocked by Model Armor.", - "Token generation stopped because generated images has safety violations.", - "Image generation stopped because generated images has other prohibited content.", - "Image generation stopped due to recitation.", - "Image generation stopped because of other miscellaneous issue.", - "The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration).", - "The model was expected to generate an image, but none was generated." + "The generated image potentially violates safety policies.", + "The generated image may contain prohibited content.", + "The generated image may be a recitation from a source.", + "The image generation stopped for a reason not otherwise specified.", + "The model generated a function call that is semantically invalid. This can happen, for example, if function calling is not enabled or the generated function is not in the function declaration.", + "The model was expected to generate an image, but didn't." ], "readOnly": true, "type": "string" }, "groundingMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadata", - "description": "Output only. Metadata specifies sources used to ground generated content.", + "description": "Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.", "readOnly": true }, "index": { - "description": "Output only. Index of the candidate.", + "description": "Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1.", "format": "int32", "readOnly": true, "type": "integer" }, "logprobsResult": { "$ref": "GoogleCloudAiplatformV1beta1LogprobsResult", - "description": "Output only. Log-likelihood scores for the response tokens and top tokens", + "description": "Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential \"hallucinations\".", "readOnly": true }, "safetyRatings": { - "description": "Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.", + "description": "Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SafetyRating" }, @@ -39699,7 +39867,7 @@ }, "urlContextMetadata": { "$ref": "GoogleCloudAiplatformV1beta1UrlContextMetadata", - "description": "Output only. Metadata related to url context retrieval tool.", + "description": "Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.", "readOnly": true } }, @@ -39855,38 +40023,38 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Citation": { - "description": "Source attributions for content.", + "description": "A citation for a piece of generatedcontent.", "id": "GoogleCloudAiplatformV1beta1Citation", "properties": { "endIndex": { - "description": "Output only. End index into the content.", + "description": "Output only. The end index of the citation in the content.", "format": "int32", "readOnly": true, "type": "integer" }, "license": { - "description": "Output only. License of the attribution.", + "description": "Output only. The license of the source of the citation.", "readOnly": true, "type": "string" }, "publicationDate": { "$ref": "GoogleTypeDate", - "description": "Output only. Publication date of the attribution.", + "description": "Output only. The publication date of the source of the citation.", "readOnly": true }, "startIndex": { - "description": "Output only. Start index into the content.", + "description": "Output only. The start index of the citation in the content.", "format": "int32", "readOnly": true, "type": "integer" }, "title": { - "description": "Output only. Title of the attribution.", + "description": "Output only. The title of the source of the citation.", "readOnly": true, "type": "string" }, "uri": { - "description": "Output only. Url reference of the attribution.", + "description": "Output only. The URI of the source of the citation.", "readOnly": true, "type": "string" } @@ -39894,11 +40062,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1CitationMetadata": { - "description": "A collection of source attributions for a piece of content.", + "description": "A collection of citations that apply to a piece of generated content.", "id": "GoogleCloudAiplatformV1beta1CitationMetadata", "properties": { "citations": { - "description": "Output only. List of citations.", + "description": "Output only. A list of citations for the content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Citation" }, @@ -40262,18 +40430,18 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Content": { - "description": "The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.", + "description": "The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.", "id": "GoogleCloudAiplatformV1beta1Content", "properties": { "parts": { - "description": "Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.", + "description": "Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Part" }, "type": "array" }, "role": { - "description": "Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.", + "description": "Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.", "type": "string" } }, @@ -41038,6 +41206,30 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1CustomCodeExecutionResult": { + "description": "Result for custom code execution metric.", + "id": "GoogleCloudAiplatformV1beta1CustomCodeExecutionResult", + "properties": { + "score": { + "description": "Output only. Custom code execution score.", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec": { + "description": "Specificies a metric that is populated by evaluating user-defined Python code.", + "id": "GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec", + "properties": { + "evaluationFunction": { + "description": "Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text=\"The answer is 4.\"), reference=EvaluationInstance.InstanceData(text=\"4\") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ```", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1CustomJob": { "description": "Represents a job that runs custom workloads such as a Docker container or a Python package. A CustomJob can have multiple worker pools and each worker pool can have its own machine and input spec. A CustomJob will be cleaned up once the job enters terminal state (failed or succeeded).", "id": "GoogleCloudAiplatformV1beta1CustomJob", @@ -47803,15 +47995,15 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1FileData": { - "description": "URI based data.", + "description": "URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage.", "id": "GoogleCloudAiplatformV1beta1FileData", "properties": { "displayName": { - "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", + "description": "Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.", "type": "string" }, "fileUri": { - "description": "Required. URI.", + "description": "Required. The URI of the file in Google Cloud Storage.", "type": "string" }, "mimeType": { @@ -49075,24 +49267,24 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerationConfig": { - "description": "Generation config.", + "description": "Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output.", "id": "GoogleCloudAiplatformV1beta1GenerationConfig", "properties": { "audioTimestamp": { - "description": "Optional. If enabled, audio timestamp will be included in the request to the model.", + "description": "Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.", "type": "boolean" }, "candidateCount": { - "description": "Optional. Number of candidates to generate.", + "description": "Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.", "format": "int32", "type": "integer" }, "enableAffectiveDialog": { - "description": "Optional. If enabled, the model will detect emotions and adapt its responses accordingly.", + "description": "Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.", "type": "boolean" }, "frequencyPenalty": { - "description": "Optional. Frequency penalties.", + "description": "Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].", "format": "float", "type": "number" }, @@ -49101,17 +49293,17 @@ "description": "Optional. Config for image generation features." }, "logprobs": { - "description": "Optional. Logit probabilities.", + "description": "Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.", "format": "int32", "type": "integer" }, "maxOutputTokens": { - "description": "Optional. The maximum number of output tokens to generate per message.", + "description": "Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.", "format": "int32", "type": "integer" }, "mediaResolution": { - "description": "Optional. If specified, the media resolution specified will be used.", + "description": "Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.", "enum": [ "MEDIA_RESOLUTION_UNSPECIFIED", "MEDIA_RESOLUTION_LOW", @@ -49132,24 +49324,24 @@ "description": "Optional. Config for model selection." }, "presencePenalty": { - "description": "Optional. Positive penalties.", + "description": "Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].", "format": "float", "type": "number" }, "responseJsonSchema": { - "description": "Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.", + "description": "Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.", "type": "any" }, "responseLogprobs": { - "description": "Optional. If true, export the logprobs results in response.", + "description": "Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.", "type": "boolean" }, "responseMimeType": { - "description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.", + "description": "Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.", "type": "string" }, "responseModalities": { - "description": "Optional. The modalities of the response.", + "description": "Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.", "items": { "enum": [ "MODALITY_UNSPECIFIED", @@ -49169,14 +49361,14 @@ }, "responseSchema": { "$ref": "GoogleCloudAiplatformV1beta1Schema", - "description": "Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response." + "description": "Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`." }, "routingConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", "description": "Optional. Routing configuration." }, "seed": { - "description": "Optional. Seed.", + "description": "Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the \"random\" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.", "format": "int32", "type": "integer" }, @@ -49185,28 +49377,28 @@ "description": "Optional. The speech generation config." }, "stopSequences": { - "description": "Optional. Stop sequences.", + "description": "Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use [\"\\n\", \"###\"] to stop generation at a new line or a specific marker.", "items": { "type": "string" }, "type": "array" }, "temperature": { - "description": "Optional. Controls the randomness of predictions.", + "description": "Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].", "format": "float", "type": "number" }, "thinkingConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", - "description": "Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking." + "description": "Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking." }, "topK": { - "description": "Optional. If specified, top-k sampling will be used.", + "description": "Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.", "format": "float", "type": "number" }, "topP": { - "description": "Optional. If specified, nucleus sampling will be used.", + "description": "Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.", "format": "float", "type": "number" } @@ -49237,22 +49429,22 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig": { - "description": "The configuration for routing the request to a specific model.", + "description": "The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name.", "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", "properties": { "autoMode": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode", - "description": "Automated routing." + "description": "In this mode, the model is selected automatically based on the content of the request." }, "manualMode": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode", - "description": "Manual routing." + "description": "In this mode, the model is specified manually." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode": { - "description": "When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.", + "description": "The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.", "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode", "properties": { "modelRoutingPreference": { @@ -49265,9 +49457,9 @@ ], "enumDescriptions": [ "Unspecified model routing preference.", - "Prefer higher quality over low cost.", - "Balanced model routing preference.", - "Prefer lower cost over higher quality." + "The model will be selected to prioritize the quality of the response.", + "The model will be selected to balance quality and cost.", + "The model will be selected to prioritize the cost of the request." ], "type": "string" } @@ -49275,26 +49467,26 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode": { - "description": "When manual routing is set, the specified model will be used directly.", + "description": "The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided.", "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode", "properties": { "modelName": { - "description": "The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).", + "description": "The name of the model to use. Only public LLM models are accepted.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig": { - "description": "Config for thinking features.", + "description": "Configuration for the model's thinking features. \"Thinking\" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response.", "id": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", "properties": { "includeThoughts": { - "description": "Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.", + "description": "Optional. If true, the model will include its thoughts in the response. \"Thoughts\" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.", "type": "boolean" }, "thinkingBudget": { - "description": "Optional. Indicates the thinking budget in tokens.", + "description": "Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.", "format": "int32", "type": "integer" } @@ -49467,57 +49659,57 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunk": { - "description": "Grounding chunk.", + "description": "A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.", "id": "GoogleCloudAiplatformV1beta1GroundingChunk", "properties": { "maps": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMaps", - "description": "Grounding chunk from Google Maps." + "description": "A grounding chunk from Google Maps. See the `Maps` message for details." }, "retrievedContext": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext", - "description": "Grounding chunk from context retrieved by the retrieval tools." + "description": "A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details" }, "web": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkWeb", - "description": "Grounding chunk from the web." + "description": "A grounding chunk from a web page, typically from Google Search. See the `Web` message for details." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkMaps": { - "description": "Chunk from Google Maps.", + "description": "A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMaps", "properties": { "placeAnswerSources": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources", - "description": "Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content." + "description": "The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content." }, "placeId": { - "description": "This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.", + "description": "This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.", "type": "string" }, "text": { - "description": "Text of the place answer.", + "description": "The text of the place answer.", "type": "string" }, "title": { - "description": "Title of the place.", + "description": "The title of the place.", "type": "string" }, "uri": { - "description": "URI reference of the place.", + "description": "The URI of the place.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources": { - "description": "Sources used to generate the place answer.", + "description": "The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources", "properties": { "reviewSnippets": { - "description": "Snippets of reviews that are used to generate the answer.", + "description": "Snippets of reviews that were used to generate the answer.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet" }, @@ -49527,7 +49719,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": { - "description": "Encapsulates a review snippet.", + "description": "A review snippet that is used to generate the answer.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet", "properties": { "googleMapsUri": { @@ -49535,81 +49727,81 @@ "type": "string" }, "reviewId": { - "description": "Id of the review referencing the place.", + "description": "The ID of the review that is being referenced.", "type": "string" }, "title": { - "description": "Title of the review.", + "description": "The title of the review.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext": { - "description": "Chunk from context retrieved by the retrieval tools.", + "description": "Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext", "properties": { "documentName": { - "description": "Output only. The full document name for the referenced Vertex AI Search document.", + "description": "Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.", "readOnly": true, "type": "string" }, "ragChunk": { "$ref": "GoogleCloudAiplatformV1beta1RagChunk", - "description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool." + "description": "Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used." }, "text": { - "description": "Text of the attribution.", + "description": "The content of the retrieved data source.", "type": "string" }, "title": { - "description": "Title of the attribution.", + "description": "The title of the retrieved data source.", "type": "string" }, "uri": { - "description": "URI reference of the attribution.", + "description": "The URI of the retrieved data source.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkWeb": { - "description": "Chunk from the web.", + "description": "A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkWeb", "properties": { "domain": { - "description": "Domain of the (original) URI.", + "description": "The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.", "type": "string" }, "title": { - "description": "Title of the chunk.", + "description": "The title of the web page that contains the evidence.", "type": "string" }, "uri": { - "description": "URI reference of the chunk.", + "description": "The URI of the web page that contains the evidence.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingMetadata": { - "description": "Metadata returned to client when grounding is enabled.", + "description": "Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources.", "id": "GoogleCloudAiplatformV1beta1GroundingMetadata", "properties": { "googleMapsWidgetContextToken": { - "description": "Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.", + "description": "Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.", "readOnly": true, "type": "string" }, "groundingChunks": { - "description": "List of supporting references retrieved from specified grounding source.", + "description": "A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunk" }, "type": "array" }, "groundingSupports": { - "description": "Optional. List of grounding support.", + "description": "Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GroundingSupport" }, @@ -49617,11 +49809,11 @@ }, "retrievalMetadata": { "$ref": "GoogleCloudAiplatformV1beta1RetrievalMetadata", - "description": "Optional. Output only. Retrieval metadata.", + "description": "Optional. Output only. Metadata related to the retrieval grounding source.", "readOnly": true }, "retrievalQueries": { - "description": "Optional. Queries executed by the retrieval tools.", + "description": "Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.", "items": { "type": "string" }, @@ -49629,10 +49821,10 @@ }, "searchEntryPoint": { "$ref": "GoogleCloudAiplatformV1beta1SearchEntryPoint", - "description": "Optional. Google search entry for the following-up web searches." + "description": "Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search." }, "sourceFlaggingUris": { - "description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.", + "description": "Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri" }, @@ -49640,7 +49832,7 @@ "type": "array" }, "webSearchQueries": { - "description": "Optional. Web search queries for the following-up web search.", + "description": "Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.", "items": { "type": "string" }, @@ -49650,26 +49842,26 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri": { - "description": "Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.", + "description": "A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.", "id": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri", "properties": { "flagContentUri": { - "description": "A link where users can flag a problem with the source (place or review).", + "description": "The URI that can be used to flag the content.", "type": "string" }, "sourceId": { - "description": "Id of the place or review.", + "description": "The ID of the place or review.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingSupport": { - "description": "Grounding support.", + "description": "A collection of supporting references for a segment of the model's response.", "id": "GoogleCloudAiplatformV1beta1GroundingSupport", "properties": { "confidenceScores": { - "description": "Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.", + "description": "The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.", "items": { "format": "float", "type": "number" @@ -49677,7 +49869,7 @@ "type": "array" }, "groundingChunkIndices": { - "description": "A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.", + "description": "A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.", "items": { "format": "int32", "type": "integer" @@ -49686,7 +49878,7 @@ }, "segment": { "$ref": "GoogleCloudAiplatformV1beta1Segment", - "description": "Segment of the content this support belongs to." + "description": "The content segment that this support message applies to." } }, "type": "object" @@ -49836,7 +50028,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1ImageConfig": { - "description": "Config for image generation features.", + "description": "Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people.", "id": "GoogleCloudAiplatformV1beta1ImageConfig", "properties": { "aspectRatio": { @@ -49856,10 +50048,10 @@ "ALLOW_NONE" ], "enumDescriptions": [ - "Generation images of people unspecified.", - "Generate images that include adults and children.", - "Generate images of adults, but not children.", - "Block generation of images of people." + "The default behavior is unspecified. The model will decide whether to generate images of people.", + "Allows the model to generate images of people, including adults and children.", + "Allows the model to generate images of adults, but not children.", + "Prevents the model from generating images of people." ], "type": "string" } @@ -52227,18 +52419,18 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1LogprobsResult": { - "description": "Logprobs Result", + "description": "The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is \"hallucinating\" or generating factually incorrect information.", "id": "GoogleCloudAiplatformV1beta1LogprobsResult", "properties": { "chosenCandidates": { - "description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.", + "description": "A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`.", "items": { "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate" }, "type": "array" }, "topCandidates": { - "description": "Length = total number of decoding steps.", + "description": "A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps.", "items": { "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates" }, @@ -52248,20 +52440,20 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1LogprobsResultCandidate": { - "description": "Candidate for the logprobs token and score.", + "description": "A single token and its associated log probability.", "id": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate", "properties": { "logProbability": { - "description": "The candidate's log probability.", + "description": "The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.", "format": "float", "type": "number" }, "token": { - "description": "The candidate's token string value.", + "description": "The token's string representation.", "type": "string" }, "tokenId": { - "description": "The candidate's token id value.", + "description": "The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary.", "format": "int32", "type": "integer" } @@ -52269,11 +52461,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates": { - "description": "Candidates with top log probabilities at each decoding step.", + "description": "A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.", "id": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates", "properties": { "candidates": { - "description": "Sorted by log probability in descending order.", + "description": "The list of candidate tokens, sorted by log probability in descending order.", "items": { "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate" }, @@ -52513,6 +52705,13 @@ "format": "google-datetime", "type": "string" }, + "revisionLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Input only. The labels to apply to the Memory Revision created as a result of this request.", + "type": "object" + }, "revisionTtl": { "description": "Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL.", "format": "google-duration", @@ -52943,6 +53142,10 @@ "$ref": "GoogleCloudAiplatformV1beta1BleuSpec", "description": "Spec for bleu metric." }, + "customCodeExecutionSpec": { + "$ref": "GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec", + "description": "Spec for Custom Code Execution metric." + }, "exactMatchSpec": { "$ref": "GoogleCloudAiplatformV1beta1ExactMatchSpec", "description": "Spec for exact match metric." @@ -53325,11 +53528,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1ModalityTokenCount": { - "description": "Represents token counting info for a single modality.", + "description": "Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.", "id": "GoogleCloudAiplatformV1beta1ModalityTokenCount", "properties": { "modality": { - "description": "The modality associated with this token count.", + "description": "The modality that this token count applies to.", "enum": [ "MODALITY_UNSPECIFIED", "TEXT", @@ -53339,17 +53542,17 @@ "DOCUMENT" ], "enumDescriptions": [ - "Unspecified modality.", - "Plain text.", - "Image.", - "Video.", - "Audio.", - "Document, e.g. PDF." + "When a modality is not specified, it is treated as `TEXT`.", + "The `Part` contains plain text.", + "The `Part` contains an image.", + "The `Part` contains a video.", + "The `Part` contains audio.", + "The `Part` contains a document, such as a PDF." ], "type": "string" }, "tokenCount": { - "description": "Number of tokens.", + "description": "The number of tokens counted for this modality.", "format": "int32", "type": "integer" } @@ -53553,15 +53756,15 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1ModelArmorConfig": { - "description": "Configuration for Model Armor integrations of prompt and responses.", + "description": "Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks.", "id": "GoogleCloudAiplatformV1beta1ModelArmorConfig", "properties": { "promptTemplateName": { - "description": "Optional. The name of the Model Armor template to use for prompt sanitization.", + "description": "Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.", "type": "string" }, "responseTemplateName": { - "description": "Optional. The name of the Model Armor template to use for response sanitization.", + "description": "Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.", "type": "string" } }, @@ -55326,7 +55529,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig": { - "description": "Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request.", + "description": "Configuration for a multi-speaker text-to-speech request.", "id": "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig", "properties": { "speakerVoiceConfigs": { @@ -57122,39 +57325,39 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Part": { - "description": "A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", + "description": "A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", "id": "GoogleCloudAiplatformV1beta1Part", "properties": { "codeExecutionResult": { "$ref": "GoogleCloudAiplatformV1beta1CodeExecutionResult", - "description": "Optional. Result of executing the [ExecutableCode]." + "description": "Optional. The result of executing the ExecutableCode." }, "executableCode": { "$ref": "GoogleCloudAiplatformV1beta1ExecutableCode", - "description": "Optional. Code generated by the model that is meant to be executed." + "description": "Optional. Code generated by the model that is intended to be executed." }, "fileData": { "$ref": "GoogleCloudAiplatformV1beta1FileData", - "description": "Optional. URI based data." + "description": "Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage." }, "functionCall": { "$ref": "GoogleCloudAiplatformV1beta1FunctionCall", - "description": "Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values." + "description": "Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function." }, "functionResponse": { "$ref": "GoogleCloudAiplatformV1beta1FunctionResponse", - "description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model." + "description": "Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted." }, "inlineData": { "$ref": "GoogleCloudAiplatformV1beta1Blob", - "description": "Optional. Inlined bytes data." + "description": "Optional. The inline data content of the part. This can be used to include images, audio, or video in a request." }, "text": { - "description": "Optional. Text part (can be code).", + "description": "Optional. The text content of the part.", "type": "string" }, "thought": { - "description": "Optional. Indicates if the part is thought from the model.", + "description": "Optional. Indicates whether the `part` represents the model's thought process or reasoning.", "type": "boolean" }, "thoughtSignature": { @@ -58076,11 +58279,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig": { - "description": "The configuration for the prebuilt speaker to use.", + "description": "Configuration for a prebuilt voice.", "id": "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig", "properties": { "voiceName": { - "description": "The name of the preset voice to use.", + "description": "The name of the prebuilt voice to use.", "type": "string" } }, @@ -59814,6 +60017,16 @@ "deprecated": true, "description": "Optional. Immutable. The Vector DB config of the RagCorpus." }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this RagCorpus was last updated.", "format": "google-datetime", @@ -60974,6 +61187,14 @@ "description": "ReasoningEngine configurations", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpec", "properties": { + "agentCard": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The A2A Agent Card for the agent (if available). It follows the specification at https://a2a-protocol.org/latest/specification/#5-agent-discovery-the-agent-card.", + "type": "object" + }, "agentFramework": { "description": "Optional. The OSS agent framework used to develop the agent. Currently supported values: \"google-adk\", \"langchain\", \"langgraph\", \"ag2\", \"llama-index\", \"custom\".", "type": "string" @@ -61082,7 +61303,7 @@ "type": "string" }, "pythonVersion": { - "description": "Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10.", + "description": "Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10.", "type": "string" }, "requirementsGcsUri": { @@ -61650,11 +61871,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1RetrievalMetadata": { - "description": "Metadata related to retrieval in the grounding flow.", + "description": "Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled.", "id": "GoogleCloudAiplatformV1beta1RetrievalMetadata", "properties": { "googleSearchDynamicRetrievalScore": { - "description": "Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.", + "description": "Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.", "format": "float", "type": "number" } @@ -62281,16 +62502,16 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1SafetyRating": { - "description": "Safety rating corresponding to the generated content.", + "description": "A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.", "id": "GoogleCloudAiplatformV1beta1SafetyRating", "properties": { "blocked": { - "description": "Output only. Indicates whether the content was filtered out because of this rating.", + "description": "Output only. Indicates whether the content was blocked because of this rating.", "readOnly": true, "type": "boolean" }, "category": { - "description": "Output only. Harm category.", + "description": "Output only. The harm category of this rating.", "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", @@ -62318,17 +62539,17 @@ false ], "enumDescriptions": [ - "The harm category is unspecified.", - "The harm category is hate speech.", - "The harm category is dangerous content.", - "The harm category is harassment.", - "The harm category is sexually explicit content.", + "Default value. This value is unused.", + "Content that promotes violence or incites hatred against individuals or groups based on certain attributes.", + "Content that promotes, facilitates, or enables dangerous activities.", + "Abusive, threatening, or content intended to bully, torment, or ridicule.", + "Content that contains sexually explicit material.", "Deprecated: Election filter is not longer supported. The harm category is civic integrity.", - "The harm category is image hate.", - "The harm category is image dangerous content.", - "The harm category is image harassment.", - "The harm category is image sexually explicit content.", - "The harm category is for jailbreak prompts." + "Images that contain hate speech.", + "Images that contain dangerous content.", + "Images that contain harassment.", + "Images that contain sexually explicit content.", + "Prompts designed to bypass safety filters." ], "readOnly": true, "type": "string" @@ -62344,18 +62565,18 @@ "OFF" ], "enumDescriptions": [ - "Unspecified harm block threshold.", - "Block low threshold and above (i.e. block more).", - "Block medium threshold and above.", - "Block only high threshold (i.e. block less).", - "Block none.", - "Turn off the safety filter." + "The harm block threshold is unspecified.", + "Block content with a low harm probability or higher.", + "Block content with a medium harm probability or higher.", + "Block content with a high harm probability.", + "Do not block any content, regardless of its harm probability.", + "Turn off the safety filter entirely." ], "readOnly": true, "type": "string" }, "probability": { - "description": "Output only. Harm probability levels in the content.", + "description": "Output only. The probability of harm for this category.", "enum": [ "HARM_PROBABILITY_UNSPECIFIED", "NEGLIGIBLE", @@ -62364,23 +62585,23 @@ "HIGH" ], "enumDescriptions": [ - "Harm probability unspecified.", - "Negligible level of harm.", - "Low level of harm.", - "Medium level of harm.", - "High level of harm." + "The harm probability is unspecified.", + "The harm probability is negligible.", + "The harm probability is low.", + "The harm probability is medium.", + "The harm probability is high." ], "readOnly": true, "type": "string" }, "probabilityScore": { - "description": "Output only. Harm probability score.", + "description": "Output only. The probability score of harm for this category.", "format": "float", "readOnly": true, "type": "number" }, "severity": { - "description": "Output only. Harm severity levels in the content.", + "description": "Output only. The severity of harm for this category.", "enum": [ "HARM_SEVERITY_UNSPECIFIED", "HARM_SEVERITY_NEGLIGIBLE", @@ -62389,17 +62610,17 @@ "HARM_SEVERITY_HIGH" ], "enumDescriptions": [ - "Harm severity unspecified.", - "Negligible level of harm severity.", - "Low level of harm severity.", - "Medium level of harm severity.", - "High level of harm severity." + "The harm severity is unspecified.", + "The harm severity is negligible.", + "The harm severity is low.", + "The harm severity is medium.", + "The harm severity is high." ], "readOnly": true, "type": "string" }, "severityScore": { - "description": "Output only. Harm severity score.", + "description": "Output only. The severity score of harm for this category.", "format": "float", "readOnly": true, "type": "number" @@ -62432,11 +62653,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1SafetySetting": { - "description": "Safety settings.", + "description": "A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.", "id": "GoogleCloudAiplatformV1beta1SafetySetting", "properties": { "category": { - "description": "Required. Harm category.", + "description": "Required. The harm category to be blocked.", "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", @@ -62464,22 +62685,22 @@ false ], "enumDescriptions": [ - "The harm category is unspecified.", - "The harm category is hate speech.", - "The harm category is dangerous content.", - "The harm category is harassment.", - "The harm category is sexually explicit content.", + "Default value. This value is unused.", + "Content that promotes violence or incites hatred against individuals or groups based on certain attributes.", + "Content that promotes, facilitates, or enables dangerous activities.", + "Abusive, threatening, or content intended to bully, torment, or ridicule.", + "Content that contains sexually explicit material.", "Deprecated: Election filter is not longer supported. The harm category is civic integrity.", - "The harm category is image hate.", - "The harm category is image dangerous content.", - "The harm category is image harassment.", - "The harm category is image sexually explicit content.", - "The harm category is for jailbreak prompts." + "Images that contain hate speech.", + "Images that contain dangerous content.", + "Images that contain harassment.", + "Images that contain sexually explicit content.", + "Prompts designed to bypass safety filters." ], "type": "string" }, "method": { - "description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.", + "description": "Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.", "enum": [ "HARM_BLOCK_METHOD_UNSPECIFIED", "SEVERITY", @@ -62493,7 +62714,7 @@ "type": "string" }, "threshold": { - "description": "Required. The harm block threshold.", + "description": "Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.", "enum": [ "HARM_BLOCK_THRESHOLD_UNSPECIFIED", "BLOCK_LOW_AND_ABOVE", @@ -62503,12 +62724,12 @@ "OFF" ], "enumDescriptions": [ - "Unspecified harm block threshold.", - "Block low threshold and above (i.e. block more).", - "Block medium threshold and above.", - "Block only high threshold (i.e. block less).", - "Block none.", - "Turn off the safety filter." + "The harm block threshold is unspecified.", + "Block content with a low harm probability or higher.", + "Block content with a medium harm probability or higher.", + "Block content with a high harm probability.", + "Do not block any content, regardless of its harm probability.", + "Turn off the safety filter entirely." ], "type": "string" } @@ -67271,15 +67492,15 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1SearchEntryPoint": { - "description": "Google search entry point.", + "description": "An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application.", "id": "GoogleCloudAiplatformV1beta1SearchEntryPoint", "properties": { "renderedContent": { - "description": "Optional. Web content snippet that can be embedded in a web page or an app webview.", + "description": "Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.", "type": "string" }, "sdkBlob": { - "description": "Optional. Base64 encoded JSON representing array of tuple.", + "description": "Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.", "format": "byte", "type": "string" } @@ -67668,29 +67889,29 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Segment": { - "description": "Segment of the content.", + "description": "A segment of the content.", "id": "GoogleCloudAiplatformV1beta1Segment", "properties": { "endIndex": { - "description": "Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.", + "description": "Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.", "format": "int32", "readOnly": true, "type": "integer" }, "partIndex": { - "description": "Output only. The index of a Part object within its parent Content object.", + "description": "Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.", "format": "int32", "readOnly": true, "type": "integer" }, "startIndex": { - "description": "Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.", + "description": "Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.", "format": "int32", "readOnly": true, "type": "integer" }, "text": { - "description": "Output only. The text corresponding to the segment from the response.", + "description": "Output only. The text of the segment.", "readOnly": true, "type": "string" } @@ -67960,7 +68181,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1SpeakerVoiceConfig": { - "description": "Configuration for a single speaker in a multi speaker setup.", + "description": "Configuration for a single speaker in a multi-speaker setup.", "id": "GoogleCloudAiplatformV1beta1SpeakerVoiceConfig", "properties": { "speaker": { @@ -68061,11 +68282,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1SpeechConfig": { - "description": "The speech generation config.", + "description": "Configuration for speech generation.", "id": "GoogleCloudAiplatformV1beta1SpeechConfig", "properties": { "languageCode": { - "description": "Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.", + "description": "Optional. The language code (ISO 639-1) for the speech synthesis.", "type": "string" }, "multiSpeakerVoiceConfig": { @@ -68074,7 +68295,7 @@ }, "voiceConfig": { "$ref": "GoogleCloudAiplatformV1beta1VoiceConfig", - "description": "The configuration for the speaker to use." + "description": "The configuration for the voice to use." } }, "type": "object" @@ -72096,11 +72317,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1UrlContextMetadata": { - "description": "Metadata related to url context retrieval tool.", + "description": "Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.", "id": "GoogleCloudAiplatformV1beta1UrlContextMetadata", "properties": { "urlMetadata": { - "description": "Output only. List of url context.", + "description": "Output only. A list of URL metadata, with one entry for each URL retrieved by the tool.", "items": { "$ref": "GoogleCloudAiplatformV1beta1UrlMetadata" }, @@ -72111,15 +72332,15 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1UrlMetadata": { - "description": "Context of the a single url retrieval.", + "description": "The metadata for a single URL retrieval.", "id": "GoogleCloudAiplatformV1beta1UrlMetadata", "properties": { "retrievedUrl": { - "description": "Retrieved url by the tool.", + "description": "The URL retrieved by the tool.", "type": "string" }, "urlRetrievalStatus": { - "description": "Status of the url retrieval.", + "description": "The status of the URL retrieval.", "enum": [ "URL_RETRIEVAL_STATUS_UNSPECIFIED", "URL_RETRIEVAL_STATUS_SUCCESS", @@ -72127,8 +72348,8 @@ ], "enumDescriptions": [ "Default value. This value is unused.", - "Url retrieval is successful.", - "Url retrieval is failed due to error." + "The URL was retrieved successfully.", + "The URL retrieval failed." ], "type": "string" } @@ -72432,7 +72653,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1VideoMetadata": { - "description": "Metadata describes the input video content.", + "description": "Provides metadata for a video, including the start and end offsets for clipping and the frame rate.", "id": "GoogleCloudAiplatformV1beta1VideoMetadata", "properties": { "endOffset": { @@ -72441,7 +72662,7 @@ "type": "string" }, "fps": { - "description": "Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].", + "description": "Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].", "format": "double", "type": "number" }, @@ -72454,12 +72675,12 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1VoiceConfig": { - "description": "The configuration for the voice to use.", + "description": "Configuration for a voice.", "id": "GoogleCloudAiplatformV1beta1VoiceConfig", "properties": { "prebuiltVoiceConfig": { "$ref": "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig", - "description": "The configuration for the prebuilt voice to use." + "description": "The configuration for a prebuilt voice." } }, "type": "object" diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index a571956125d..42a330684da 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -1499,15 +1499,15 @@ export namespace aiplatform_v1 { useEffectiveOrder?: boolean | null; } /** - * Content blob. + * A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. */ export interface Schema$GoogleCloudAiplatformV1Blob { /** - * Required. Raw bytes. + * Required. The raw bytes of the data. */ data?: string | null; /** - * Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + * Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. */ displayName?: string | null; /** @@ -1669,43 +1669,43 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1Candidate { /** - * Output only. Average log probability score of the candidate. + * Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. */ avgLogprobs?: number | null; /** - * Output only. Source attribution of the generated content. + * Output only. A collection of citations that apply to the generated content. */ citationMetadata?: Schema$GoogleCloudAiplatformV1CitationMetadata; /** - * Output only. Content parts of the candidate. + * Output only. The content of the candidate. */ content?: Schema$GoogleCloudAiplatformV1Content; /** - * Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. + * Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. */ finishMessage?: string | null; /** - * Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. + * Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. */ finishReason?: string | null; /** - * Output only. Metadata specifies sources used to ground generated content. + * Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. */ groundingMetadata?: Schema$GoogleCloudAiplatformV1GroundingMetadata; /** - * Output only. Index of the candidate. + * Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` \> 1. */ index?: number | null; /** - * Output only. Log-likelihood scores for the response tokens and top tokens + * Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". */ logprobsResult?: Schema$GoogleCloudAiplatformV1LogprobsResult; /** - * Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. + * Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. */ safetyRatings?: Schema$GoogleCloudAiplatformV1SafetyRating[]; /** - * Output only. Metadata related to url context retrieval tool. + * Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */ urlContextMetadata?: Schema$GoogleCloudAiplatformV1UrlContextMetadata; } @@ -1803,40 +1803,40 @@ export namespace aiplatform_v1 { shouldStop?: boolean | null; } /** - * Source attributions for content. + * A citation for a piece of generatedcontent. */ export interface Schema$GoogleCloudAiplatformV1Citation { /** - * Output only. End index into the content. + * Output only. The end index of the citation in the content. */ endIndex?: number | null; /** - * Output only. License of the attribution. + * Output only. The license of the source of the citation. */ license?: string | null; /** - * Output only. Publication date of the attribution. + * Output only. The publication date of the source of the citation. */ publicationDate?: Schema$GoogleTypeDate; /** - * Output only. Start index into the content. + * Output only. The start index of the citation in the content. */ startIndex?: number | null; /** - * Output only. Title of the attribution. + * Output only. The title of the source of the citation. */ title?: string | null; /** - * Output only. Url reference of the attribution. + * Output only. The URI of the source of the citation. */ uri?: string | null; } /** - * A collection of source attributions for a piece of content. + * A collection of citations that apply to a piece of generated content. */ export interface Schema$GoogleCloudAiplatformV1CitationMetadata { /** - * Output only. List of citations. + * Output only. A list of citations for the content. */ citations?: Schema$GoogleCloudAiplatformV1Citation[]; } @@ -2095,15 +2095,15 @@ export namespace aiplatform_v1 { imageUri?: string | null; } /** - * The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. + * The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. */ export interface Schema$GoogleCloudAiplatformV1Content { /** - * Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. + * Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. */ parts?: Schema$GoogleCloudAiplatformV1Part[]; /** - * Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + * Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. */ role?: string | null; } @@ -2620,6 +2620,15 @@ export namespace aiplatform_v1 { */ gcsSource?: Schema$GoogleCloudAiplatformV1GcsSource; } + /** + * Specificies a metric that is populated by evaluating user-defined Python code. + */ + export interface Schema$GoogleCloudAiplatformV1CustomCodeExecutionSpec { + /** + * Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -\> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'\}, 'reference': {'text': '4'\} \} ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -\> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` + */ + evaluationFunction?: string | null; + } /** * Represents a job that runs custom workloads such as a Docker container or a Python package. A CustomJob can have multiple worker pools and each worker pool can have its own machine and input spec. A CustomJob will be cleaned up once the job enters terminal state (failed or succeeded). */ @@ -2964,6 +2973,60 @@ export namespace aiplatform_v1 { */ updateTime?: string | null; } + /** + * Distribution computed over a tuning dataset. + */ + export interface Schema$GoogleCloudAiplatformV1DatasetDistribution { + /** + * Output only. Defines the histogram bucket. + */ + buckets?: Schema$GoogleCloudAiplatformV1DatasetDistributionDistributionBucket[]; + /** + * Output only. The maximum of the population values. + */ + max?: number | null; + /** + * Output only. The arithmetic mean of the values in the population. + */ + mean?: number | null; + /** + * Output only. The median of the values in the population. + */ + median?: number | null; + /** + * Output only. The minimum of the population values. + */ + min?: number | null; + /** + * Output only. The 5th percentile of the values in the population. + */ + p5?: number | null; + /** + * Output only. The 95th percentile of the values in the population. + */ + p95?: number | null; + /** + * Output only. Sum of a given population of values. + */ + sum?: number | null; + } + /** + * Dataset bucket used to create a histogram for the distribution given a population of values. + */ + export interface Schema$GoogleCloudAiplatformV1DatasetDistributionDistributionBucket { + /** + * Output only. Number of values in the bucket. + */ + count?: string | null; + /** + * Output only. Left bound of the bucket. + */ + left?: number | null; + /** + * Output only. Right bound of the bucket. + */ + right?: number | null; + } /** * Describes the dataset version. */ @@ -6730,15 +6793,15 @@ export namespace aiplatform_v1 { operationName?: string | null; } /** - * URI based data. + * URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. */ export interface Schema$GoogleCloudAiplatformV1FileData { /** - * Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + * Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. */ displayName?: string | null; /** - * Required. URI. + * Required. The URI of the file in Google Cloud Storage. */ fileUri?: string | null; /** @@ -7133,6 +7196,32 @@ export namespace aiplatform_v1 { */ zone?: string | null; } + /** + * Input example for preference optimization. + */ + export interface Schema$GoogleCloudAiplatformV1GeminiPreferenceExample { + /** + * List of completions for a given prompt. + */ + completions?: Schema$GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion[]; + /** + * Multi-turn contents that represents the Prompt. + */ + contents?: Schema$GoogleCloudAiplatformV1Content[]; + } + /** + * Completion and its preference score. + */ + export interface Schema$GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion { + /** + * Single turn completion for the given prompt. + */ + completion?: Schema$GoogleCloudAiplatformV1Content; + /** + * The score for the given completion. + */ + score?: number | null; + } /** * Configuration for GenAiAdvancedFeatures. */ @@ -7403,23 +7492,23 @@ export namespace aiplatform_v1 { mimeType?: string | null; } /** - * Generation config. + * Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. */ export interface Schema$GoogleCloudAiplatformV1GenerationConfig { /** - * Optional. If enabled, audio timestamp will be included in the request to the model. + * Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. */ audioTimestamp?: boolean | null; /** - * Optional. Number of candidates to generate. + * Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. */ candidateCount?: number | null; /** - * Optional. If enabled, the model will detect emotions and adapt its responses accordingly. + * Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. */ enableAffectiveDialog?: boolean | null; /** - * Optional. Frequency penalties. + * Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. */ frequencyPenalty?: number | null; /** @@ -7427,39 +7516,39 @@ export namespace aiplatform_v1 { */ imageConfig?: Schema$GoogleCloudAiplatformV1ImageConfig; /** - * Optional. Logit probabilities. + * Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. */ logprobs?: number | null; /** - * Optional. The maximum number of output tokens to generate per message. + * Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. */ maxOutputTokens?: number | null; /** - * Optional. If specified, the media resolution specified will be used. + * Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. */ mediaResolution?: string | null; /** - * Optional. Positive penalties. + * Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. */ presencePenalty?: number | null; /** - * Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. + * Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. */ responseJsonSchema?: any | null; /** - * Optional. If true, export the logprobs results in response. + * Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. */ responseLogprobs?: boolean | null; /** - * Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + * Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. */ responseMimeType?: string | null; /** - * Optional. The modalities of the response. + * Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. */ responseModalities?: string[] | null; /** - * Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + * Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. */ responseSchema?: Schema$GoogleCloudAiplatformV1Schema; /** @@ -7467,7 +7556,7 @@ export namespace aiplatform_v1 { */ routingConfig?: Schema$GoogleCloudAiplatformV1GenerationConfigRoutingConfig; /** - * Optional. Seed. + * Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. */ seed?: number | null; /** @@ -7475,41 +7564,41 @@ export namespace aiplatform_v1 { */ speechConfig?: Schema$GoogleCloudAiplatformV1SpeechConfig; /** - * Optional. Stop sequences. + * Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. */ stopSequences?: string[] | null; /** - * Optional. Controls the randomness of predictions. + * Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. */ temperature?: number | null; /** - * Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. + * Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. */ thinkingConfig?: Schema$GoogleCloudAiplatformV1GenerationConfigThinkingConfig; /** - * Optional. If specified, top-k sampling will be used. + * Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. */ topK?: number | null; /** - * Optional. If specified, nucleus sampling will be used. + * Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. */ topP?: number | null; } /** - * The configuration for routing the request to a specific model. + * The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. */ export interface Schema$GoogleCloudAiplatformV1GenerationConfigRoutingConfig { /** - * Automated routing. + * In this mode, the model is selected automatically based on the content of the request. */ autoMode?: Schema$GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode; /** - * Manual routing. + * In this mode, the model is specified manually. */ manualMode?: Schema$GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode; } /** - * When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. + * The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. */ export interface Schema$GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode { /** @@ -7518,24 +7607,24 @@ export namespace aiplatform_v1 { modelRoutingPreference?: string | null; } /** - * When manual routing is set, the specified model will be used directly. + * The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. */ export interface Schema$GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode { /** - * The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + * The name of the model to use. Only public LLM models are accepted. */ modelName?: string | null; } /** - * Config for thinking features. + * Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. */ export interface Schema$GoogleCloudAiplatformV1GenerationConfigThinkingConfig { /** - * Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. + * Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. */ includeThoughts?: boolean | null; /** - * Optional. Indicates the thinking budget in tokens. + * Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. */ thinkingBudget?: number | null; } @@ -7658,58 +7747,58 @@ export namespace aiplatform_v1 { version?: number | null; } /** - * Grounding chunk. + * A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. */ export interface Schema$GoogleCloudAiplatformV1GroundingChunk { /** - * Grounding chunk from Google Maps. + * A grounding chunk from Google Maps. See the `Maps` message for details. */ maps?: Schema$GoogleCloudAiplatformV1GroundingChunkMaps; /** - * Grounding chunk from context retrieved by the retrieval tools. + * A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details */ retrievedContext?: Schema$GoogleCloudAiplatformV1GroundingChunkRetrievedContext; /** - * Grounding chunk from the web. + * A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. */ web?: Schema$GoogleCloudAiplatformV1GroundingChunkWeb; } /** - * Chunk from Google Maps. + * A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. */ export interface Schema$GoogleCloudAiplatformV1GroundingChunkMaps { /** - * Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. + * The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. */ placeAnswerSources?: Schema$GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources; /** - * This Place's resource name, in `places/{place_id\}` format. Can be used to look up the Place. + * This Place's resource name, in `places/{place_id\}` format. This can be used to look up the place in the Google Maps API. */ placeId?: string | null; /** - * Text of the place answer. + * The text of the place answer. */ text?: string | null; /** - * Title of the place. + * The title of the place. */ title?: string | null; /** - * URI reference of the place. + * The URI of the place. */ uri?: string | null; } /** - * Sources used to generate the place answer. + * The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. */ export interface Schema$GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources { /** - * Snippets of reviews that are used to generate the answer. + * Snippets of reviews that were used to generate the answer. */ reviewSnippets?: Schema$GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[]; } /** - * Encapsulates a review snippet. + * A review snippet that is used to generate the answer. */ export interface Schema$GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet { /** @@ -7717,116 +7806,116 @@ export namespace aiplatform_v1 { */ googleMapsUri?: string | null; /** - * Id of the review referencing the place. + * The ID of the review that is being referenced. */ reviewId?: string | null; /** - * Title of the review. + * The title of the review. */ title?: string | null; } /** - * Chunk from context retrieved by the retrieval tools. + * Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. */ export interface Schema$GoogleCloudAiplatformV1GroundingChunkRetrievedContext { /** - * Output only. The full document name for the referenced Vertex AI Search document. + * Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. */ documentName?: string | null; /** - * Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + * Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. */ ragChunk?: Schema$GoogleCloudAiplatformV1RagChunk; /** - * Text of the attribution. + * The content of the retrieved data source. */ text?: string | null; /** - * Title of the attribution. + * The title of the retrieved data source. */ title?: string | null; /** - * URI reference of the attribution. + * The URI of the retrieved data source. */ uri?: string | null; } /** - * Chunk from the web. + * A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. */ export interface Schema$GoogleCloudAiplatformV1GroundingChunkWeb { /** - * Domain of the (original) URI. + * The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. */ domain?: string | null; /** - * Title of the chunk. + * The title of the web page that contains the evidence. */ title?: string | null; /** - * URI reference of the chunk. + * The URI of the web page that contains the evidence. */ uri?: string | null; } /** - * Metadata returned to client when grounding is enabled. + * Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. */ export interface Schema$GoogleCloudAiplatformV1GroundingMetadata { /** - * Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. + * Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. */ googleMapsWidgetContextToken?: string | null; /** - * List of supporting references retrieved from specified grounding source. + * A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. */ groundingChunks?: Schema$GoogleCloudAiplatformV1GroundingChunk[]; /** - * Optional. List of grounding support. + * Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. */ groundingSupports?: Schema$GoogleCloudAiplatformV1GroundingSupport[]; /** - * Optional. Output only. Retrieval metadata. + * Optional. Output only. Metadata related to the retrieval grounding source. */ retrievalMetadata?: Schema$GoogleCloudAiplatformV1RetrievalMetadata; /** - * Optional. Google search entry for the following-up web searches. + * Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. */ searchEntryPoint?: Schema$GoogleCloudAiplatformV1SearchEntryPoint; /** - * Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + * Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. */ sourceFlaggingUris?: Schema$GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri[]; /** - * Optional. Web search queries for the following-up web search. + * Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. */ webSearchQueries?: string[] | null; } /** - * Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + * A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. */ export interface Schema$GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri { /** - * A link where users can flag a problem with the source (place or review). + * The URI that can be used to flag the content. */ flagContentUri?: string | null; /** - * Id of the place or review. + * The ID of the place or review. */ sourceId?: string | null; } /** - * Grounding support. + * A collection of supporting references for a segment of the model's response. */ export interface Schema$GoogleCloudAiplatformV1GroundingSupport { /** - * Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. + * The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. */ confidenceScores?: number[] | null; /** - * A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + * A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. */ groundingChunkIndices?: number[] | null; /** - * Segment of the content this support belongs to. + * The content segment that this support message applies to. */ segment?: Schema$GoogleCloudAiplatformV1Segment; } @@ -7917,7 +8006,7 @@ export namespace aiplatform_v1 { ids?: string[] | null; } /** - * Config for image generation features. + * Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. */ export interface Schema$GoogleCloudAiplatformV1ImageConfig { /** @@ -9343,41 +9432,41 @@ export namespace aiplatform_v1 { systemInstruction?: string | null; } /** - * Logprobs Result + * The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. */ export interface Schema$GoogleCloudAiplatformV1LogprobsResult { /** - * Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. + * A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. */ chosenCandidates?: Schema$GoogleCloudAiplatformV1LogprobsResultCandidate[]; /** - * Length = total number of decoding steps. + * A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. */ topCandidates?: Schema$GoogleCloudAiplatformV1LogprobsResultTopCandidates[]; } /** - * Candidate for the logprobs token and score. + * A single token and its associated log probability. */ export interface Schema$GoogleCloudAiplatformV1LogprobsResultCandidate { /** - * The candidate's log probability. + * The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. */ logProbability?: number | null; /** - * The candidate's token string value. + * The token's string representation. */ token?: string | null; /** - * The candidate's token id value. + * The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. */ tokenId?: number | null; } /** - * Candidates with top log probabilities at each decoding step. + * A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. */ export interface Schema$GoogleCloudAiplatformV1LogprobsResultTopCandidates { /** - * Sorted by log probability in descending order. + * The list of candidate tokens, sorted by log probability in descending order. */ candidates?: Schema$GoogleCloudAiplatformV1LogprobsResultCandidate[]; } @@ -9576,6 +9665,10 @@ export namespace aiplatform_v1 { * Spec for bleu metric. */ bleuSpec?: Schema$GoogleCloudAiplatformV1BleuSpec; + /** + * Spec for Custom Code Execution metric. + */ + customCodeExecutionSpec?: Schema$GoogleCloudAiplatformV1CustomCodeExecutionSpec; /** * Spec for exact match metric. */ @@ -9884,15 +9977,15 @@ export namespace aiplatform_v1 { model?: string | null; } /** - * Represents token counting info for a single modality. + * Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. */ export interface Schema$GoogleCloudAiplatformV1ModalityTokenCount { /** - * The modality associated with this token count. + * The modality that this token count applies to. */ modality?: string | null; /** - * Number of tokens. + * The number of tokens counted for this modality. */ tokenCount?: number | null; } @@ -10042,15 +10135,15 @@ export namespace aiplatform_v1 { versionUpdateTime?: string | null; } /** - * Configuration for Model Armor integrations of prompt and responses. + * Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. */ export interface Schema$GoogleCloudAiplatformV1ModelArmorConfig { /** - * Optional. The name of the Model Armor template to use for prompt sanitization. + * Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project\}/locations/{location\}/templates/{template\}`. */ promptTemplateName?: string | null; /** - * Optional. The name of the Model Armor template to use for response sanitization. + * Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project\}/locations/{location\}/templates/{template\}`. */ responseTemplateName?: string | null; } @@ -10752,7 +10845,7 @@ export namespace aiplatform_v1 { step?: string | null; } /** - * Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. + * Configuration for a multi-speaker text-to-speech request. */ export interface Schema$GoogleCloudAiplatformV1MultiSpeakerVoiceConfig { /** @@ -11909,39 +12002,39 @@ export namespace aiplatform_v1 { version?: number | null; } /** - * A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + * A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. */ export interface Schema$GoogleCloudAiplatformV1Part { /** - * Optional. Result of executing the [ExecutableCode]. + * Optional. The result of executing the ExecutableCode. */ codeExecutionResult?: Schema$GoogleCloudAiplatformV1CodeExecutionResult; /** - * Optional. Code generated by the model that is meant to be executed. + * Optional. Code generated by the model that is intended to be executed. */ executableCode?: Schema$GoogleCloudAiplatformV1ExecutableCode; /** - * Optional. URI based data. + * Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. */ fileData?: Schema$GoogleCloudAiplatformV1FileData; /** - * Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + * Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. */ functionCall?: Schema$GoogleCloudAiplatformV1FunctionCall; /** - * Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + * Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. */ functionResponse?: Schema$GoogleCloudAiplatformV1FunctionResponse; /** - * Optional. Inlined bytes data. + * Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. */ inlineData?: Schema$GoogleCloudAiplatformV1Blob; /** - * Optional. Text part (can be code). + * Optional. The text content of the part. */ text?: string | null; /** - * Optional. Indicates if the part is thought from the model. + * Optional. Indicates whether the `part` represents the model's thought process or reasoning. */ thought?: boolean | null; /** @@ -12429,11 +12522,11 @@ export namespace aiplatform_v1 { postStartupScriptUrl?: string | null; } /** - * The configuration for the prebuilt speaker to use. + * Configuration for a prebuilt voice. */ export interface Schema$GoogleCloudAiplatformV1PrebuiltVoiceConfig { /** - * The name of the preset voice to use. + * The name of the prebuilt voice to use. */ voiceName?: string | null; } @@ -12552,6 +12645,93 @@ export namespace aiplatform_v1 { */ predictionSchemaUri?: string | null; } + /** + * Statistics computed for datasets used for preference optimization. + */ + export interface Schema$GoogleCloudAiplatformV1PreferenceOptimizationDataStats { + /** + * Output only. A partial sample of the indices (starting from 1) of the dropped examples. + */ + droppedExampleIndices?: string[] | null; + /** + * Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. + */ + droppedExampleReasons?: string[] | null; + /** + * Output only. Dataset distributions for scores. + */ + scoresDistribution?: Schema$GoogleCloudAiplatformV1DatasetDistribution; + /** + * Output only. Dataset distributions for scores variance per example. + */ + scoreVariancePerExampleDistribution?: Schema$GoogleCloudAiplatformV1DatasetDistribution; + /** + * Output only. Number of billable tokens in the tuning dataset. + */ + totalBillableTokenCount?: string | null; + /** + * Output only. Number of examples in the tuning dataset. + */ + tuningDatasetExampleCount?: string | null; + /** + * Output only. Number of tuning steps for this Tuning Job. + */ + tuningStepCount?: string | null; + /** + * Output only. Sample user examples in the training dataset. + */ + userDatasetExamples?: Schema$GoogleCloudAiplatformV1GeminiPreferenceExample[]; + /** + * Output only. Dataset distributions for the user input tokens. + */ + userInputTokenDistribution?: Schema$GoogleCloudAiplatformV1DatasetDistribution; + /** + * Output only. Dataset distributions for the user output tokens. + */ + userOutputTokenDistribution?: Schema$GoogleCloudAiplatformV1DatasetDistribution; + } + /** + * Hyperparameters for Preference Optimization. + */ + export interface Schema$GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters { + /** + * Optional. Adapter size for preference optimization. + */ + adapterSize?: string | null; + /** + * Optional. Weight for KL Divergence regularization. + */ + beta?: number | null; + /** + * Optional. Number of complete passes the model makes over the entire training dataset during training. + */ + epochCount?: string | null; + /** + * Optional. Multiplier for adjusting the default learning rate. + */ + learningRateMultiplier?: number | null; + } + /** + * Tuning Spec for Preference Optimization. + */ + export interface Schema$GoogleCloudAiplatformV1PreferenceOptimizationSpec { + /** + * Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false. + */ + exportLastCheckpointOnly?: boolean | null; + /** + * Optional. Hyperparameters for Preference Optimization. + */ + hyperParameters?: Schema$GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters; + /** + * Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. + */ + trainingDatasetUri?: string | null; + /** + * Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. + */ + validationDatasetUri?: string | null; + } /** * Preset configuration for example-based explanations */ @@ -13602,6 +13782,14 @@ export namespace aiplatform_v1 { * Output only. The resource name of the RagCorpus. */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Timestamp when this RagCorpus was last updated. */ @@ -14304,7 +14492,7 @@ export namespace aiplatform_v1 { */ pickleObjectGcsUri?: string | null; /** - * Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. + * Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. */ pythonVersion?: string | null; /** @@ -14566,11 +14754,11 @@ export namespace aiplatform_v1 { latLng?: Schema$GoogleTypeLatLng; } /** - * Metadata related to retrieval in the grounding flow. + * Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. */ export interface Schema$GoogleCloudAiplatformV1RetrievalMetadata { /** - * Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + * Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. */ googleSearchDynamicRetrievalScore?: number | null; } @@ -14852,15 +15040,15 @@ export namespace aiplatform_v1 { prediction?: string | null; } /** - * Safety rating corresponding to the generated content. + * A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. */ export interface Schema$GoogleCloudAiplatformV1SafetyRating { /** - * Output only. Indicates whether the content was filtered out because of this rating. + * Output only. Indicates whether the content was blocked because of this rating. */ blocked?: boolean | null; /** - * Output only. Harm category. + * Output only. The harm category of this rating. */ category?: string | null; /** @@ -14868,19 +15056,19 @@ export namespace aiplatform_v1 { */ overwrittenThreshold?: string | null; /** - * Output only. Harm probability levels in the content. + * Output only. The probability of harm for this category. */ probability?: string | null; /** - * Output only. Harm probability score. + * Output only. The probability score of harm for this category. */ probabilityScore?: number | null; /** - * Output only. Harm severity levels in the content. + * Output only. The severity of harm for this category. */ severity?: string | null; /** - * Output only. Harm severity score. + * Output only. The severity score of harm for this category. */ severityScore?: number | null; } @@ -14902,19 +15090,19 @@ export namespace aiplatform_v1 { score?: number | null; } /** - * Safety settings. + * A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. */ export interface Schema$GoogleCloudAiplatformV1SafetySetting { /** - * Required. Harm category. + * Required. The harm category to be blocked. */ category?: string | null; /** - * Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. + * Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. */ method?: string | null; /** - * Required. The harm block threshold. + * Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. */ threshold?: string | null; } @@ -18118,15 +18306,15 @@ export namespace aiplatform_v1 { nextPageToken?: string | null; } /** - * Google search entry point. + * An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. */ export interface Schema$GoogleCloudAiplatformV1SearchEntryPoint { /** - * Optional. Web content snippet that can be embedded in a web page or an app webview. + * Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. */ renderedContent?: string | null; /** - * Optional. Base64 encoded JSON representing array of tuple. + * Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. */ sdkBlob?: string | null; } @@ -18278,23 +18466,23 @@ export namespace aiplatform_v1 { version?: string | null; } /** - * Segment of the content. + * A segment of the content. */ export interface Schema$GoogleCloudAiplatformV1Segment { /** - * Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. + * Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. */ endIndex?: number | null; /** - * Output only. The index of a Part object within its parent Content object. + * Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. */ partIndex?: number | null; /** - * Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. + * Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. */ startIndex?: number | null; /** - * Output only. The text corresponding to the segment from the response. + * Output only. The text of the segment. */ text?: string | null; } @@ -18427,7 +18615,7 @@ export namespace aiplatform_v1 { noisySampleCount?: number | null; } /** - * Configuration for a single speaker in a multi speaker setup. + * Configuration for a single speaker in a multi-speaker setup. */ export interface Schema$GoogleCloudAiplatformV1SpeakerVoiceConfig { /** @@ -18504,11 +18692,11 @@ export namespace aiplatform_v1 { ngramSize?: number | null; } /** - * The speech generation config. + * Configuration for speech generation. */ export interface Schema$GoogleCloudAiplatformV1SpeechConfig { /** - * Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + * Optional. The language code (ISO 639-1) for the speech synthesis. */ languageCode?: string | null; /** @@ -18516,7 +18704,7 @@ export namespace aiplatform_v1 { */ multiSpeakerVoiceConfig?: Schema$GoogleCloudAiplatformV1MultiSpeakerVoiceConfig; /** - * The configuration for the speaker to use. + * The configuration for the voice to use. */ voiceConfig?: Schema$GoogleCloudAiplatformV1VoiceConfig; } @@ -20637,6 +20825,10 @@ export namespace aiplatform_v1 { * The tuning data statistic values for TuningJob. */ export interface Schema$GoogleCloudAiplatformV1TuningDataStats { + /** + * Output only. Statistics for preference optimization. + */ + preferenceOptimizationDataStats?: Schema$GoogleCloudAiplatformV1PreferenceOptimizationDataStats; /** * The SFT Tuning data stats. */ @@ -20682,6 +20874,10 @@ export namespace aiplatform_v1 { * Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` */ name?: string | null; + /** + * Tuning Spec for Preference Optimization. + */ + preferenceOptimizationSpec?: Schema$GoogleCloudAiplatformV1PreferenceOptimizationSpec; /** * The pre-tuned model for continuous tuning. */ @@ -21043,24 +21239,24 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1UrlContext {} /** - * Metadata related to url context retrieval tool. + * Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */ export interface Schema$GoogleCloudAiplatformV1UrlContextMetadata { /** - * Output only. List of url context. + * Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. */ urlMetadata?: Schema$GoogleCloudAiplatformV1UrlMetadata[]; } /** - * Context of the a single url retrieval. + * The metadata for a single URL retrieval. */ export interface Schema$GoogleCloudAiplatformV1UrlMetadata { /** - * Retrieved url by the tool. + * The URL retrieved by the tool. */ retrievedUrl?: string | null; /** - * Status of the url retrieval. + * The status of the URL retrieval. */ urlRetrievalStatus?: string | null; } @@ -21229,7 +21425,7 @@ export namespace aiplatform_v1 { ragFileIds?: string[] | null; } /** - * Metadata describes the input video content. + * Provides metadata for a video, including the start and end offsets for clipping and the frame rate. */ export interface Schema$GoogleCloudAiplatformV1VideoMetadata { /** @@ -21237,7 +21433,7 @@ export namespace aiplatform_v1 { */ endOffset?: string | null; /** - * Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + * Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. */ fps?: number | null; /** @@ -21246,11 +21442,11 @@ export namespace aiplatform_v1 { startOffset?: string | null; } /** - * The configuration for the voice to use. + * Configuration for a voice. */ export interface Schema$GoogleCloudAiplatformV1VoiceConfig { /** - * The configuration for the prebuilt voice to use. + * The configuration for a prebuilt voice. */ prebuiltVoiceConfig?: Schema$GoogleCloudAiplatformV1PrebuiltVoiceConfig; } @@ -52879,7 +53075,7 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = await aiplatform.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -53413,7 +53609,7 @@ export namespace aiplatform_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -128707,6 +128903,8 @@ export namespace aiplatform_v1 { * // "displayName": "my_displayName", * // "encryptionSpec": {}, * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, * // "updateTime": "my_updateTime", * // "vectorDbConfig": {}, * // "vertexAiSearchConfig": {} @@ -129012,6 +129210,8 @@ export namespace aiplatform_v1 { * // "displayName": "my_displayName", * // "encryptionSpec": {}, * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, * // "updateTime": "my_updateTime", * // "vectorDbConfig": {}, * // "vertexAiSearchConfig": {} @@ -129316,6 +129516,8 @@ export namespace aiplatform_v1 { * // "displayName": "my_displayName", * // "encryptionSpec": {}, * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, * // "updateTime": "my_updateTime", * // "vectorDbConfig": {}, * // "vertexAiSearchConfig": {} @@ -152348,6 +152550,7 @@ export namespace aiplatform_v1 { * // "labels": {}, * // "name": "my_name", * // "preTunedModel": {}, + * // "preferenceOptimizationSpec": {}, * // "serviceAccount": "my_serviceAccount", * // "startTime": "my_startTime", * // "state": "my_state", @@ -152373,6 +152576,7 @@ export namespace aiplatform_v1 { * // "labels": {}, * // "name": "my_name", * // "preTunedModel": {}, + * // "preferenceOptimizationSpec": {}, * // "serviceAccount": "my_serviceAccount", * // "startTime": "my_startTime", * // "state": "my_state", @@ -152537,6 +152741,7 @@ export namespace aiplatform_v1 { * // "labels": {}, * // "name": "my_name", * // "preTunedModel": {}, + * // "preferenceOptimizationSpec": {}, * // "serviceAccount": "my_serviceAccount", * // "startTime": "my_startTime", * // "state": "my_state", From 8494b94da109928644af519f86ffd86c4612ba5f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:14 +0000 Subject: [PATCH 02/31] fix(alloydb): update the API #### alloydb:v1alpha The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description - schemas.StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData.properties.signalType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData.properties.signalType.enumDescriptions #### alloydb:v1beta The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description - schemas.StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData.properties.signalType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData.properties.signalType.enumDescriptions #### alloydb:v1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description - schemas.StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData.properties.signalType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData.properties.signalType.enumDescriptions --- discovery/alloydb-v1.json | 30 ++++++++++++++++++++---------- discovery/alloydb-v1alpha.json | 30 ++++++++++++++++++++---------- discovery/alloydb-v1beta.json | 30 ++++++++++++++++++++---------- src/apis/alloydb/v1.ts | 4 ++-- src/apis/alloydb/v1alpha.ts | 4 ++-- src/apis/alloydb/v1beta.ts | 4 ++-- 6 files changed, 66 insertions(+), 36 deletions(-) diff --git a/discovery/alloydb-v1.json b/discovery/alloydb-v1.json index 126a00c9320..eae35b08695 100644 --- a/discovery/alloydb-v1.json +++ b/discovery/alloydb-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1627,7 +1627,7 @@ } } }, - "revision": "20251016", + "revision": "20251023", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -4356,7 +4356,8 @@ "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", - "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDescriptions": [ "Unspecified signal type.", @@ -4364,7 +4365,8 @@ "Represents database auditing is disabled.", "Represents if a database has a password configured for the root account or not.", "Represents if a resource is exposed to public access.", - "Represents if a resources requires all incoming connections to use SSL or not." + "Represents if a resources requires all incoming connections to use SSL or not.", + "Represents if a resource version is in extended support." ], "type": "string" } @@ -4672,7 +4674,8 @@ "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", - "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" + "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDeprecated": [ false, @@ -4778,6 +4781,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -4884,7 +4888,8 @@ "Outdated version.", "Outdated client.", "Databoost is disabled.", - "Recommended maintenance policy." + "Recommended maintenance policy.", + "Resource version is in extended support." ], "type": "string" }, @@ -5324,7 +5329,8 @@ "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", - "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" + "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDeprecated": [ false, @@ -5430,6 +5436,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -5536,7 +5543,8 @@ "Outdated version.", "Outdated client.", "Databoost is disabled.", - "Recommended maintenance policy." + "Recommended maintenance policy.", + "Resource version is in extended support." ], "type": "string" } @@ -5589,7 +5597,8 @@ "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", - "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDescriptions": [ "Unspecified signal type.", @@ -5597,7 +5606,8 @@ "Represents database auditing is disabled.", "Represents if a database has a password configured for the root account or not.", "Represents if a resource is exposed to public access.", - "Represents if a resources requires all incoming connections to use SSL or not." + "Represents if a resources requires all incoming connections to use SSL or not.", + "Represents if a resource version is in extended support." ], "type": "string" } diff --git a/discovery/alloydb-v1alpha.json b/discovery/alloydb-v1alpha.json index ebd9fb43f66..682c0d30728 100644 --- a/discovery/alloydb-v1alpha.json +++ b/discovery/alloydb-v1alpha.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1627,7 +1627,7 @@ } } }, - "revision": "20251016", + "revision": "20251023", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -4616,7 +4616,8 @@ "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", - "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDescriptions": [ "Unspecified signal type.", @@ -4624,7 +4625,8 @@ "Represents database auditing is disabled.", "Represents if a database has a password configured for the root account or not.", "Represents if a resource is exposed to public access.", - "Represents if a resources requires all incoming connections to use SSL or not." + "Represents if a resources requires all incoming connections to use SSL or not.", + "Represents if a resource version is in extended support." ], "type": "string" } @@ -4932,7 +4934,8 @@ "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", - "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" + "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDeprecated": [ false, @@ -5038,6 +5041,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -5144,7 +5148,8 @@ "Outdated version.", "Outdated client.", "Databoost is disabled.", - "Recommended maintenance policy." + "Recommended maintenance policy.", + "Resource version is in extended support." ], "type": "string" }, @@ -5584,7 +5589,8 @@ "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", - "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" + "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDeprecated": [ false, @@ -5690,6 +5696,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -5796,7 +5803,8 @@ "Outdated version.", "Outdated client.", "Databoost is disabled.", - "Recommended maintenance policy." + "Recommended maintenance policy.", + "Resource version is in extended support." ], "type": "string" } @@ -5849,7 +5857,8 @@ "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", - "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDescriptions": [ "Unspecified signal type.", @@ -5857,7 +5866,8 @@ "Represents database auditing is disabled.", "Represents if a database has a password configured for the root account or not.", "Represents if a resource is exposed to public access.", - "Represents if a resources requires all incoming connections to use SSL or not." + "Represents if a resources requires all incoming connections to use SSL or not.", + "Represents if a resource version is in extended support." ], "type": "string" } diff --git a/discovery/alloydb-v1beta.json b/discovery/alloydb-v1beta.json index 330d5bc3557..a9158c37b9e 100644 --- a/discovery/alloydb-v1beta.json +++ b/discovery/alloydb-v1beta.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1624,7 +1624,7 @@ } } }, - "revision": "20251016", + "revision": "20251023", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -4592,7 +4592,8 @@ "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", - "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDescriptions": [ "Unspecified signal type.", @@ -4600,7 +4601,8 @@ "Represents database auditing is disabled.", "Represents if a database has a password configured for the root account or not.", "Represents if a resource is exposed to public access.", - "Represents if a resources requires all incoming connections to use SSL or not." + "Represents if a resources requires all incoming connections to use SSL or not.", + "Represents if a resource version is in extended support." ], "type": "string" } @@ -4908,7 +4910,8 @@ "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", - "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" + "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDeprecated": [ false, @@ -5014,6 +5017,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -5120,7 +5124,8 @@ "Outdated version.", "Outdated client.", "Databoost is disabled.", - "Recommended maintenance policy." + "Recommended maintenance policy.", + "Resource version is in extended support." ], "type": "string" }, @@ -5560,7 +5565,8 @@ "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", - "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" + "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDeprecated": [ false, @@ -5666,6 +5672,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -5772,7 +5779,8 @@ "Outdated version.", "Outdated client.", "Databoost is disabled.", - "Recommended maintenance policy." + "Recommended maintenance policy.", + "Resource version is in extended support." ], "type": "string" } @@ -5825,7 +5833,8 @@ "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", - "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDescriptions": [ "Unspecified signal type.", @@ -5833,7 +5842,8 @@ "Represents database auditing is disabled.", "Represents if a database has a password configured for the root account or not.", "Represents if a resource is exposed to public access.", - "Represents if a resources requires all incoming connections to use SSL or not." + "Represents if a resources requires all incoming connections to use SSL or not.", + "Represents if a resource version is in extended support." ], "type": "string" } diff --git a/src/apis/alloydb/v1.ts b/src/apis/alloydb/v1.ts index 818f66e2135..3bd43ff5f5c 100644 --- a/src/apis/alloydb/v1.ts +++ b/src/apis/alloydb/v1.ts @@ -2849,7 +2849,7 @@ export namespace alloydb_v1 { * * // Do the magic * const res = await alloydb.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2985,7 +2985,7 @@ export namespace alloydb_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/alloydb/v1alpha.ts b/src/apis/alloydb/v1alpha.ts index 200a6c45678..c99bc2607d9 100644 --- a/src/apis/alloydb/v1alpha.ts +++ b/src/apis/alloydb/v1alpha.ts @@ -3039,7 +3039,7 @@ export namespace alloydb_v1alpha { * * // Do the magic * const res = await alloydb.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -3175,7 +3175,7 @@ export namespace alloydb_v1alpha { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/alloydb/v1beta.ts b/src/apis/alloydb/v1beta.ts index ffc0324cb2b..8b581b77d86 100644 --- a/src/apis/alloydb/v1beta.ts +++ b/src/apis/alloydb/v1beta.ts @@ -3023,7 +3023,7 @@ export namespace alloydb_v1beta { * * // Do the magic * const res = await alloydb.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -3159,7 +3159,7 @@ export namespace alloydb_v1beta { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** From f60f6d74c77aa0624a806ee09b40115149d93952 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:14 +0000 Subject: [PATCH 03/31] fix(apigateway): update the API #### apigateway:v1beta The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description #### apigateway:v1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description --- discovery/apigateway-v1.json | 4 ++-- discovery/apigateway-v1beta.json | 4 ++-- src/apis/apigateway/v1.ts | 4 ++-- src/apis/apigateway/v1beta.ts | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/discovery/apigateway-v1.json b/discovery/apigateway-v1.json index c95ee132290..310a3ca2533 100644 --- a/discovery/apigateway-v1.json +++ b/discovery/apigateway-v1.json @@ -143,7 +143,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1094,7 +1094,7 @@ } } }, - "revision": "20251001", + "revision": "20251021", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/discovery/apigateway-v1beta.json b/discovery/apigateway-v1beta.json index 4f1e59243b7..516f576e739 100644 --- a/discovery/apigateway-v1beta.json +++ b/discovery/apigateway-v1beta.json @@ -143,7 +143,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1094,7 +1094,7 @@ } } }, - "revision": "20251001", + "revision": "20251021", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/src/apis/apigateway/v1.ts b/src/apis/apigateway/v1.ts index de378df959c..74a0fdf8e73 100644 --- a/src/apis/apigateway/v1.ts +++ b/src/apis/apigateway/v1.ts @@ -793,7 +793,7 @@ export namespace apigateway_v1 { * * // Do the magic * const res = await apigateway.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -925,7 +925,7 @@ export namespace apigateway_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/apigateway/v1beta.ts b/src/apis/apigateway/v1beta.ts index d1c190ff7e7..2bdba7909b8 100644 --- a/src/apis/apigateway/v1beta.ts +++ b/src/apis/apigateway/v1beta.ts @@ -815,7 +815,7 @@ export namespace apigateway_v1beta { * * // Do the magic * const res = await apigateway.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -947,7 +947,7 @@ export namespace apigateway_v1beta { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** From abfdb5e99fb9701418b76faea83c3beb3032b27f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:14 +0000 Subject: [PATCH 04/31] feat(apphub): update the API #### apphub:v1alpha The following keys were added: - schemas.FunctionalType.description - schemas.FunctionalType.id - schemas.FunctionalType.properties.type.description - schemas.FunctionalType.properties.type.enum - schemas.FunctionalType.properties.type.enumDescriptions - schemas.FunctionalType.properties.type.readOnly - schemas.FunctionalType.properties.type.type - schemas.FunctionalType.type - schemas.ServiceProperties.properties.functionalType.$ref - schemas.ServiceProperties.properties.functionalType.description - schemas.ServiceProperties.properties.functionalType.readOnly - schemas.WorkloadProperties.properties.functionalType.$ref - schemas.WorkloadProperties.properties.functionalType.description - schemas.WorkloadProperties.properties.functionalType.readOnly The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description #### apphub:v1 The following keys were added: - schemas.FunctionalType.description - schemas.FunctionalType.id - schemas.FunctionalType.properties.type.description - schemas.FunctionalType.properties.type.enum - schemas.FunctionalType.properties.type.enumDescriptions - schemas.FunctionalType.properties.type.readOnly - schemas.FunctionalType.properties.type.type - schemas.FunctionalType.type - schemas.ServiceProperties.properties.functionalType.$ref - schemas.ServiceProperties.properties.functionalType.description - schemas.ServiceProperties.properties.functionalType.readOnly - schemas.WorkloadProperties.properties.functionalType.$ref - schemas.WorkloadProperties.properties.functionalType.description - schemas.WorkloadProperties.properties.functionalType.readOnly The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description --- discovery/apphub-v1.json | 36 +++++++++++++++++++++++++++++++++-- discovery/apphub-v1alpha.json | 36 +++++++++++++++++++++++++++++++++-- src/apis/apphub/v1.ts | 21 ++++++++++++++++++-- src/apis/apphub/v1alpha.ts | 21 ++++++++++++++++++-- 4 files changed, 106 insertions(+), 8 deletions(-) diff --git a/discovery/apphub-v1.json b/discovery/apphub-v1.json index e48889a5156..8e975cba167 100644 --- a/discovery/apphub-v1.json +++ b/discovery/apphub-v1.json @@ -172,7 +172,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1357,7 +1357,7 @@ } } }, - "revision": "20251001", + "revision": "20251028", "rootUrl": "https://apphub.googleapis.com/", "schemas": { "Application": { @@ -1681,6 +1681,28 @@ }, "type": "object" }, + "FunctionalType": { + "description": "The functional type of a service or workload.", + "id": "FunctionalType", + "properties": { + "type": { + "description": "Output only. The functional type of a service or workload.", + "enum": [ + "TYPE_UNSPECIFIED", + "AGENT", + "MCP_SERVER" + ], + "enumDescriptions": [ + "Unspecified type.", + "Agent type.", + "MCP Server type." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ListApplicationsResponse": { "description": "Response for ListApplications.", "id": "ListApplicationsResponse", @@ -2223,6 +2245,11 @@ "description": "Properties of an underlying cloud resource that can comprise a Service.", "id": "ServiceProperties", "properties": { + "functionalType": { + "$ref": "FunctionalType", + "description": "Output only. The type of the service.", + "readOnly": true + }, "gcpProject": { "description": "Output only. The service project identifier that the underlying cloud resource resides in.", "readOnly": true, @@ -2401,6 +2428,11 @@ "description": "Properties of an underlying compute resource represented by the Workload.", "id": "WorkloadProperties", "properties": { + "functionalType": { + "$ref": "FunctionalType", + "description": "Output only. The type of the workload.", + "readOnly": true + }, "gcpProject": { "description": "Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.", "readOnly": true, diff --git a/discovery/apphub-v1alpha.json b/discovery/apphub-v1alpha.json index 6167c1750c2..736cb919b05 100644 --- a/discovery/apphub-v1alpha.json +++ b/discovery/apphub-v1alpha.json @@ -172,7 +172,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1449,7 +1449,7 @@ } } }, - "revision": "20251001", + "revision": "20251028", "rootUrl": "https://apphub.googleapis.com/", "schemas": { "Application": { @@ -1853,6 +1853,28 @@ }, "type": "object" }, + "FunctionalType": { + "description": "The functional type of a service or workload.", + "id": "FunctionalType", + "properties": { + "type": { + "description": "Output only. The functional type of a service or workload.", + "enum": [ + "TYPE_UNSPECIFIED", + "AGENT", + "MCP_SERVER" + ], + "enumDescriptions": [ + "Unspecified type.", + "Agent type.", + "MCP Server type." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ListApplicationsResponse": { "description": "Response for ListApplications.", "id": "ListApplicationsResponse", @@ -2364,6 +2386,11 @@ "description": "Properties of an underlying cloud resource that can comprise a Service.", "id": "ServiceProperties", "properties": { + "functionalType": { + "$ref": "FunctionalType", + "description": "Output only. The type of the service.", + "readOnly": true + }, "gcpProject": { "description": "Output only. The service project identifier that the underlying cloud resource resides in.", "readOnly": true, @@ -2547,6 +2574,11 @@ "description": "Properties of an underlying compute resource represented by the Workload.", "id": "WorkloadProperties", "properties": { + "functionalType": { + "$ref": "FunctionalType", + "description": "Output only. The type of the workload.", + "readOnly": true + }, "gcpProject": { "description": "Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.", "readOnly": true, diff --git a/src/apis/apphub/v1.ts b/src/apis/apphub/v1.ts index 79d24f2a5c0..3e7ddeef6d8 100644 --- a/src/apis/apphub/v1.ts +++ b/src/apis/apphub/v1.ts @@ -335,6 +335,15 @@ export namespace apphub_v1 { */ title?: string | null; } + /** + * The functional type of a service or workload. + */ + export interface Schema$FunctionalType { + /** + * Output only. The functional type of a service or workload. + */ + type?: string | null; + } /** * Response for ListApplications. */ @@ -698,6 +707,10 @@ export namespace apphub_v1 { * Properties of an underlying cloud resource that can comprise a Service. */ export interface Schema$ServiceProperties { + /** + * Output only. The type of the service. + */ + functionalType?: Schema$FunctionalType; /** * Output only. The service project identifier that the underlying cloud resource resides in. */ @@ -821,6 +834,10 @@ export namespace apphub_v1 { * Properties of an underlying compute resource represented by the Workload. */ export interface Schema$WorkloadProperties { + /** + * Output only. The type of the workload. + */ + functionalType?: Schema$FunctionalType; /** * Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources. */ @@ -1196,7 +1213,7 @@ export namespace apphub_v1 { * * // Do the magic * const res = await apphub.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1483,7 +1500,7 @@ export namespace apphub_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/apphub/v1alpha.ts b/src/apis/apphub/v1alpha.ts index babb923e4b0..c1a16613405 100644 --- a/src/apis/apphub/v1alpha.ts +++ b/src/apis/apphub/v1alpha.ts @@ -394,6 +394,15 @@ export namespace apphub_v1alpha { */ unreachable?: string[] | null; } + /** + * The functional type of a service or workload. + */ + export interface Schema$FunctionalType { + /** + * Output only. The functional type of a service or workload. + */ + type?: string | null; + } /** * Response for ListApplications. */ @@ -744,6 +753,10 @@ export namespace apphub_v1alpha { * Properties of an underlying cloud resource that can comprise a Service. */ export interface Schema$ServiceProperties { + /** + * Output only. The type of the service. + */ + functionalType?: Schema$FunctionalType; /** * Output only. The service project identifier that the underlying cloud resource resides in. */ @@ -871,6 +884,10 @@ export namespace apphub_v1alpha { * Properties of an underlying compute resource represented by the Workload. */ export interface Schema$WorkloadProperties { + /** + * Output only. The type of the workload. + */ + functionalType?: Schema$FunctionalType; /** * Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources. */ @@ -1246,7 +1263,7 @@ export namespace apphub_v1alpha { * * // Do the magic * const res = await apphub.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1533,7 +1550,7 @@ export namespace apphub_v1alpha { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** From 72886c44ef0589b145f6b04f0885a9d146606dc1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:14 +0000 Subject: [PATCH 05/31] feat(artifactregistry): update the API #### artifactregistry:v1 The following keys were added: - resources.projects.resources.locations.resources.repositories.methods.exportArtifact.description - resources.projects.resources.locations.resources.repositories.methods.exportArtifact.flatPath - resources.projects.resources.locations.resources.repositories.methods.exportArtifact.httpMethod - resources.projects.resources.locations.resources.repositories.methods.exportArtifact.id - resources.projects.resources.locations.resources.repositories.methods.exportArtifact.parameterOrder - resources.projects.resources.locations.resources.repositories.methods.exportArtifact.parameters.repository.description - resources.projects.resources.locations.resources.repositories.methods.exportArtifact.parameters.repository.location - resources.projects.resources.locations.resources.repositories.methods.exportArtifact.parameters.repository.pattern - resources.projects.resources.locations.resources.repositories.methods.exportArtifact.parameters.repository.required - resources.projects.resources.locations.resources.repositories.methods.exportArtifact.parameters.repository.type - resources.projects.resources.locations.resources.repositories.methods.exportArtifact.path - resources.projects.resources.locations.resources.repositories.methods.exportArtifact.request.$ref - resources.projects.resources.locations.resources.repositories.methods.exportArtifact.response.$ref - resources.projects.resources.locations.resources.repositories.methods.exportArtifact.scopes - schemas.ExportArtifactMetadata.description - schemas.ExportArtifactMetadata.id - schemas.ExportArtifactMetadata.properties.exportedFiles.description - schemas.ExportArtifactMetadata.properties.exportedFiles.items.$ref - schemas.ExportArtifactMetadata.properties.exportedFiles.type - schemas.ExportArtifactMetadata.type - schemas.ExportArtifactRequest.description - schemas.ExportArtifactRequest.id - schemas.ExportArtifactRequest.properties.gcsPath.description - schemas.ExportArtifactRequest.properties.gcsPath.type - schemas.ExportArtifactRequest.properties.sourceTag.description - schemas.ExportArtifactRequest.properties.sourceTag.type - schemas.ExportArtifactRequest.properties.sourceVersion.description - schemas.ExportArtifactRequest.properties.sourceVersion.type - schemas.ExportArtifactRequest.type - schemas.ExportArtifactResponse.description - schemas.ExportArtifactResponse.id - schemas.ExportArtifactResponse.properties.exportedVersion.$ref - schemas.ExportArtifactResponse.properties.exportedVersion.description - schemas.ExportArtifactResponse.type - schemas.ExportedFile.description - schemas.ExportedFile.id - schemas.ExportedFile.properties.gcsObjectPath.description - schemas.ExportedFile.properties.gcsObjectPath.type - schemas.ExportedFile.properties.hashes.description - schemas.ExportedFile.properties.hashes.items.$ref - schemas.ExportedFile.properties.hashes.type - schemas.ExportedFile.properties.name.description - schemas.ExportedFile.properties.name.type - schemas.ExportedFile.type --- discovery/artifactregistry-v1.json | 96 ++++++++++++- src/apis/artifactregistry/v1.ts | 219 +++++++++++++++++++++++++++++ 2 files changed, 314 insertions(+), 1 deletion(-) diff --git a/discovery/artifactregistry-v1.json b/discovery/artifactregistry-v1.json index 9762e80f8d6..3ebf1240cdd 100644 --- a/discovery/artifactregistry-v1.json +++ b/discovery/artifactregistry-v1.json @@ -637,6 +637,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "exportArtifact": { + "description": "Exports an artifact.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:exportArtifact", + "httpMethod": "POST", + "id": "artifactregistry.projects.locations.repositories.exportArtifact", + "parameterOrder": [ + "repository" + ], + "parameters": { + "repository": { + "description": "Required. The repository of the artifact to export. Format: projects/{project}/locations/{location}/repositories/{repository}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+repository}:exportArtifact", + "request": { + "$ref": "ExportArtifactRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets a repository.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}", @@ -2465,7 +2493,7 @@ } } }, - "revision": "20251007", + "revision": "20251017", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -2849,6 +2877,72 @@ "properties": {}, "type": "object" }, + "ExportArtifactMetadata": { + "description": "The LRO metadata for exporting an artifact.", + "id": "ExportArtifactMetadata", + "properties": { + "exportedFiles": { + "description": "The exported artifact files.", + "items": { + "$ref": "ExportedFile" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExportArtifactRequest": { + "description": "The request for exporting an artifact to a destination.", + "id": "ExportArtifactRequest", + "properties": { + "gcsPath": { + "description": "The Cloud Storage path to export the artifact to. Should start with the bucket name, and optionally have a directory path. Examples: `dst_bucket`, `dst_bucket/sub_dir`. Existing objects with the same path will be overwritten.", + "type": "string" + }, + "sourceTag": { + "description": "The artifact tag to export. Format:projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/tags/{tag}", + "type": "string" + }, + "sourceVersion": { + "description": "The artifact version to export. Format: projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/versions/{version}", + "type": "string" + } + }, + "type": "object" + }, + "ExportArtifactResponse": { + "description": "The response for exporting an artifact to a destination.", + "id": "ExportArtifactResponse", + "properties": { + "exportedVersion": { + "$ref": "Version", + "description": "The exported version. Should be the same as the request version with fingerprint resource name." + } + }, + "type": "object" + }, + "ExportedFile": { + "description": "The exported artifact file.", + "id": "ExportedFile", + "properties": { + "gcsObjectPath": { + "description": "Cloud Storage Object path of the exported file. Examples: `dst_bucket/file1`, `dst_bucket/sub_dir/file1`", + "type": "string" + }, + "hashes": { + "description": "The hashes of the file content.", + "items": { + "$ref": "Hash" + }, + "type": "array" + }, + "name": { + "description": "Name of the exported artifact file. Format: `projects/p1/locations/us/repositories/repo1/files/file1`", + "type": "string" + } + }, + "type": "object" + }, "Expr": { "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "id": "Expr", diff --git a/src/apis/artifactregistry/v1.ts b/src/apis/artifactregistry/v1.ts index 553f084a8d3..ff9735b05ac 100644 --- a/src/apis/artifactregistry/v1.ts +++ b/src/apis/artifactregistry/v1.ts @@ -385,6 +385,58 @@ export namespace artifactregistry_v1 { * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ export interface Schema$Empty {} + /** + * The LRO metadata for exporting an artifact. + */ + export interface Schema$ExportArtifactMetadata { + /** + * The exported artifact files. + */ + exportedFiles?: Schema$ExportedFile[]; + } + /** + * The request for exporting an artifact to a destination. + */ + export interface Schema$ExportArtifactRequest { + /** + * The Cloud Storage path to export the artifact to. Should start with the bucket name, and optionally have a directory path. Examples: `dst_bucket`, `dst_bucket/sub_dir`. Existing objects with the same path will be overwritten. + */ + gcsPath?: string | null; + /** + * The artifact tag to export. Format:projects/{project\}/locations/{location\}/repositories/{repository\}/packages/{package\}/tags/{tag\} + */ + sourceTag?: string | null; + /** + * The artifact version to export. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/packages/{package\}/versions/{version\} + */ + sourceVersion?: string | null; + } + /** + * The response for exporting an artifact to a destination. + */ + export interface Schema$ExportArtifactResponse { + /** + * The exported version. Should be the same as the request version with fingerprint resource name. + */ + exportedVersion?: Schema$Version; + } + /** + * The exported artifact file. + */ + export interface Schema$ExportedFile { + /** + * Cloud Storage Object path of the exported file. Examples: `dst_bucket/file1`, `dst_bucket/sub_dir/file1` + */ + gcsObjectPath?: string | null; + /** + * The hashes of the file content. + */ + hashes?: Schema$Hash[]; + /** + * Name of the exported artifact file. Format: `projects/p1/locations/us/repositories/repo1/files/file1` + */ + name?: string | null; + } /** * 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. */ @@ -3206,6 +3258,161 @@ export namespace artifactregistry_v1 { } } + /** + * Exports an artifact. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/artifactregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const artifactregistry = google.artifactregistry('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await artifactregistry.projects.locations.repositories.exportArtifact({ + * // Required. The repository of the artifact to export. Format: projects/{project\}/locations/{location\}/repositories/{repository\} + * repository: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "gcsPath": "my_gcsPath", + * // "sourceTag": "my_sourceTag", + * // "sourceVersion": "my_sourceVersion" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + exportArtifact( + params: Params$Resource$Projects$Locations$Repositories$Exportartifact, + options: StreamMethodOptions + ): Promise>; + exportArtifact( + params?: Params$Resource$Projects$Locations$Repositories$Exportartifact, + options?: MethodOptions + ): Promise>; + exportArtifact( + params: Params$Resource$Projects$Locations$Repositories$Exportartifact, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportArtifact( + params: Params$Resource$Projects$Locations$Repositories$Exportartifact, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportArtifact( + params: Params$Resource$Projects$Locations$Repositories$Exportartifact, + callback: BodyResponseCallback + ): void; + exportArtifact(callback: BodyResponseCallback): void; + exportArtifact( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Exportartifact + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Exportartifact; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Exportartifact; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://artifactregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+repository}:exportArtifact').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['repository'], + pathParams: ['repository'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets a repository. * @example @@ -4177,6 +4384,18 @@ export namespace artifactregistry_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Repositories$Exportartifact + extends StandardParameters { + /** + * Required. The repository of the artifact to export. Format: projects/{project\}/locations/{location\}/repositories/{repository\} + */ + repository?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExportArtifactRequest; + } export interface Params$Resource$Projects$Locations$Repositories$Get extends StandardParameters { /** From ab9527d86c9f865a17241823b102dbbbfa9afc70 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:14 +0000 Subject: [PATCH 06/31] feat(backupdr): update the API #### backupdr:v1 The following keys were added: - schemas.BackupPlan.properties.maxCustomOnDemandRetentionDays.description - schemas.BackupPlan.properties.maxCustomOnDemandRetentionDays.format - schemas.BackupPlan.properties.maxCustomOnDemandRetentionDays.type - schemas.TriggerBackupRequest.properties.customRetentionDays.description - schemas.TriggerBackupRequest.properties.customRetentionDays.format - schemas.TriggerBackupRequest.properties.customRetentionDays.type The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description --- discovery/backupdr-v1.json | 14 ++++++++++++-- src/apis/backupdr/v1.ts | 16 ++++++++++++++-- 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/discovery/backupdr-v1.json b/discovery/backupdr-v1.json index 4611606ac61..e69a400f464 100644 --- a/discovery/backupdr-v1.json +++ b/discovery/backupdr-v1.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2234,7 +2234,7 @@ } } }, - "revision": "20251015", + "revision": "20251022", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -3182,6 +3182,11 @@ "format": "int64", "type": "string" }, + "maxCustomOnDemandRetentionDays": { + "description": "Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.", + "format": "int32", + "type": "integer" + }, "name": { "description": "Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`", "readOnly": true, @@ -6385,6 +6390,11 @@ "description": "Request message for triggering a backup.", "id": "TriggerBackupRequest", "properties": { + "customRetentionDays": { + "description": "Optional. The duration for which backup data will be kept, while taking an on-demand backup with custom retention. It is defined in \"days\". It is mutually exclusive with rule_id. This field is required if rule_id is not provided.", + "format": "int32", + "type": "integer" + }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" diff --git a/src/apis/backupdr/v1.ts b/src/apis/backupdr/v1.ts index b199c4ea9ff..d454d188005 100644 --- a/src/apis/backupdr/v1.ts +++ b/src/apis/backupdr/v1.ts @@ -735,6 +735,10 @@ export namespace backupdr_v1 { * Optional. Applicable only for CloudSQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault. */ logRetentionDays?: string | null; + /** + * Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value. + */ + maxCustomOnDemandRetentionDays?: number | null; /** * Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project\}/locations/{location\}/backupPlans/{backup_plan\}` */ @@ -2829,6 +2833,10 @@ export namespace backupdr_v1 { * Request message for triggering a backup. */ export interface Schema$TriggerBackupRequest { + /** + * Optional. The duration for which backup data will be kept, while taking an on-demand backup with custom retention. It is defined in "days". It is mutually exclusive with rule_id. This field is required if rule_id is not provided. + */ + customRetentionDays?: number | null; /** * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ @@ -3230,7 +3238,7 @@ export namespace backupdr_v1 { * * // Do the magic * const res = await backupdr.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -3365,7 +3373,7 @@ export namespace backupdr_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -4365,6 +4373,7 @@ export namespace backupdr_v1 { * requestBody: { * // request body parameters * // { + * // "customRetentionDays": 0, * // "requestId": "my_requestId", * // "ruleId": "my_ruleId" * // } @@ -4656,6 +4665,7 @@ export namespace backupdr_v1 { * // "etag": "my_etag", * // "labels": {}, * // "logRetentionDays": "my_logRetentionDays", + * // "maxCustomOnDemandRetentionDays": 0, * // "name": "my_name", * // "resourceType": "my_resourceType", * // "revisionId": "my_revisionId", @@ -4959,6 +4969,7 @@ export namespace backupdr_v1 { * // "etag": "my_etag", * // "labels": {}, * // "logRetentionDays": "my_logRetentionDays", + * // "maxCustomOnDemandRetentionDays": 0, * // "name": "my_name", * // "resourceType": "my_resourceType", * // "revisionId": "my_revisionId", @@ -5260,6 +5271,7 @@ export namespace backupdr_v1 { * // "etag": "my_etag", * // "labels": {}, * // "logRetentionDays": "my_logRetentionDays", + * // "maxCustomOnDemandRetentionDays": 0, * // "name": "my_name", * // "resourceType": "my_resourceType", * // "revisionId": "my_revisionId", From a2d0e3a27c1f369a0de9c766d0638d1c691ece0e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:14 +0000 Subject: [PATCH 07/31] feat(biglake): update the API #### biglake:v1 The following keys were added: - resources.projects.resources.catalogs.methods.getIamPolicy.description - resources.projects.resources.catalogs.methods.getIamPolicy.flatPath - resources.projects.resources.catalogs.methods.getIamPolicy.httpMethod - resources.projects.resources.catalogs.methods.getIamPolicy.id - resources.projects.resources.catalogs.methods.getIamPolicy.parameterOrder - resources.projects.resources.catalogs.methods.getIamPolicy.parameters.options.requestedPolicyVersion.description - resources.projects.resources.catalogs.methods.getIamPolicy.parameters.options.requestedPolicyVersion.format - resources.projects.resources.catalogs.methods.getIamPolicy.parameters.options.requestedPolicyVersion.location - resources.projects.resources.catalogs.methods.getIamPolicy.parameters.options.requestedPolicyVersion.type - resources.projects.resources.catalogs.methods.getIamPolicy.parameters.resource.description - resources.projects.resources.catalogs.methods.getIamPolicy.parameters.resource.location - resources.projects.resources.catalogs.methods.getIamPolicy.parameters.resource.pattern - resources.projects.resources.catalogs.methods.getIamPolicy.parameters.resource.required - resources.projects.resources.catalogs.methods.getIamPolicy.parameters.resource.type - resources.projects.resources.catalogs.methods.getIamPolicy.path - resources.projects.resources.catalogs.methods.getIamPolicy.response.$ref - resources.projects.resources.catalogs.methods.getIamPolicy.scopes - resources.projects.resources.catalogs.methods.setIamPolicy.description - resources.projects.resources.catalogs.methods.setIamPolicy.flatPath - resources.projects.resources.catalogs.methods.setIamPolicy.httpMethod - resources.projects.resources.catalogs.methods.setIamPolicy.id - resources.projects.resources.catalogs.methods.setIamPolicy.parameterOrder - resources.projects.resources.catalogs.methods.setIamPolicy.parameters.resource.description - resources.projects.resources.catalogs.methods.setIamPolicy.parameters.resource.location - resources.projects.resources.catalogs.methods.setIamPolicy.parameters.resource.pattern - resources.projects.resources.catalogs.methods.setIamPolicy.parameters.resource.required - resources.projects.resources.catalogs.methods.setIamPolicy.parameters.resource.type - resources.projects.resources.catalogs.methods.setIamPolicy.path - resources.projects.resources.catalogs.methods.setIamPolicy.request.$ref - resources.projects.resources.catalogs.methods.setIamPolicy.response.$ref - resources.projects.resources.catalogs.methods.setIamPolicy.scopes - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.description - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.flatPath - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.httpMethod - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.id - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.parameterOrder - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.parameters.options.requestedPolicyVersion.description - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.parameters.options.requestedPolicyVersion.format - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.parameters.options.requestedPolicyVersion.location - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.parameters.options.requestedPolicyVersion.type - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.parameters.resource.description - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.parameters.resource.location - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.parameters.resource.pattern - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.parameters.resource.required - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.parameters.resource.type - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.path - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.response.$ref - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy.scopes - resources.projects.resources.catalogs.resources.namespaces.methods.setIamPolicy.description - resources.projects.resources.catalogs.resources.namespaces.methods.setIamPolicy.flatPath - resources.projects.resources.catalogs.resources.namespaces.methods.setIamPolicy.httpMethod - resources.projects.resources.catalogs.resources.namespaces.methods.setIamPolicy.id - resources.projects.resources.catalogs.resources.namespaces.methods.setIamPolicy.parameterOrder - resources.projects.resources.catalogs.resources.namespaces.methods.setIamPolicy.parameters.resource.description - resources.projects.resources.catalogs.resources.namespaces.methods.setIamPolicy.parameters.resource.location - resources.projects.resources.catalogs.resources.namespaces.methods.setIamPolicy.parameters.resource.pattern - resources.projects.resources.catalogs.resources.namespaces.methods.setIamPolicy.parameters.resource.required - resources.projects.resources.catalogs.resources.namespaces.methods.setIamPolicy.parameters.resource.type - resources.projects.resources.catalogs.resources.namespaces.methods.setIamPolicy.path - resources.projects.resources.catalogs.resources.namespaces.methods.setIamPolicy.request.$ref - resources.projects.resources.catalogs.resources.namespaces.methods.setIamPolicy.response.$ref - resources.projects.resources.catalogs.resources.namespaces.methods.setIamPolicy.scopes - schemas.AuditConfig.description - schemas.AuditConfig.id - schemas.AuditConfig.properties.auditLogConfigs.description - schemas.AuditConfig.properties.auditLogConfigs.items.$ref - schemas.AuditConfig.properties.auditLogConfigs.type - schemas.AuditConfig.properties.service.description - schemas.AuditConfig.properties.service.type - schemas.AuditConfig.type - schemas.AuditLogConfig.description - schemas.AuditLogConfig.id - schemas.AuditLogConfig.properties.exemptedMembers.description - schemas.AuditLogConfig.properties.exemptedMembers.items.type - schemas.AuditLogConfig.properties.exemptedMembers.type - schemas.AuditLogConfig.properties.logType.description - schemas.AuditLogConfig.properties.logType.enum - schemas.AuditLogConfig.properties.logType.enumDescriptions - schemas.AuditLogConfig.properties.logType.type - schemas.AuditLogConfig.type - schemas.Binding.description - schemas.Binding.id - schemas.Binding.properties.condition.$ref - schemas.Binding.properties.condition.description - schemas.Binding.properties.members.description - schemas.Binding.properties.members.items.type - schemas.Binding.properties.members.type - schemas.Binding.properties.role.description - schemas.Binding.properties.role.type - schemas.Binding.type - schemas.Expr.description - schemas.Expr.id - schemas.Expr.properties.description.description - schemas.Expr.properties.description.type - schemas.Expr.properties.expression.description - schemas.Expr.properties.expression.type - schemas.Expr.properties.location.description - schemas.Expr.properties.location.type - schemas.Expr.properties.title.description - schemas.Expr.properties.title.type - schemas.Expr.type - schemas.Policy.description - schemas.Policy.id - schemas.Policy.properties.auditConfigs.description - schemas.Policy.properties.auditConfigs.items.$ref - schemas.Policy.properties.auditConfigs.type - schemas.Policy.properties.bindings.description - schemas.Policy.properties.bindings.items.$ref - schemas.Policy.properties.bindings.type - schemas.Policy.properties.etag.description - schemas.Policy.properties.etag.format - schemas.Policy.properties.etag.type - schemas.Policy.properties.version.description - schemas.Policy.properties.version.format - schemas.Policy.properties.version.type - schemas.Policy.type - schemas.SetIamPolicyRequest.description - schemas.SetIamPolicyRequest.id - schemas.SetIamPolicyRequest.properties.policy.$ref - schemas.SetIamPolicyRequest.properties.policy.description - schemas.SetIamPolicyRequest.properties.updateMask.description - schemas.SetIamPolicyRequest.properties.updateMask.format - schemas.SetIamPolicyRequest.properties.updateMask.type - schemas.SetIamPolicyRequest.type --- discovery/biglake-v1.json | 274 +++++++++++++- src/apis/biglake/v1.ts | 760 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 1033 insertions(+), 1 deletion(-) diff --git a/discovery/biglake-v1.json b/discovery/biglake-v1.json index b4117f31bd7..ee55bcfac21 100644 --- a/discovery/biglake-v1.json +++ b/discovery/biglake-v1.json @@ -110,6 +110,138 @@ "resources": { "projects": { "resources": { + "catalogs": { + "methods": { + "getIamPolicy": { + "description": "Gets the IAM policy for the specified Catalog.", + "flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}:getIamPolicy", + "httpMethod": "GET", + "id": "biglake.projects.catalogs.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the IAM policy for the specified catalog.", + "flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}:setIamPolicy", + "httpMethod": "POST", + "id": "biglake.projects.catalogs.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "namespaces": { + "methods": { + "getIamPolicy": { + "description": "Gets the IAM policy for the specified Catalog.", + "flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}/namespaces/{namespacesId}:getIamPolicy", + "httpMethod": "GET", + "id": "biglake.projects.catalogs.namespaces.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/catalogs/[^/]+/namespaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the IAM policy for the specified catalog.", + "flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}/namespaces/{namespacesId}:setIamPolicy", + "httpMethod": "POST", + "id": "biglake.projects.catalogs.namespaces.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/catalogs/[^/]+/namespaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "locations": { "resources": { "catalogs": { @@ -616,9 +748,79 @@ } } }, - "revision": "20231016", + "revision": "20251027", "rootUrl": "https://biglake.googleapis.com/", "schemas": { + "AuditConfig": { + "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", + "id": "AuditConfig", + "properties": { + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "items": { + "$ref": "AuditLogConfig" + }, + "type": "array" + }, + "service": { + "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", + "type": "string" + } + }, + "type": "object" + }, + "AuditLogConfig": { + "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", + "id": "AuditLogConfig", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logType": { + "description": "The log type that this config enables.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "type": "string" + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates `members`, or principals, with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." + }, + "members": { + "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", + "type": "string" + } + }, + "type": "object" + }, "Catalog": { "description": "Catalog is the container of databases.", "id": "Catalog", @@ -707,6 +909,29 @@ }, "type": "object" }, + "Expr": { + "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", + "id": "Expr", + "properties": { + "description": { + "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", + "type": "string" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "location": { + "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", + "type": "string" + }, + "title": { + "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", + "type": "string" + } + }, + "type": "object" + }, "HiveDatabaseOptions": { "description": "Options of a Hive database.", "id": "HiveDatabaseOptions", @@ -801,6 +1026,37 @@ }, "type": "object" }, + "Policy": { + "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", + "id": "Policy", + "properties": { + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "items": { + "$ref": "AuditConfig" + }, + "type": "array" + }, + "bindings": { + "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "RenameTableRequest": { "description": "Request message for the RenameTable method in MetastoreService", "id": "RenameTableRequest", @@ -823,6 +1079,22 @@ }, "type": "object" }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "SetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." + }, + "updateMask": { + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, "StorageDescriptor": { "description": "Stores physical storage information of the data.", "id": "StorageDescriptor", diff --git a/src/apis/biglake/v1.ts b/src/apis/biglake/v1.ts index b99be915a91..28fbc008f61 100644 --- a/src/apis/biglake/v1.ts +++ b/src/apis/biglake/v1.ts @@ -124,6 +124,49 @@ export namespace biglake_v1 { } } + /** + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. + */ + export interface Schema$AuditConfig { + /** + * The configuration for logging of each type of permission. + */ + auditLogConfigs?: Schema$AuditLogConfig[]; + /** + * 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. + */ + service?: string | null; + } + /** + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \} ] \} This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. + */ + export interface Schema$AuditLogConfig { + /** + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + */ + exemptedMembers?: string[] | null; + /** + * The log type that this config enables. + */ + logType?: string | null; + } + /** + * Associates `members`, or principals, with a `role`. + */ + export interface Schema$Binding { + /** + * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + condition?: Schema$Expr; + /** + * Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + */ + members?: string[] | null; + /** + * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + */ + role?: string | null; + } /** * Catalog is the container of databases. */ @@ -182,6 +225,27 @@ export namespace biglake_v1 { */ updateTime?: string | null; } + /** + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. + */ + export interface Schema$Expr { + /** + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. + */ + expression?: string | null; + /** + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * 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. + */ + title?: string | null; + } /** * Options of a Hive database. */ @@ -251,6 +315,27 @@ export namespace biglake_v1 { */ tables?: Schema$Table[]; } + /** + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + */ + export interface Schema$Policy { + /** + * Specifies cloud audit logging configuration for this policy. + */ + auditConfigs?: Schema$AuditConfig[]; + /** + * Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + */ + bindings?: Schema$Binding[]; + /** + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + */ + etag?: string | null; + /** + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + version?: number | null; + } /** * Request message for the RenameTable method in MetastoreService */ @@ -269,6 +354,19 @@ export namespace biglake_v1 { */ serializationLib?: string | null; } + /** + * Request message for `SetIamPolicy` method. + */ + export interface Schema$SetIamPolicyRequest { + /** + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them. + */ + policy?: Schema$Policy; + /** + * 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"` + */ + updateMask?: string | null; + } /** * Stores physical storage information of the data. */ @@ -330,13 +428,675 @@ export namespace biglake_v1 { export class Resource$Projects { context: APIRequestContext; + catalogs: Resource$Projects$Catalogs; locations: Resource$Projects$Locations; constructor(context: APIRequestContext) { this.context = context; + this.catalogs = new Resource$Projects$Catalogs(this.context); this.locations = new Resource$Projects$Locations(this.context); } } + export class Resource$Projects$Catalogs { + context: APIRequestContext; + namespaces: Resource$Projects$Catalogs$Namespaces; + constructor(context: APIRequestContext) { + this.context = context; + this.namespaces = new Resource$Projects$Catalogs$Namespaces(this.context); + } + + /** + * Gets the IAM policy for the specified Catalog. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/biglake.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const biglake = google.biglake('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await biglake.projects.catalogs.getIamPolicy({ + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: 'projects/my-project/catalogs/my-catalog', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Catalogs$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Projects$Catalogs$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Catalogs$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Catalogs$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Catalogs$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Catalogs$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Catalogs$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Catalogs$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://biglake.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the IAM policy for the specified catalog. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/biglake.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const biglake = google.biglake('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await biglake.projects.catalogs.setIamPolicy({ + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: 'projects/my-project/catalogs/my-catalog', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {}, + * // "updateMask": "my_updateMask" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Catalogs$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Projects$Catalogs$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Catalogs$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Catalogs$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Catalogs$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Catalogs$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Catalogs$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Catalogs$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://biglake.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Catalogs$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Catalogs$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + + export class Resource$Projects$Catalogs$Namespaces { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the IAM policy for the specified Catalog. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/biglake.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const biglake = google.biglake('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await biglake.projects.catalogs.namespaces.getIamPolicy({ + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: 'projects/my-project/catalogs/my-catalog/namespaces/my-namespace', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Catalogs$Namespaces$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Projects$Catalogs$Namespaces$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Catalogs$Namespaces$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Catalogs$Namespaces$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Catalogs$Namespaces$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Catalogs$Namespaces$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Catalogs$Namespaces$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Catalogs$Namespaces$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://biglake.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the IAM policy for the specified catalog. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/biglake.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const biglake = google.biglake('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await biglake.projects.catalogs.namespaces.setIamPolicy({ + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: 'projects/my-project/catalogs/my-catalog/namespaces/my-namespace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {}, + * // "updateMask": "my_updateMask" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Catalogs$Namespaces$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Projects$Catalogs$Namespaces$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Catalogs$Namespaces$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Catalogs$Namespaces$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Catalogs$Namespaces$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Catalogs$Namespaces$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Catalogs$Namespaces$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Catalogs$Namespaces$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://biglake.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Catalogs$Namespaces$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Catalogs$Namespaces$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export class Resource$Projects$Locations { context: APIRequestContext; catalogs: Resource$Projects$Locations$Catalogs; From c8f03627acae3e9897a22bf4348a41c37be74d22 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:14 +0000 Subject: [PATCH 08/31] fix(clouddeploy): update the API #### clouddeploy:v1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description --- discovery/clouddeploy-v1.json | 4 ++-- src/apis/clouddeploy/v1.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/discovery/clouddeploy-v1.json b/discovery/clouddeploy-v1.json index 8d86ae4d345..43fab646c47 100644 --- a/discovery/clouddeploy-v1.json +++ b/discovery/clouddeploy-v1.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2359,7 +2359,7 @@ } } }, - "revision": "20251001", + "revision": "20251022", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { diff --git a/src/apis/clouddeploy/v1.ts b/src/apis/clouddeploy/v1.ts index fa0b816c488..f24a5864dcd 100644 --- a/src/apis/clouddeploy/v1.ts +++ b/src/apis/clouddeploy/v1.ts @@ -3655,7 +3655,7 @@ export namespace clouddeploy_v1 { * * // Do the magic * const res = await clouddeploy.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -3790,7 +3790,7 @@ export namespace clouddeploy_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** From 37901afa5cf7f013c5b171247f19986a8b25a4d1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:14 +0000 Subject: [PATCH 09/31] feat(cloudkms)!: update the API BREAKING CHANGE: This release has breaking changes. #### cloudkms:v1 The following keys were deleted: - resources.projects.methods.getAutokeyConfig.description - resources.projects.methods.getAutokeyConfig.flatPath - resources.projects.methods.getAutokeyConfig.httpMethod - resources.projects.methods.getAutokeyConfig.id - resources.projects.methods.getAutokeyConfig.parameterOrder - resources.projects.methods.getAutokeyConfig.parameters.name.description - resources.projects.methods.getAutokeyConfig.parameters.name.location - resources.projects.methods.getAutokeyConfig.parameters.name.pattern - resources.projects.methods.getAutokeyConfig.parameters.name.required - resources.projects.methods.getAutokeyConfig.parameters.name.type - resources.projects.methods.getAutokeyConfig.path - resources.projects.methods.getAutokeyConfig.response.$ref - resources.projects.methods.getAutokeyConfig.scopes - resources.projects.methods.updateAutokeyConfig.description - resources.projects.methods.updateAutokeyConfig.flatPath - resources.projects.methods.updateAutokeyConfig.httpMethod - resources.projects.methods.updateAutokeyConfig.id - resources.projects.methods.updateAutokeyConfig.parameterOrder - resources.projects.methods.updateAutokeyConfig.parameters.name.description - resources.projects.methods.updateAutokeyConfig.parameters.name.location - resources.projects.methods.updateAutokeyConfig.parameters.name.pattern - resources.projects.methods.updateAutokeyConfig.parameters.name.required - resources.projects.methods.updateAutokeyConfig.parameters.name.type - resources.projects.methods.updateAutokeyConfig.parameters.updateMask.description - resources.projects.methods.updateAutokeyConfig.parameters.updateMask.format - resources.projects.methods.updateAutokeyConfig.parameters.updateMask.location - resources.projects.methods.updateAutokeyConfig.parameters.updateMask.type - resources.projects.methods.updateAutokeyConfig.path - resources.projects.methods.updateAutokeyConfig.request.$ref - resources.projects.methods.updateAutokeyConfig.response.$ref - resources.projects.methods.updateAutokeyConfig.scopes The following keys were changed: - resources.folders.methods.getAutokeyConfig.description - resources.folders.methods.getAutokeyConfig.parameters.name.description - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description --- discovery/cloudkms-v1.json | 69 +------- src/apis/cloudkms/v1.ts | 330 +------------------------------------ 2 files changed, 9 insertions(+), 390 deletions(-) diff --git a/discovery/cloudkms-v1.json b/discovery/cloudkms-v1.json index bb842b2e6d3..9466c5bf2e7 100644 --- a/discovery/cloudkms-v1.json +++ b/discovery/cloudkms-v1.json @@ -203,7 +203,7 @@ "folders": { "methods": { "getAutokeyConfig": { - "description": "Returns the AutokeyConfig for a folder or project.", + "description": "Returns the AutokeyConfig for a folder.", "flatPath": "v1/folders/{foldersId}/autokeyConfig", "httpMethod": "GET", "id": "cloudkms.folders.getAutokeyConfig", @@ -212,7 +212,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.", + "description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`.", "location": "path", "pattern": "^folders/[^/]+/autokeyConfig$", "required": true, @@ -393,32 +393,6 @@ }, "projects": { "methods": { - "getAutokeyConfig": { - "description": "Returns the AutokeyConfig for a folder or project.", - "flatPath": "v1/projects/{projectsId}/autokeyConfig", - "httpMethod": "GET", - "id": "cloudkms.projects.getAutokeyConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.", - "location": "path", - "pattern": "^projects/[^/]+/autokeyConfig$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "AutokeyConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudkms" - ] - }, "getKajPolicyConfig": { "description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.", "flatPath": "v1/projects/{projectsId}/kajPolicyConfig", @@ -523,41 +497,6 @@ "https://www.googleapis.com/auth/cloudkms" ] }, - "updateAutokeyConfig": { - "description": "Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.", - "flatPath": "v1/projects/{projectsId}/autokeyConfig", - "httpMethod": "PATCH", - "id": "cloudkms.projects.updateAutokeyConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`.", - "location": "path", - "pattern": "^projects/[^/]+/autokeyConfig$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "AutokeyConfig" - }, - "response": { - "$ref": "AutokeyConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudkms" - ] - }, "updateKajPolicyConfig": { "description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.", "flatPath": "v1/projects/{projectsId}/kajPolicyConfig", @@ -688,7 +627,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2496,7 +2435,7 @@ } } }, - "revision": "20251016", + "revision": "20251023", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index 8c3473d4f3d..7bd492517f4 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -1477,7 +1477,7 @@ export namespace cloudkms_v1 { } /** - * Returns the AutokeyConfig for a folder or project. + * Returns the AutokeyConfig for a folder. * @example * ```js * // Before running the sample: @@ -1510,7 +1510,7 @@ export namespace cloudkms_v1 { * * // Do the magic * const res = await cloudkms.folders.getAutokeyConfig({ - * // Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER\}/autokeyConfig` or `projects/{PROJECT_NUMBER\}/autokeyConfig`. + * // Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER\}/autokeyConfig`. * name: 'folders/my-folder/autokeyConfig', * }); * console.log(res.data); @@ -2084,7 +2084,7 @@ export namespace cloudkms_v1 { export interface Params$Resource$Folders$Getautokeyconfig extends StandardParameters { /** - * Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER\}/autokeyConfig` or `projects/{PROJECT_NUMBER\}/autokeyConfig`. + * Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER\}/autokeyConfig`. */ name?: string; } @@ -2474,148 +2474,6 @@ export namespace cloudkms_v1 { this.locations = new Resource$Projects$Locations(this.context); } - /** - * Returns the AutokeyConfig for a folder or project. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/cloudkms.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const cloudkms = google.cloudkms('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloudkms', - * ], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await cloudkms.projects.getAutokeyConfig({ - * // Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER\}/autokeyConfig` or `projects/{PROJECT_NUMBER\}/autokeyConfig`. - * name: 'projects/my-project/autokeyConfig', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "etag": "my_etag", - * // "keyProject": "my_keyProject", - * // "name": "my_name", - * // "state": "my_state" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getAutokeyConfig( - params: Params$Resource$Projects$Getautokeyconfig, - options: StreamMethodOptions - ): Promise>; - getAutokeyConfig( - params?: Params$Resource$Projects$Getautokeyconfig, - options?: MethodOptions - ): Promise>; - getAutokeyConfig( - params: Params$Resource$Projects$Getautokeyconfig, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAutokeyConfig( - params: Params$Resource$Projects$Getautokeyconfig, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAutokeyConfig( - params: Params$Resource$Projects$Getautokeyconfig, - callback: BodyResponseCallback - ): void; - getAutokeyConfig( - callback: BodyResponseCallback - ): void; - getAutokeyConfig( - paramsOrCallback?: - | Params$Resource$Projects$Getautokeyconfig - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Getautokeyconfig; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Getautokeyconfig; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudkms.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project. * @example @@ -3222,161 +3080,6 @@ export namespace cloudkms_v1 { } } - /** - * Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/cloudkms.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const cloudkms = google.cloudkms('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloudkms', - * ], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await cloudkms.projects.updateAutokeyConfig({ - * // Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER\}/autokeyConfig` `projects/{PROJECT_NUMBER\}/autokeyConfig`. - * name: 'projects/my-project/autokeyConfig', - * // Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "etag": "my_etag", - * // "keyProject": "my_keyProject", - * // "name": "my_name", - * // "state": "my_state" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "etag": "my_etag", - * // "keyProject": "my_keyProject", - * // "name": "my_name", - * // "state": "my_state" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - updateAutokeyConfig( - params: Params$Resource$Projects$Updateautokeyconfig, - options: StreamMethodOptions - ): Promise>; - updateAutokeyConfig( - params?: Params$Resource$Projects$Updateautokeyconfig, - options?: MethodOptions - ): Promise>; - updateAutokeyConfig( - params: Params$Resource$Projects$Updateautokeyconfig, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updateAutokeyConfig( - params: Params$Resource$Projects$Updateautokeyconfig, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updateAutokeyConfig( - params: Params$Resource$Projects$Updateautokeyconfig, - callback: BodyResponseCallback - ): void; - updateAutokeyConfig( - callback: BodyResponseCallback - ): void; - updateAutokeyConfig( - paramsOrCallback?: - | Params$Resource$Projects$Updateautokeyconfig - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Updateautokeyconfig; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Updateautokeyconfig; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudkms.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project. * @example @@ -3537,13 +3240,6 @@ export namespace cloudkms_v1 { } } - export interface Params$Resource$Projects$Getautokeyconfig - extends StandardParameters { - /** - * Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER\}/autokeyConfig` or `projects/{PROJECT_NUMBER\}/autokeyConfig`. - */ - name?: string; - } export interface Params$Resource$Projects$Getkajpolicyconfig extends StandardParameters { /** @@ -3572,22 +3268,6 @@ export namespace cloudkms_v1 { */ project?: string; } - export interface Params$Resource$Projects$Updateautokeyconfig - extends StandardParameters { - /** - * Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER\}/autokeyConfig` `projects/{PROJECT_NUMBER\}/autokeyConfig`. - */ - name?: string; - /** - * Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AutokeyConfig; - } export interface Params$Resource$Projects$Updatekajpolicyconfig extends StandardParameters { /** @@ -4094,7 +3774,7 @@ export namespace cloudkms_v1 { * * // Do the magic * const res = await cloudkms.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -4390,7 +4070,7 @@ export namespace cloudkms_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** From 6be8086c426193770877353fa51892ed87b64a59 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:14 +0000 Subject: [PATCH 10/31] feat(dfareporting): update the API #### dfareporting:v4 The following keys were added: - schemas.Ad.properties.contextualKeywordTargeting.$ref - schemas.Ad.properties.contextualKeywordTargeting.description - schemas.ContextualKeyword.description - schemas.ContextualKeyword.id - schemas.ContextualKeyword.properties.keyword.description - schemas.ContextualKeyword.properties.keyword.type - schemas.ContextualKeyword.type - schemas.ContextualKeywordTargeting.description - schemas.ContextualKeywordTargeting.id - schemas.ContextualKeywordTargeting.properties.keywords.description - schemas.ContextualKeywordTargeting.properties.keywords.items.$ref - schemas.ContextualKeywordTargeting.properties.keywords.type - schemas.ContextualKeywordTargeting.type - schemas.TargetingTemplate.properties.contextualKeywordTargeting.$ref - schemas.TargetingTemplate.properties.contextualKeywordTargeting.description The following keys were changed: - schemas.Creative.properties.authoringSource.enum - schemas.Creative.properties.authoringSource.enumDescriptions - schemas.Placement.properties.adServingPlatformId.description - schemas.Site.properties.adServingPlatformId.description - schemas.UniversalAdId.properties.registry.enum - schemas.UniversalAdId.properties.registry.enumDescriptions #### dfareporting:v5 The following keys were added: - schemas.Ad.properties.contextualKeywordTargeting.$ref - schemas.Ad.properties.contextualKeywordTargeting.description - schemas.ContextualKeyword.description - schemas.ContextualKeyword.id - schemas.ContextualKeyword.properties.keyword.description - schemas.ContextualKeyword.properties.keyword.type - schemas.ContextualKeyword.type - schemas.ContextualKeywordTargeting.description - schemas.ContextualKeywordTargeting.id - schemas.ContextualKeywordTargeting.properties.keywords.description - schemas.ContextualKeywordTargeting.properties.keywords.items.$ref - schemas.ContextualKeywordTargeting.properties.keywords.type - schemas.ContextualKeywordTargeting.type - schemas.TargetingTemplate.properties.contextualKeywordTargeting.$ref - schemas.TargetingTemplate.properties.contextualKeywordTargeting.description The following keys were changed: - schemas.Creative.properties.authoringSource.enum - schemas.Creative.properties.authoringSource.enumDescriptions - schemas.Placement.properties.adServingPlatformId.description - schemas.Site.properties.adServingPlatformId.description - schemas.UniversalAdId.properties.registry.enum - schemas.UniversalAdId.properties.registry.enumDescriptions --- discovery/dfareporting-v4.json | 53 ++++++++++++++++++++++++++++++---- discovery/dfareporting-v5.json | 53 ++++++++++++++++++++++++++++++---- src/apis/dfareporting/v4.ts | 44 ++++++++++++++++++++++++++-- src/apis/dfareporting/v5.ts | 44 ++++++++++++++++++++++++++-- 4 files changed, 178 insertions(+), 16 deletions(-) diff --git a/discovery/dfareporting-v4.json b/discovery/dfareporting-v4.json index a915e61545b..ae8c9f8b471 100644 --- a/discovery/dfareporting-v4.json +++ b/discovery/dfareporting-v4.json @@ -10465,7 +10465,7 @@ } } }, - "revision": "20251009", + "revision": "20251023", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -10989,6 +10989,10 @@ ], "type": "string" }, + "contextualKeywordTargeting": { + "$ref": "ContextualKeywordTargeting", + "description": "Optional. Contextual keyword targeting information for this ad." + }, "createInfo": { "$ref": "LastModifiedInfo", "description": "Information about the creation of this ad. This is a read-only field." @@ -12583,6 +12587,31 @@ }, "type": "object" }, + "ContextualKeyword": { + "description": "Contains information about a Contextual Keyword that can be targeted by ads.", + "id": "ContextualKeyword", + "properties": { + "keyword": { + "description": "The keyword that can be targeted by ads.", + "type": "string" + } + }, + "type": "object" + }, + "ContextualKeywordTargeting": { + "description": "Contextual Keyword Targeting.", + "id": "ContextualKeywordTargeting", + "properties": { + "keywords": { + "description": "Contextual keywords that this ad targets", + "items": { + "$ref": "ContextualKeyword" + }, + "type": "array" + } + }, + "type": "object" + }, "Conversion": { "description": "A Conversion represents when a user successfully performs a desired action after seeing an ad.", "id": "Conversion", @@ -12961,7 +12990,10 @@ "CREATIVE_AUTHORING_SOURCE_GWD", "CREATIVE_AUTHORING_SOURCE_ACS", "CREATIVE_AUTHORING_SOURCE_ADOBE", - "CREATIVE_AUTHORING_SOURCE_TYPEFACE_AI" + "CREATIVE_AUTHORING_SOURCE_TYPEFACE_AI", + "CREATIVE_AUTHORING_SOURCE_REMBRAND", + "CREATIVE_AUTHORING_SOURCE_TRACKTO_STUDIO", + "CREATIVE_AUTHORING_SOURCE_BORNLOGIC" ], "enumDescriptions": [ "DCM-UI or external API used to author the creative.", @@ -12970,7 +13002,10 @@ "Google Web Designer used to author the creative.", "ACS-UI used to author the creative.", "Creative authoring source is Adobe.", - "Creative authoring source is Typeface.ai." + "Creative authoring source is Typeface.ai.", + "Creative authoring source is Rembrand.", + "Creative authoring source is Trackto.", + "Creative authoring source is Bornlogic." ], "type": "string" }, @@ -19091,7 +19126,7 @@ "type": "boolean" }, "adServingPlatformId": { - "description": "Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv", + "description": "Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint", "format": "int64", "type": "string" }, @@ -21207,7 +21242,7 @@ "type": "string" }, "adServingPlatformId": { - "description": "Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv", + "description": "Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint", "format": "int64", "type": "string" }, @@ -22130,6 +22165,10 @@ "$ref": "DimensionValue", "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." }, + "contextualKeywordTargeting": { + "$ref": "ContextualKeywordTargeting", + "description": "Optional. Contextual keyword targeting criteria." + }, "dayPartTargeting": { "$ref": "DayPartTargeting", "description": "Time and day targeting criteria." @@ -22482,13 +22521,15 @@ "AD_ID_OFFICIAL", "CLEARCAST", "DCM", - "ARPP" + "ARPP", + "CUSV" ], "enumDescriptions": [ "", "", "", "", + "", "" ], "type": "string" diff --git a/discovery/dfareporting-v5.json b/discovery/dfareporting-v5.json index 938fcc2f9ac..e3fbdf884b5 100644 --- a/discovery/dfareporting-v5.json +++ b/discovery/dfareporting-v5.json @@ -10005,7 +10005,7 @@ } } }, - "revision": "20251009", + "revision": "20251023", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -10529,6 +10529,10 @@ ], "type": "string" }, + "contextualKeywordTargeting": { + "$ref": "ContextualKeywordTargeting", + "description": "Optional. Contextual keyword targeting information for this ad." + }, "createInfo": { "$ref": "LastModifiedInfo", "description": "Information about the creation of this ad. This is a read-only field." @@ -12057,6 +12061,31 @@ }, "type": "object" }, + "ContextualKeyword": { + "description": "Contains information about a Contextual Keyword that can be targeted by ads.", + "id": "ContextualKeyword", + "properties": { + "keyword": { + "description": "The keyword that can be targeted by ads.", + "type": "string" + } + }, + "type": "object" + }, + "ContextualKeywordTargeting": { + "description": "Contextual Keyword Targeting.", + "id": "ContextualKeywordTargeting", + "properties": { + "keywords": { + "description": "Contextual keywords that this ad targets", + "items": { + "$ref": "ContextualKeyword" + }, + "type": "array" + } + }, + "type": "object" + }, "Conversion": { "description": "A Conversion represents when a user successfully performs a desired action after seeing an ad.", "id": "Conversion", @@ -12435,7 +12464,10 @@ "CREATIVE_AUTHORING_SOURCE_GWD", "CREATIVE_AUTHORING_SOURCE_ACS", "CREATIVE_AUTHORING_SOURCE_ADOBE", - "CREATIVE_AUTHORING_SOURCE_TYPEFACE_AI" + "CREATIVE_AUTHORING_SOURCE_TYPEFACE_AI", + "CREATIVE_AUTHORING_SOURCE_REMBRAND", + "CREATIVE_AUTHORING_SOURCE_TRACKTO_STUDIO", + "CREATIVE_AUTHORING_SOURCE_BORNLOGIC" ], "enumDescriptions": [ "DCM-UI or external API used to author the creative.", @@ -12444,7 +12476,10 @@ "Google Web Designer used to author the creative.", "ACS-UI used to author the creative.", "Creative authoring source is Adobe.", - "Creative authoring source is Typeface.ai." + "Creative authoring source is Typeface.ai.", + "Creative authoring source is Rembrand.", + "Creative authoring source is Trackto.", + "Creative authoring source is Bornlogic." ], "type": "string" }, @@ -18273,7 +18308,7 @@ "type": "boolean" }, "adServingPlatformId": { - "description": "Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv", + "description": "Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint", "format": "int64", "type": "string" }, @@ -20078,7 +20113,7 @@ "type": "string" }, "adServingPlatformId": { - "description": "Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv", + "description": "Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint", "format": "int64", "type": "string" }, @@ -21001,6 +21036,10 @@ "$ref": "DimensionValue", "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." }, + "contextualKeywordTargeting": { + "$ref": "ContextualKeywordTargeting", + "description": "Optional. Contextual keyword targeting criteria." + }, "dayPartTargeting": { "$ref": "DayPartTargeting", "description": "Time and day targeting criteria." @@ -21353,13 +21392,15 @@ "AD_ID_OFFICIAL", "CLEARCAST", "DCM", - "ARPP" + "ARPP", + "CUSV" ], "enumDescriptions": [ "", "", "", "", + "", "" ], "type": "string" diff --git a/src/apis/dfareporting/v4.ts b/src/apis/dfareporting/v4.ts index 3c0be6f9cc6..6a5a760a930 100644 --- a/src/apis/dfareporting/v4.ts +++ b/src/apis/dfareporting/v4.ts @@ -635,6 +635,10 @@ export namespace dfareporting_v4 { * Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard. */ compatibility?: string | null; + /** + * Optional. Contextual keyword targeting information for this ad. + */ + contextualKeywordTargeting?: Schema$ContextualKeywordTargeting; /** * Information about the creation of this ad. This is a read-only field. */ @@ -1803,6 +1807,24 @@ export namespace dfareporting_v4 { */ separator?: string | null; } + /** + * Contains information about a Contextual Keyword that can be targeted by ads. + */ + export interface Schema$ContextualKeyword { + /** + * The keyword that can be targeted by ads. + */ + keyword?: string | null; + } + /** + * Contextual Keyword Targeting. + */ + export interface Schema$ContextualKeywordTargeting { + /** + * Contextual keywords that this ad targets + */ + keywords?: Schema$ContextualKeyword[]; + } /** * A Conversion represents when a user successfully performs a desired action after seeing an ad. */ @@ -5414,7 +5436,7 @@ export namespace dfareporting_v4 { */ additionalSizes?: Schema$Size[]; /** - * Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv + * Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint */ adServingPlatformId?: string | null; /** @@ -6610,7 +6632,7 @@ export namespace dfareporting_v4 { */ accountId?: string | null; /** - * Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv + * Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint */ adServingPlatformId?: string | null; /** @@ -7228,6 +7250,10 @@ export namespace dfareporting_v4 { * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Optional. Contextual keyword targeting criteria. + */ + contextualKeywordTargeting?: Schema$ContextualKeywordTargeting; /** * Time and day targeting criteria. */ @@ -10359,6 +10385,7 @@ export namespace dfareporting_v4 { * // "clickThroughUrlSuffixProperties": {}, * // "comments": "my_comments", * // "compatibility": "my_compatibility", + * // "contextualKeywordTargeting": {}, * // "createInfo": {}, * // "creativeGroupAssignments": [], * // "creativeRotation": {}, @@ -10532,6 +10559,7 @@ export namespace dfareporting_v4 { * // "clickThroughUrlSuffixProperties": {}, * // "comments": "my_comments", * // "compatibility": "my_compatibility", + * // "contextualKeywordTargeting": {}, * // "createInfo": {}, * // "creativeGroupAssignments": [], * // "creativeRotation": {}, @@ -10578,6 +10606,7 @@ export namespace dfareporting_v4 { * // "clickThroughUrlSuffixProperties": {}, * // "comments": "my_comments", * // "compatibility": "my_compatibility", + * // "contextualKeywordTargeting": {}, * // "createInfo": {}, * // "creativeGroupAssignments": [], * // "creativeRotation": {}, @@ -10936,6 +10965,7 @@ export namespace dfareporting_v4 { * // "clickThroughUrlSuffixProperties": {}, * // "comments": "my_comments", * // "compatibility": "my_compatibility", + * // "contextualKeywordTargeting": {}, * // "createInfo": {}, * // "creativeGroupAssignments": [], * // "creativeRotation": {}, @@ -10982,6 +11012,7 @@ export namespace dfareporting_v4 { * // "clickThroughUrlSuffixProperties": {}, * // "comments": "my_comments", * // "compatibility": "my_compatibility", + * // "contextualKeywordTargeting": {}, * // "createInfo": {}, * // "creativeGroupAssignments": [], * // "creativeRotation": {}, @@ -11155,6 +11186,7 @@ export namespace dfareporting_v4 { * // "clickThroughUrlSuffixProperties": {}, * // "comments": "my_comments", * // "compatibility": "my_compatibility", + * // "contextualKeywordTargeting": {}, * // "createInfo": {}, * // "creativeGroupAssignments": [], * // "creativeRotation": {}, @@ -11201,6 +11233,7 @@ export namespace dfareporting_v4 { * // "clickThroughUrlSuffixProperties": {}, * // "comments": "my_comments", * // "compatibility": "my_compatibility", + * // "contextualKeywordTargeting": {}, * // "createInfo": {}, * // "creativeGroupAssignments": [], * // "creativeRotation": {}, @@ -44654,6 +44687,7 @@ export namespace dfareporting_v4 { * // "accountId": "my_accountId", * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "contextualKeywordTargeting": {}, * // "dayPartTargeting": {}, * // "geoTargeting": {}, * // "id": "my_id", @@ -44803,6 +44837,7 @@ export namespace dfareporting_v4 { * // "accountId": "my_accountId", * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "contextualKeywordTargeting": {}, * // "dayPartTargeting": {}, * // "geoTargeting": {}, * // "id": "my_id", @@ -44823,6 +44858,7 @@ export namespace dfareporting_v4 { * // "accountId": "my_accountId", * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "contextualKeywordTargeting": {}, * // "dayPartTargeting": {}, * // "geoTargeting": {}, * // "id": "my_id", @@ -45133,6 +45169,7 @@ export namespace dfareporting_v4 { * // "accountId": "my_accountId", * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "contextualKeywordTargeting": {}, * // "dayPartTargeting": {}, * // "geoTargeting": {}, * // "id": "my_id", @@ -45153,6 +45190,7 @@ export namespace dfareporting_v4 { * // "accountId": "my_accountId", * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "contextualKeywordTargeting": {}, * // "dayPartTargeting": {}, * // "geoTargeting": {}, * // "id": "my_id", @@ -45302,6 +45340,7 @@ export namespace dfareporting_v4 { * // "accountId": "my_accountId", * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "contextualKeywordTargeting": {}, * // "dayPartTargeting": {}, * // "geoTargeting": {}, * // "id": "my_id", @@ -45322,6 +45361,7 @@ export namespace dfareporting_v4 { * // "accountId": "my_accountId", * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "contextualKeywordTargeting": {}, * // "dayPartTargeting": {}, * // "geoTargeting": {}, * // "id": "my_id", diff --git a/src/apis/dfareporting/v5.ts b/src/apis/dfareporting/v5.ts index b26db73d480..e5a3e040909 100644 --- a/src/apis/dfareporting/v5.ts +++ b/src/apis/dfareporting/v5.ts @@ -629,6 +629,10 @@ export namespace dfareporting_v5 { * Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard. */ compatibility?: string | null; + /** + * Optional. Contextual keyword targeting information for this ad. + */ + contextualKeywordTargeting?: Schema$ContextualKeywordTargeting; /** * Information about the creation of this ad. This is a read-only field. */ @@ -1760,6 +1764,24 @@ export namespace dfareporting_v5 { */ separator?: string | null; } + /** + * Contains information about a Contextual Keyword that can be targeted by ads. + */ + export interface Schema$ContextualKeyword { + /** + * The keyword that can be targeted by ads. + */ + keyword?: string | null; + } + /** + * Contextual Keyword Targeting. + */ + export interface Schema$ContextualKeywordTargeting { + /** + * Contextual keywords that this ad targets + */ + keywords?: Schema$ContextualKeyword[]; + } /** * A Conversion represents when a user successfully performs a desired action after seeing an ad. */ @@ -5110,7 +5132,7 @@ export namespace dfareporting_v5 { */ additionalSizes?: Schema$Size[]; /** - * Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv + * Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint */ adServingPlatformId?: string | null; /** @@ -6152,7 +6174,7 @@ export namespace dfareporting_v5 { */ accountId?: string | null; /** - * Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv + * Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint */ adServingPlatformId?: string | null; /** @@ -6770,6 +6792,10 @@ export namespace dfareporting_v5 { * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Optional. Contextual keyword targeting criteria. + */ + contextualKeywordTargeting?: Schema$ContextualKeywordTargeting; /** * Time and day targeting criteria. */ @@ -9901,6 +9927,7 @@ export namespace dfareporting_v5 { * // "clickThroughUrlSuffixProperties": {}, * // "comments": "my_comments", * // "compatibility": "my_compatibility", + * // "contextualKeywordTargeting": {}, * // "createInfo": {}, * // "creativeGroupAssignments": [], * // "creativeRotation": {}, @@ -10074,6 +10101,7 @@ export namespace dfareporting_v5 { * // "clickThroughUrlSuffixProperties": {}, * // "comments": "my_comments", * // "compatibility": "my_compatibility", + * // "contextualKeywordTargeting": {}, * // "createInfo": {}, * // "creativeGroupAssignments": [], * // "creativeRotation": {}, @@ -10120,6 +10148,7 @@ export namespace dfareporting_v5 { * // "clickThroughUrlSuffixProperties": {}, * // "comments": "my_comments", * // "compatibility": "my_compatibility", + * // "contextualKeywordTargeting": {}, * // "createInfo": {}, * // "creativeGroupAssignments": [], * // "creativeRotation": {}, @@ -10478,6 +10507,7 @@ export namespace dfareporting_v5 { * // "clickThroughUrlSuffixProperties": {}, * // "comments": "my_comments", * // "compatibility": "my_compatibility", + * // "contextualKeywordTargeting": {}, * // "createInfo": {}, * // "creativeGroupAssignments": [], * // "creativeRotation": {}, @@ -10524,6 +10554,7 @@ export namespace dfareporting_v5 { * // "clickThroughUrlSuffixProperties": {}, * // "comments": "my_comments", * // "compatibility": "my_compatibility", + * // "contextualKeywordTargeting": {}, * // "createInfo": {}, * // "creativeGroupAssignments": [], * // "creativeRotation": {}, @@ -10697,6 +10728,7 @@ export namespace dfareporting_v5 { * // "clickThroughUrlSuffixProperties": {}, * // "comments": "my_comments", * // "compatibility": "my_compatibility", + * // "contextualKeywordTargeting": {}, * // "createInfo": {}, * // "creativeGroupAssignments": [], * // "creativeRotation": {}, @@ -10743,6 +10775,7 @@ export namespace dfareporting_v5 { * // "clickThroughUrlSuffixProperties": {}, * // "comments": "my_comments", * // "compatibility": "my_compatibility", + * // "contextualKeywordTargeting": {}, * // "createInfo": {}, * // "creativeGroupAssignments": [], * // "creativeRotation": {}, @@ -42856,6 +42889,7 @@ export namespace dfareporting_v5 { * // "accountId": "my_accountId", * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "contextualKeywordTargeting": {}, * // "dayPartTargeting": {}, * // "geoTargeting": {}, * // "id": "my_id", @@ -43005,6 +43039,7 @@ export namespace dfareporting_v5 { * // "accountId": "my_accountId", * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "contextualKeywordTargeting": {}, * // "dayPartTargeting": {}, * // "geoTargeting": {}, * // "id": "my_id", @@ -43025,6 +43060,7 @@ export namespace dfareporting_v5 { * // "accountId": "my_accountId", * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "contextualKeywordTargeting": {}, * // "dayPartTargeting": {}, * // "geoTargeting": {}, * // "id": "my_id", @@ -43335,6 +43371,7 @@ export namespace dfareporting_v5 { * // "accountId": "my_accountId", * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "contextualKeywordTargeting": {}, * // "dayPartTargeting": {}, * // "geoTargeting": {}, * // "id": "my_id", @@ -43355,6 +43392,7 @@ export namespace dfareporting_v5 { * // "accountId": "my_accountId", * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "contextualKeywordTargeting": {}, * // "dayPartTargeting": {}, * // "geoTargeting": {}, * // "id": "my_id", @@ -43504,6 +43542,7 @@ export namespace dfareporting_v5 { * // "accountId": "my_accountId", * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "contextualKeywordTargeting": {}, * // "dayPartTargeting": {}, * // "geoTargeting": {}, * // "id": "my_id", @@ -43524,6 +43563,7 @@ export namespace dfareporting_v5 { * // "accountId": "my_accountId", * // "advertiserId": "my_advertiserId", * // "advertiserIdDimensionValue": {}, + * // "contextualKeywordTargeting": {}, * // "dayPartTargeting": {}, * // "geoTargeting": {}, * // "id": "my_id", From 5fe9de61a1c0941200bd33d0bfca8d7839d620f7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:14 +0000 Subject: [PATCH 11/31] feat(discoveryengine)!: update the API BREAKING CHANGE: This release has breaking changes. #### discoveryengine:v1alpha The following keys were deleted: - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.experimentalFeatures.additionalProperties.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.experimentalFeatures.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.experimentalFeatures.type The following keys were added: - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.get.description - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.get.flatPath - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.get.httpMethod - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.get.id - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.get.parameterOrder - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.get.parameters.name.description - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.get.parameters.name.location - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.get.parameters.name.pattern - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.get.parameters.name.required - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.get.parameters.name.type - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.get.path - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.get.response.$ref - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.get.scopes - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.description - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.flatPath - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.httpMethod - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.id - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.parameterOrder - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.parameters.pageSize.description - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.parameters.pageSize.format - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.parameters.pageSize.location - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.parameters.pageSize.type - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.parameters.pageToken.description - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.parameters.pageToken.location - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.parameters.pageToken.type - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.parameters.parent.description - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.parameters.parent.location - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.parameters.parent.pattern - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.parameters.parent.required - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.parameters.parent.type - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.path - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.response.$ref - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.scopes - resources.media.methods.upload.description - resources.media.methods.upload.flatPath - resources.media.methods.upload.httpMethod - resources.media.methods.upload.id - resources.media.methods.upload.mediaUpload.accept - resources.media.methods.upload.mediaUpload.protocols.simple.multipart - resources.media.methods.upload.mediaUpload.protocols.simple.path - resources.media.methods.upload.parameterOrder - resources.media.methods.upload.parameters.name.description - resources.media.methods.upload.parameters.name.location - resources.media.methods.upload.parameters.name.pattern - resources.media.methods.upload.parameters.name.required - resources.media.methods.upload.parameters.name.type - resources.media.methods.upload.path - resources.media.methods.upload.request.$ref - resources.media.methods.upload.response.$ref - resources.media.methods.upload.scopes - resources.media.methods.upload.supportsMediaUpload - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.request.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.create.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.create.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.create.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.create.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.create.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.create.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.create.request.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.create.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.create.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.delete.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.delete.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.delete.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.delete.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.delete.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.delete.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.delete.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.delete.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.get.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.get.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.get.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.get.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.get.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.get.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.get.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.get.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.get.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.get.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.get.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.get.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.request.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.files.methods.import.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.files.methods.import.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.files.methods.import.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.files.methods.import.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.files.methods.import.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.files.methods.import.parameters.parent.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.files.methods.import.parameters.parent.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.files.methods.import.parameters.parent.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.files.methods.import.parameters.parent.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.files.methods.import.parameters.parent.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.files.methods.import.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.files.methods.import.request.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.files.methods.import.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.files.methods.import.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.request.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.scopes - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.description - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.flatPath - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.httpMethod - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.id - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.parameterOrder - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.path - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.request.$ref - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.response.$ref - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.scopes - schemas.GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition.description - schemas.GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition.id - schemas.GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition.properties.jsonAgentCard.description - schemas.GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition.properties.jsonAgentCard.type - schemas.GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition.type - schemas.GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition.description - schemas.GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition.id - schemas.GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition.properties.provisionedReasoningEngine.$ref - schemas.GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition.properties.provisionedReasoningEngine.description - schemas.GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition.type - schemas.GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine.description - schemas.GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine.id - schemas.GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine.properties.reasoningEngine.description - schemas.GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine.properties.reasoningEngine.type - schemas.GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine.type - schemas.GoogleCloudDiscoveryengineV1alphaAgent.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.id - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.a2aAgentDefinition.$ref - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.a2aAgentDefinition.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.adkAgentDefinition.$ref - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.adkAgentDefinition.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.authorizationConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.authorizationConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.createTime.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.customPlaceholderText.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.customPlaceholderText.type - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.deploymentFailureReason.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.deploymentFailureReason.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.deploymentFailureReason.type - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.description.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.description.type - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.dialogflowAgentDefinition.$ref - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.dialogflowAgentDefinition.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.displayName.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.displayName.type - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.icon.$ref - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.icon.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.languageCode.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.languageCode.type - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.name.type - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.rejectionReason.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.rejectionReason.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.rejectionReason.type - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.starterPrompts.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.starterPrompts.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.starterPrompts.type - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.state.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.state.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.state.type - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.suspensionReason.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.suspensionReason.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.suspensionReason.type - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.updateTime.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1alphaAgent.type - schemas.GoogleCloudDiscoveryengineV1alphaAgentFile.description - schemas.GoogleCloudDiscoveryengineV1alphaAgentFile.id - schemas.GoogleCloudDiscoveryengineV1alphaAgentFile.properties.fileName.description - schemas.GoogleCloudDiscoveryengineV1alphaAgentFile.properties.fileName.type - schemas.GoogleCloudDiscoveryengineV1alphaAgentFile.properties.mimeType.description - schemas.GoogleCloudDiscoveryengineV1alphaAgentFile.properties.mimeType.type - schemas.GoogleCloudDiscoveryengineV1alphaAgentFile.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaAgentFile.properties.name.type - schemas.GoogleCloudDiscoveryengineV1alphaAgentFile.type - schemas.GoogleCloudDiscoveryengineV1alphaAgentImage.description - schemas.GoogleCloudDiscoveryengineV1alphaAgentImage.id - schemas.GoogleCloudDiscoveryengineV1alphaAgentImage.properties.content.description - schemas.GoogleCloudDiscoveryengineV1alphaAgentImage.properties.content.type - schemas.GoogleCloudDiscoveryengineV1alphaAgentImage.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1alphaAgentImage.properties.uri.type - schemas.GoogleCloudDiscoveryengineV1alphaAgentImage.type - schemas.GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt.description - schemas.GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt.id - schemas.GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt.properties.text.description - schemas.GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt.properties.text.type - schemas.GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt.type - schemas.GoogleCloudDiscoveryengineV1alphaAuthorizationConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaAuthorizationConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaAuthorizationConfig.properties.agentAuthorization.description - schemas.GoogleCloudDiscoveryengineV1alphaAuthorizationConfig.properties.agentAuthorization.type - schemas.GoogleCloudDiscoveryengineV1alphaAuthorizationConfig.properties.toolAuthorizations.description - schemas.GoogleCloudDiscoveryengineV1alphaAuthorizationConfig.properties.toolAuthorizations.items.type - schemas.GoogleCloudDiscoveryengineV1alphaAuthorizationConfig.properties.toolAuthorizations.type - schemas.GoogleCloudDiscoveryengineV1alphaAuthorizationConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.autoRenew.description - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.autoRenew.type - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.endDate.$ref - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.endDate.description - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.geminiBundle.description - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.geminiBundle.type - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.licenseConfigDistributions.additionalProperties.format - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.licenseConfigDistributions.additionalProperties.type - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.licenseConfigDistributions.description - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.licenseConfigDistributions.type - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.licenseCount.description - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.licenseCount.format - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.licenseCount.type - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.name.type - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.procurementEntitlementId.description - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.procurementEntitlementId.type - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.startDate.$ref - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.startDate.description - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.state.description - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.state.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.state.type - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.subscriptionDisplayName.description - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.subscriptionDisplayName.type - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.subscriptionName.description - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.subscriptionName.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.subscriptionName.type - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.subscriptionTerm.description - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.subscriptionTerm.enum - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.subscriptionTerm.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.subscriptionTerm.type - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.subscriptionTier.description - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.subscriptionTier.enum - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.subscriptionTier.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.properties.subscriptionTier.type - schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition.description - schemas.GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition.id - schemas.GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition.properties.dialogflowAgent.description - schemas.GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition.properties.dialogflowAgent.type - schemas.GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition.type - schemas.GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest.description - schemas.GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest.id - schemas.GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest.properties.fileName.description - schemas.GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest.properties.fileName.type - schemas.GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest.properties.mimeType.description - schemas.GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest.properties.mimeType.type - schemas.GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest.type - schemas.GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse.properties.agentFile.$ref - schemas.GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse.properties.agentFile.description - schemas.GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaListAgentsResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaListAgentsResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaListAgentsResponse.properties.agents.description - schemas.GoogleCloudDiscoveryengineV1alphaListAgentsResponse.properties.agents.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaListAgentsResponse.properties.agents.type - schemas.GoogleCloudDiscoveryengineV1alphaListAgentsResponse.properties.nextPageToken.description - schemas.GoogleCloudDiscoveryengineV1alphaListAgentsResponse.properties.nextPageToken.type - schemas.GoogleCloudDiscoveryengineV1alphaListAgentsResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse.properties.billingAccountLicenseConfigs.description - schemas.GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse.properties.billingAccountLicenseConfigs.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse.properties.billingAccountLicenseConfigs.type - schemas.GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse.properties.nextPageToken.description - schemas.GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse.properties.nextPageToken.type - schemas.GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest.description - schemas.GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest.id - schemas.GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest.properties.blob.$ref - schemas.GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest.properties.blob.description - schemas.GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest.properties.mediaRequestInfo.$ref - schemas.GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest.properties.mediaRequestInfo.description - schemas.GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest.type - schemas.GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse.properties.agentFile.$ref - schemas.GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse.properties.agentFile.description - schemas.GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse.properties.mediaResponseInfo.$ref - schemas.GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse.properties.mediaResponseInfo.description - schemas.GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.searchAddonSpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.searchAddonSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec.properties.generativeAnswerAddOnDisabled.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec.properties.generativeAnswerAddOnDisabled.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec.properties.kpiPersonalizationAddOnDisabled.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec.properties.kpiPersonalizationAddOnDisabled.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec.properties.semanticAddOnDisabled.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec.properties.semanticAddOnDisabled.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec.type The following keys were changed: - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.completeQuery.parameters.userPseudoId.description - resources.projects.resources.locations.resources.dataStores.methods.completeQuery.parameters.userPseudoId.description - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest.properties.userPseudoId.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.userPseudoId.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting.properties.shortcuts.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.userPseudoId.description #### discoveryengine:v1beta The following keys were added: - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.type The following keys were changed: - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.completeQuery.parameters.userPseudoId.description - resources.projects.resources.locations.resources.dataStores.methods.completeQuery.parameters.userPseudoId.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.userPseudoId.description - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest.properties.userPseudoId.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.userPseudoId.description #### discoveryengine:v1 The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.scopes - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.scopes - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.flatPath - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.httpMethod - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.id - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameterOrder - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.location - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.required - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.parameters.name.type - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.path - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.response.$ref - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.scopes - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.flatPath - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.httpMethod - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.id - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameterOrder - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.path - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.response.$ref - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.scopes - schemas.GoogleCloudDiscoveryengineV1ListServingConfigsResponse.description - schemas.GoogleCloudDiscoveryengineV1ListServingConfigsResponse.id - schemas.GoogleCloudDiscoveryengineV1ListServingConfigsResponse.properties.nextPageToken.description - schemas.GoogleCloudDiscoveryengineV1ListServingConfigsResponse.properties.nextPageToken.type - schemas.GoogleCloudDiscoveryengineV1ListServingConfigsResponse.properties.servingConfigs.description - schemas.GoogleCloudDiscoveryengineV1ListServingConfigsResponse.properties.servingConfigs.items.$ref - schemas.GoogleCloudDiscoveryengineV1ListServingConfigsResponse.properties.servingConfigs.type - schemas.GoogleCloudDiscoveryengineV1ListServingConfigsResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata.type The following keys were changed: - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.completeQuery.parameters.userPseudoId.description - resources.projects.resources.locations.resources.dataStores.methods.completeQuery.parameters.userPseudoId.description - schemas.GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest.properties.userPseudoId.description - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.userPseudoId.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.userPseudoId.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.userPseudoId.description --- discovery/discoveryengine-v1.json | 238 +- discovery/discoveryengine-v1alpha.json | 900 ++++++- discovery/discoveryengine-v1beta.json | 29 +- src/apis/discoveryengine/v1.ts | 1982 +++++++++++---- src/apis/discoveryengine/v1alpha.ts | 3121 ++++++++++++++++++++++-- src/apis/discoveryengine/v1beta.ts | 27 +- 6 files changed, 5624 insertions(+), 673 deletions(-) diff --git a/discovery/discoveryengine-v1.json b/discovery/discoveryengine-v1.json index c742b5e8d8d..d5a57a50916 100644 --- a/discovery/discoveryengine-v1.json +++ b/discovery/discoveryengine-v1.json @@ -730,7 +730,7 @@ "type": "string" }, "userPseudoId": { - "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } @@ -2281,6 +2281,69 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, + "get": { + "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "list": { + "description": "Lists all ServingConfigs linked to this dataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/servingConfigs", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1ListServingConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, "patch": { "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", @@ -4238,6 +4301,69 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, + "get": { + "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "list": { + "description": "Lists all ServingConfigs linked to this dataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/servingConfigs", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1ListServingConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, "patch": { "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}", @@ -4717,7 +4843,7 @@ "type": "string" }, "userPseudoId": { - "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } @@ -6130,6 +6256,69 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, + "get": { + "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.servingConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "list": { + "description": "Lists all ServingConfigs linked to this dataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.servingConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/servingConfigs", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1ListServingConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, "patch": { "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", @@ -8078,7 +8267,7 @@ } } }, - "revision": "20251026", + "revision": "20251030", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -9033,7 +9222,7 @@ "description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info." }, "userPseudoId": { - "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128", + "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128", "type": "string" } }, @@ -15378,6 +15567,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ListServingConfigsResponse": { + "description": "Response for ListServingConfigs method.", + "id": "GoogleCloudDiscoveryengineV1ListServingConfigsResponse", + "properties": { + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", + "type": "string" + }, + "servingConfigs": { + "description": "All the ServingConfigs for a given dataStore.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ListSessionsResponse": { "description": "Response for ListSessions method.", "id": "GoogleCloudDiscoveryengineV1ListSessionsResponse", @@ -16489,7 +16696,7 @@ "type": "object" }, "userPseudoId": { - "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, @@ -21378,6 +21585,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata": { + "description": "Metadata related to the progress of the AgentService.DeleteAgent operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata": { "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata", @@ -24046,7 +24270,7 @@ "type": "object" }, "userPseudoId": { - "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, @@ -27989,7 +28213,7 @@ "type": "object" }, "userPseudoId": { - "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, diff --git a/discovery/discoveryengine-v1alpha.json b/discovery/discoveryengine-v1alpha.json index fcc9a29add6..573ca1adf6e 100644 --- a/discovery/discoveryengine-v1alpha.json +++ b/discovery/discoveryengine-v1alpha.json @@ -174,6 +174,69 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, + "get": { + "description": "Gets a BillingAccountLicenseConfig.", + "flatPath": "v1alpha/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}", + "httpMethod": "GET", + "id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.", + "location": "path", + "pattern": "^billingAccounts/[^/]+/billingAccountLicenseConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "list": { + "description": "Lists all BillingAccountLicenseConfigs for a given billing account.", + "flatPath": "v1alpha/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs", + "httpMethod": "GET", + "id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Not supported.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Not supported.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: `billingAccounts/{billing_account}`.", + "location": "path", + "pattern": "^billingAccounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/billingAccountLicenseConfigs", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, "retractLicenseConfig": { "description": "This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.", "flatPath": "v1alpha/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:retractLicenseConfig", @@ -247,6 +310,48 @@ ], "supportsMediaDownload": true, "useMediaDownloadService": true + }, + "upload": { + "description": "Uploads a file for the assistant to use as a source of information within the session.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}:uploadFile", + "httpMethod": "POST", + "id": "discoveryengine.media.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/v1alpha/{+name}:uploadFile" + } + } + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:uploadFile", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ], + "supportsMediaUpload": true } } }, @@ -1510,7 +1615,7 @@ "type": "string" }, "userPseudoId": { - "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } @@ -4648,6 +4753,42 @@ "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite" ] + }, + "patch": { + "description": "Update a WidgetConfig.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.collections.dataStores.widgetConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] } } } @@ -5063,6 +5204,209 @@ } }, "resources": { + "agents": { + "methods": { + "create": { + "description": "Creates an Agent.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/agents", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAgent" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAgent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "delete": { + "description": "Deletes an Agent.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` If the caller does not have permission to delete the agent, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the agent to delete does not exist, a `NOT_FOUND` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "get": { + "description": "Gets an Agent.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAgent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "list": { + "description": "Lists all Agents under an Assistant which were created by the caller.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `is_pinned` Example: * \"update_time desc\" * \"is_pinned desc,update_time desc\": list agents by is_pinned first, then by update_time.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of Agents to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token ListAgentsResponse.next_page_token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAgents must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/agents", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListAgentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "patch": { + "description": "Updates an Agent", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAgent" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAgent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + } + }, + "resources": { + "files": { + "methods": { + "import": { + "description": "Imports a file to an Agent. Currently only No-Code agents are supported.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/files:import", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.files.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/files:import", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + } + } + } + } + }, "cannedQueries": { "methods": { "create": { @@ -6290,6 +6634,42 @@ "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite" ] + }, + "patch": { + "description": "Update a WidgetConfig.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/widgetConfigs/{widgetConfigsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.collections.engines.widgetConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/widgetConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] } } } @@ -6408,7 +6788,7 @@ "type": "string" }, "userPseudoId": { - "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } @@ -9131,6 +9511,42 @@ "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite" ] + }, + "patch": { + "description": "Update a WidgetConfig.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.dataStores.widgetConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] } } } @@ -11118,7 +11534,7 @@ } } }, - "revision": "20251026", + "revision": "20251030", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "ApiservingMediaRequestInfo": { @@ -15942,6 +16358,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition": { + "description": "Stored definition of an agent that uses A2A.", + "id": "GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition", + "properties": { + "jsonAgentCard": { + "description": "Optional. The agent card is a JSON string.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAclConfig": { "description": "Access Control Configuration.", "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", @@ -16010,6 +16437,28 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition": { + "description": "Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine).", + "id": "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition", + "properties": { + "provisionedReasoningEngine": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine", + "description": "Optional. The reasoning engine that the agent is connected to." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine": { + "description": "Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine.", + "id": "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine", + "properties": { + "reasoningEngine": { + "description": "Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest": { "description": "Request message for CompletionService.AdvancedCompleteQuery method. .", "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest", @@ -16072,7 +16521,7 @@ "description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info." }, "userPseudoId": { - "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128", + "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128", "type": "string" } }, @@ -16337,6 +16786,157 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaAgent": { + "description": "Performs a predefined, specific task.", + "id": "GoogleCloudDiscoveryengineV1alphaAgent", + "properties": { + "a2aAgentDefinition": { + "$ref": "GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition", + "description": "Optional. The behavior of the agent is defined as an A2A agent." + }, + "adkAgentDefinition": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition", + "description": "Optional. The behavior of the agent is defined as an ADK agent." + }, + "authorizationConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAuthorizationConfig", + "description": "Optional. The authorizations that are required by the agent." + }, + "createTime": { + "description": "Output only. Timestamp when this Agent was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customPlaceholderText": { + "description": "Optional. The custom placeholder text that appears in the text box before the user enters any text.", + "type": "string" + }, + "deploymentFailureReason": { + "description": "Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.", + "type": "string" + }, + "dialogflowAgentDefinition": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition", + "description": "Optional. The behavior of the agent is defined as a Dialogflow agent." + }, + "displayName": { + "description": "Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.", + "type": "string" + }, + "icon": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAgentImage", + "description": "Optional. The icon that represents the agent on the UI." + }, + "languageCode": { + "description": "Optional. The code of the language of the text in the description, display_name and starter_prompts fields.", + "type": "string" + }, + "name": { + "description": "Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`", + "type": "string" + }, + "rejectionReason": { + "description": "Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.", + "readOnly": true, + "type": "string" + }, + "starterPrompts": { + "description": "Optional. The starter prompt suggestions to show the user on the landing page of the agent.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt" + }, + "type": "array" + }, + "state": { + "description": "Output only. The lifecycle state of the agent.", + "enum": [ + "STATE_UNSPECIFIED", + "CONFIGURED", + "DEPLOYING", + "DISABLED", + "DEPLOYMENT_FAILED", + "PRIVATE", + "ENABLED", + "SUSPENDED" + ], + "enumDescriptions": [ + "The state is unspecified.", + "The agent is configured, but no deployment triggered yet.", + "The agent is being deployed.", + "The agent is available for admins only.", + "The agent deployment failed.", + "Agent is available only to its creator..", + "Agent is available for users who have access.", + "Agent is temporarily unavailable, though visible to users who have access." + ], + "readOnly": true, + "type": "string" + }, + "suspensionReason": { + "description": "Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this Agent was most recently updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAgentFile": { + "description": "Describes a file used internally by an agent as a context on each invocation.", + "id": "GoogleCloudDiscoveryengineV1alphaAgentFile", + "properties": { + "fileName": { + "description": "Required. The name of the file.", + "type": "string" + }, + "mimeType": { + "description": "Immutable. The content type of the file.", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the file. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}/files/{file}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAgentImage": { + "description": "Represents an image.", + "id": "GoogleCloudDiscoveryengineV1alphaAgentImage", + "properties": { + "content": { + "description": "Base64-encoded image file contents.", + "type": "string" + }, + "uri": { + "description": "Image URI.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt": { + "description": "The starter prompt suggestion to show the user on the landing page of the agent.", + "id": "GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt", + "properties": { + "text": { + "description": "Required. The text of the starter prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": { "description": "The connector level alert config.", "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig", @@ -18351,6 +18951,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaAuthorizationConfig": { + "description": "Describes the authorizations required.", + "id": "GoogleCloudDiscoveryengineV1alphaAuthorizationConfig", + "properties": { + "agentAuthorization": { + "description": "Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.", + "type": "string" + }, + "toolAuthorizations": { + "description": "Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2": { "description": "OAuth2 configuration.", "id": "GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2", @@ -18809,6 +19427,124 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig": { + "description": "Information about license configs at billing account level.", + "id": "GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig", + "properties": { + "autoRenew": { + "description": "Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date.", + "type": "boolean" + }, + "endDate": { + "$ref": "GoogleTypeDate", + "description": "Optional. The planed subscription end date." + }, + "geminiBundle": { + "description": "Whether the license config is for Gemini bundle.", + "type": "boolean" + }, + "licenseConfigDistributions": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "A map of LicenseConfig names to the number of licenses distributed to each. The key is the full resource name of the LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/{license_config}`. The value is the count of licenses allocated to it.", + "type": "object" + }, + "licenseCount": { + "description": "Required. The number of licenses purchased under this billing account license config.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Immutable. Identifier. The fully qualified resource name of the billing account license config. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config}`.", + "type": "string" + }, + "procurementEntitlementId": { + "description": "The procurement entitlement id of the subscription.", + "type": "string" + }, + "startDate": { + "$ref": "GoogleTypeDate", + "description": "Required. The subscription start date." + }, + "state": { + "description": "Output only. The state of the BillingAccountLicenseConfig.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "EXPIRED", + "NOT_STARTED" + ], + "enumDescriptions": [ + "The BillingAccountLicenseConfig does not exist. Default value. Do not use.", + "The BillingAccountLicenseConfig is active and being used.", + "The BillingAccountLicenseConfig has expired.", + "The BillingAccountLicenseConfig has not started yet, and its start date is in the future." + ], + "readOnly": true, + "type": "string" + }, + "subscriptionDisplayName": { + "description": "The subscription display name.", + "type": "string" + }, + "subscriptionName": { + "description": "Output only. The corresponding SubV3 subscription name.", + "readOnly": true, + "type": "string" + }, + "subscriptionTerm": { + "description": "Required. The subscription term.", + "enum": [ + "SUBSCRIPTION_TERM_UNSPECIFIED", + "SUBSCRIPTION_TERM_ONE_MONTH", + "SUBSCRIPTION_TERM_ONE_YEAR", + "SUBSCRIPTION_TERM_THREE_YEARS" + ], + "enumDescriptions": [ + "Default value, do not use.", + "1 month.", + "1 year.", + "3 years." + ], + "type": "string" + }, + "subscriptionTier": { + "description": "Required. The subscription tier.", + "enum": [ + "SUBSCRIPTION_TIER_UNSPECIFIED", + "SUBSCRIPTION_TIER_SEARCH", + "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", + "SUBSCRIPTION_TIER_NOTEBOOK_LM", + "SUBSCRIPTION_TIER_FRONTLINE_WORKER", + "SUBSCRIPTION_TIER_AGENTSPACE_STARTER", + "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", + "SUBSCRIPTION_TIER_ENTERPRISE", + "SUBSCRIPTION_TIER_EDU", + "SUBSCRIPTION_TIER_EDU_PRO", + "SUBSCRIPTION_TIER_EDU_EMERGING", + "SUBSCRIPTION_TIER_EDU_PRO_EMERGING" + ], + "enumDescriptions": [ + "Default value.", + "Search tier. Search tier can access VAIS search features and NotebookLM features.", + "Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.", + "NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", + "Frontline worker tier.", + "Agentspace Starter tier.", + "Agentspace Business tier.", + "Enterprise tier.", + "EDU tier.", + "EDU Pro tier.", + "EDU emerging market tier.", + "EDU Pro emerging market tier." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaBranch": { "description": "A data branch that stores Documents.", "id": "GoogleCloudDiscoveryengineV1alphaBranch", @@ -21320,6 +22056,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata": { + "description": "Metadata related to the progress of the AgentService.DeleteAgent operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata": { "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata", @@ -21530,6 +22283,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition": { + "description": "Stored definition of an agent that uses a Dialogflow agent.", + "id": "GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition", + "properties": { + "dialogflowAgent": { + "description": "Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", @@ -23340,6 +24104,32 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest": { + "description": "Request for the AgentService.ImportAgentFile method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest", + "properties": { + "fileName": { + "description": "Required. The name of the file.", + "type": "string" + }, + "mimeType": { + "description": "Optional. The content type of the file, see https://www.iana.org/assignments/media-types/media-types.xhtml. This field is required when the data source does not provide the content type.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse": { + "description": "Response for the AgentService.ImportAgentFile method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse", + "properties": { + "agentFile": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAgentFile", + "description": "The imported AgentFile." + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", @@ -24022,6 +24812,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaListAgentsResponse": { + "description": "Response message for the AgentService.ListAgents method.", + "id": "GoogleCloudDiscoveryengineV1alphaListAgentsResponse", + "properties": { + "agents": { + "description": "The agents visible to the caller under the parent Assistant.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAgent" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as ListAgentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse": { "description": "Response message for the AuthorizationService.ListAuthorizations method.", "id": "GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse", @@ -24040,6 +24848,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse": { + "description": "Response message for LicenseConfigService.ListBillingAccountLicenseConfigs method.", + "id": "GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse", + "properties": { + "billingAccountLicenseConfigs": { + "description": "All BillingAccountLicenseConfigs for the given billing account.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as ListBillingAccountLicenseConfigsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaListBranchesResponse": { "description": "Response for BranchService.ListBranches method.", "id": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse", @@ -26373,7 +27199,7 @@ "type": "object" }, "userPseudoId": { - "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, @@ -28919,6 +29745,36 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest": { + "description": "Request message for the AgentService.UploadAgentFile method.", + "id": "GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest", + "properties": { + "blob": { + "$ref": "GdataMedia", + "description": "Information about the file being uploaded." + }, + "mediaRequestInfo": { + "$ref": "ApiservingMediaRequestInfo", + "description": "Media upload request metadata." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse": { + "description": "Response message for the AgentService.UploadAgentFile method.", + "id": "GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse", + "properties": { + "agentFile": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAgentFile", + "description": "The uploaded AgentFile." + }, + "mediaResponseInfo": { + "$ref": "ApiservingMediaResponseInfo", + "description": "Media upload response metadata." + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest": { "description": "Request for the AssistantService.UploadSessionFile method.", "id": "GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest", @@ -29363,13 +30219,6 @@ "description": "Whether to enable standalone web app.", "type": "boolean" }, - "experimentalFeatures": { - "additionalProperties": { - "type": "string" - }, - "description": "Allows to toggle unstable/experimental features in the widget (or web app)", - "type": "object" - }, "facetField": { "deprecated": true, "description": "The configuration and appearance of facets in the end user view.", @@ -29741,7 +30590,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting", "properties": { "shortcuts": { - "description": "Optional. The shortcuts to display on the homepage. LINT.IfChange(max_shortcuts_number) LINT.ThenChange( //depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number )", + "description": "Optional. The shortcuts to display on the homepage.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut" }, @@ -29921,6 +30770,10 @@ "Display results from extractive answers field." ], "type": "string" + }, + "searchAddonSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec", + "description": "Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests." } }, "type": "object" @@ -29986,6 +30839,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec": { + "description": "SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec", + "properties": { + "generativeAnswerAddOnDisabled": { + "description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.", + "type": "boolean" + }, + "kpiPersonalizationAddOnDisabled": { + "description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.", + "type": "boolean" + }, + "semanticAddOnDisabled": { + "description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", @@ -32709,7 +33581,7 @@ "type": "object" }, "userPseudoId": { - "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, diff --git a/discovery/discoveryengine-v1beta.json b/discovery/discoveryengine-v1beta.json index 27933e7c8ab..dd46de787e9 100644 --- a/discovery/discoveryengine-v1beta.json +++ b/discovery/discoveryengine-v1beta.json @@ -656,7 +656,7 @@ "type": "string" }, "userPseudoId": { - "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } @@ -4857,7 +4857,7 @@ "type": "string" }, "userPseudoId": { - "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } @@ -8802,7 +8802,7 @@ } } }, - "revision": "20251026", + "revision": "20251030", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -16249,6 +16249,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata": { + "description": "Metadata related to the progress of the AgentService.DeleteAgent operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata": { "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata", @@ -18917,7 +18934,7 @@ "type": "object" }, "userPseudoId": { - "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, @@ -20270,7 +20287,7 @@ "description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info." }, "userPseudoId": { - "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128", + "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128", "type": "string" } }, @@ -27872,7 +27889,7 @@ "type": "object" }, "userPseudoId": { - "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, diff --git a/src/apis/discoveryengine/v1.ts b/src/apis/discoveryengine/v1.ts index a98cf45284b..9428efd0520 100644 --- a/src/apis/discoveryengine/v1.ts +++ b/src/apis/discoveryengine/v1.ts @@ -846,7 +846,7 @@ export namespace discoveryengine_v1 { */ userInfo?: Schema$GoogleCloudDiscoveryengineV1UserInfo; /** - * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 + * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 */ userPseudoId?: string | null; } @@ -2860,6 +2860,19 @@ export namespace discoveryengine_v1 { */ userTriggeredCrawlRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries; } + /** + * Metadata related to the progress of the AgentService.DeleteAgent operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } /** * Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -4665,7 +4678,7 @@ export namespace discoveryengine_v1 { */ userLabels?: {[key: string]: string} | null; /** - * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ userPseudoId?: string | null; } @@ -8763,7 +8776,7 @@ export namespace discoveryengine_v1 { */ userLabels?: {[key: string]: string} | null; /** - * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ userPseudoId?: string | null; } @@ -12248,6 +12261,19 @@ export namespace discoveryengine_v1 { */ schemas?: Schema$GoogleCloudDiscoveryengineV1Schema[]; } + /** + * Response for ListServingConfigs method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse { + /** + * Pagination token, if not returned indicates the last page. + */ + nextPageToken?: string | null; + /** + * All the ServingConfigs for a given dataStore. + */ + servingConfigs?: Schema$GoogleCloudDiscoveryengineV1ServingConfig[]; + } /** * Response for ListSessions method. */ @@ -13067,7 +13093,7 @@ export namespace discoveryengine_v1 { */ userLabels?: {[key: string]: string} | null; /** - * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ userPseudoId?: string | null; } @@ -18067,7 +18093,7 @@ export namespace discoveryengine_v1 { * query: 'placeholder-value', * // Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. * queryModel: 'placeholder-value', - * // A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * // Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. * userPseudoId: 'placeholder-value', * }, * ); @@ -19393,7 +19419,7 @@ export namespace discoveryengine_v1 { */ queryModel?: string; /** - * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ userPseudoId?: string; } @@ -26293,7 +26319,7 @@ export namespace discoveryengine_v1 { } /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * @example * ```js * // Before running the sample: @@ -26326,39 +26352,10 @@ export namespace discoveryengine_v1 { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.patch( + * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.get( * { - * // Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + * // Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', - * // Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "answerGenerationSpec": {}, - * // "boostControlIds": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "dissociateControlIds": [], - * // "diversityLevel": "my_diversityLevel", - * // "filterControlIds": [], - * // "genericConfig": {}, - * // "ignoreControlIds": [], - * // "mediaConfig": {}, - * // "modelId": "my_modelId", - * // "name": "my_name", - * // "onewaySynonymsControlIds": [], - * // "promoteControlIds": [], - * // "rankingExpression": "my_rankingExpression", - * // "redirectControlIds": [], - * // "replacementControlIds": [], - * // "solutionType": "my_solutionType", - * // "synonymsControlIds": [], - * // "updateTime": "my_updateTime" - * // } - * }, * }, * ); * console.log(res.data); @@ -26400,38 +26397,38 @@ export namespace discoveryengine_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, callback: BodyResponseCallback ): void; - patch( + get( callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -26449,13 +26446,13 @@ export namespace discoveryengine_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; options = {}; } @@ -26470,7 +26467,7 @@ export namespace discoveryengine_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -26493,7 +26490,7 @@ export namespace discoveryengine_v1 { } /** - * Makes a recommendation, which requires a contextual user event. + * Lists all ServingConfigs linked to this dataStore. * @example * ```js * // Before running the sample: @@ -26526,34 +26523,23 @@ export namespace discoveryengine_v1 { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend( + * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.list( * { - * // Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. - * servingConfig: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "pageSize": 0, - * // "params": {}, - * // "userEvent": {}, - * // "userLabels": {}, - * // "validateOnly": false - * // } - * }, + * // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', * }, * ); * console.log(res.data); * * // Example response * // { - * // "attributionToken": "my_attributionToken", - * // "missingIds": [], - * // "results": [], - * // "validateOnly": false + * // "nextPageToken": "my_nextPageToken", + * // "servingConfigs": [] * // } * } * @@ -26569,62 +26555,62 @@ export namespace discoveryengine_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions ): Promise>; - recommend( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - recommend( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; options = {}; } @@ -26638,34 +26624,34 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+servingConfig}:recommend').replace( + url: (rootUrl + '/v1/{+parent}/servingConfigs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Performs a search. + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * @example * ```js * // Before running the sample: @@ -26688,7 +26674,6 @@ export namespace discoveryengine_v1 { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -26699,47 +26684,37 @@ export namespace discoveryengine_v1 { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.search( + * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.patch( * { - * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - * servingConfig: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', + * // Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', + * // Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "boostSpec": {}, - * // "branch": "my_branch", - * // "canonicalFilter": "my_canonicalFilter", - * // "contentSearchSpec": {}, - * // "dataStoreSpecs": [], - * // "displaySpec": {}, - * // "facetSpecs": [], - * // "filter": "my_filter", - * // "imageQuery": {}, - * // "languageCode": "my_languageCode", - * // "naturalLanguageQueryUnderstandingSpec": {}, - * // "offset": 0, - * // "oneBoxPageSize": 0, - * // "orderBy": "my_orderBy", - * // "pageSize": 0, - * // "pageToken": "my_pageToken", - * // "params": {}, - * // "query": "my_query", - * // "queryExpansionSpec": {}, + * // "answerGenerationSpec": {}, + * // "boostControlIds": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "dissociateControlIds": [], + * // "diversityLevel": "my_diversityLevel", + * // "filterControlIds": [], + * // "genericConfig": {}, + * // "ignoreControlIds": [], + * // "mediaConfig": {}, + * // "modelId": "my_modelId", + * // "name": "my_name", + * // "onewaySynonymsControlIds": [], + * // "promoteControlIds": [], * // "rankingExpression": "my_rankingExpression", - * // "rankingExpressionBackend": "my_rankingExpressionBackend", - * // "relevanceScoreSpec": {}, - * // "relevanceThreshold": "my_relevanceThreshold", - * // "safeSearch": false, - * // "searchAsYouTypeSpec": {}, - * // "session": "my_session", - * // "sessionSpec": {}, - * // "spellCorrectionSpec": {}, - * // "userInfo": {}, - * // "userLabels": {}, - * // "userPseudoId": "my_userPseudoId" + * // "redirectControlIds": [], + * // "replacementControlIds": [], + * // "solutionType": "my_solutionType", + * // "synonymsControlIds": [], + * // "updateTime": "my_updateTime" * // } * }, * }, @@ -26748,17 +26723,26 @@ export namespace discoveryengine_v1 { * * // Example response * // { - * // "attributionToken": "my_attributionToken", - * // "correctedQuery": "my_correctedQuery", - * // "facets": [], - * // "nextPageToken": "my_nextPageToken", - * // "queryExpansionInfo": {}, - * // "redirectUri": "my_redirectUri", - * // "results": [], - * // "searchLinkPromotions": [], - * // "sessionInfo": {}, - * // "summary": {}, - * // "totalSize": 0 + * // "answerGenerationSpec": {}, + * // "boostControlIds": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "dissociateControlIds": [], + * // "diversityLevel": "my_diversityLevel", + * // "filterControlIds": [], + * // "genericConfig": {}, + * // "ignoreControlIds": [], + * // "mediaConfig": {}, + * // "modelId": "my_modelId", + * // "name": "my_name", + * // "onewaySynonymsControlIds": [], + * // "promoteControlIds": [], + * // "rankingExpression": "my_rankingExpression", + * // "redirectControlIds": [], + * // "replacementControlIds": [], + * // "solutionType": "my_solutionType", + * // "synonymsControlIds": [], + * // "updateTime": "my_updateTime" * // } * } * @@ -26774,62 +26758,62 @@ export namespace discoveryengine_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions ): Promise>; - search( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - search( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; options = {}; } @@ -26843,34 +26827,408 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+servingConfig}:search').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. + * Makes a recommendation, which requires a contextual user event. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend( + * { + * // Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + * servingConfig: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "pageSize": 0, + * // "params": {}, + * // "userEvent": {}, + * // "userLabels": {}, + * // "validateOnly": false + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "attributionToken": "my_attributionToken", + * // "missingIds": [], + * // "results": [], + * // "validateOnly": false + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + options: StreamMethodOptions + ): Promise>; + recommend( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + callback: BodyResponseCallback + ): void; + recommend( + callback: BodyResponseCallback + ): void; + recommend( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+servingConfig}:recommend').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Performs a search. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.search( + * { + * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * servingConfig: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "boostSpec": {}, + * // "branch": "my_branch", + * // "canonicalFilter": "my_canonicalFilter", + * // "contentSearchSpec": {}, + * // "dataStoreSpecs": [], + * // "displaySpec": {}, + * // "facetSpecs": [], + * // "filter": "my_filter", + * // "imageQuery": {}, + * // "languageCode": "my_languageCode", + * // "naturalLanguageQueryUnderstandingSpec": {}, + * // "offset": 0, + * // "oneBoxPageSize": 0, + * // "orderBy": "my_orderBy", + * // "pageSize": 0, + * // "pageToken": "my_pageToken", + * // "params": {}, + * // "query": "my_query", + * // "queryExpansionSpec": {}, + * // "rankingExpression": "my_rankingExpression", + * // "rankingExpressionBackend": "my_rankingExpressionBackend", + * // "relevanceScoreSpec": {}, + * // "relevanceThreshold": "my_relevanceThreshold", + * // "safeSearch": false, + * // "searchAsYouTypeSpec": {}, + * // "session": "my_session", + * // "sessionSpec": {}, + * // "spellCorrectionSpec": {}, + * // "userInfo": {}, + * // "userLabels": {}, + * // "userPseudoId": "my_userPseudoId" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "attributionToken": "my_attributionToken", + * // "correctedQuery": "my_correctedQuery", + * // "facets": [], + * // "nextPageToken": "my_nextPageToken", + * // "queryExpansionInfo": {}, + * // "redirectUri": "my_redirectUri", + * // "results": [], + * // "searchLinkPromotions": [], + * // "sessionInfo": {}, + * // "summary": {}, + * // "totalSize": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + options: StreamMethodOptions + ): Promise>; + search( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + callback: BodyResponseCallback + ): void; + search( + callback: BodyResponseCallback + ): void; + search( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+servingConfig}:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. * @example * ```js * // Before running the sample: @@ -27264,6 +27622,28 @@ export namespace discoveryengine_v1 { */ requestBody?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest; } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get + extends StandardParameters { + /** + * Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + */ + parent?: string; + } export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch extends StandardParameters { /** @@ -36683,18 +37063,578 @@ export namespace discoveryengine_v1 { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.operations.list( + * await discoveryengine.projects.locations.collections.engines.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleLongrunningCancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Answer query method. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.servingConfigs.answer( + * { + * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * servingConfig: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "answerGenerationSpec": {}, + * // "asynchronousMode": false, + * // "endUserSpec": {}, + * // "groundingSpec": {}, + * // "query": {}, + * // "queryUnderstandingSpec": {}, + * // "relatedQuestionsSpec": {}, + * // "safetySpec": {}, + * // "searchSpec": {}, + * // "session": "my_session", + * // "userLabels": {}, + * // "userPseudoId": "my_userPseudoId" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "answer": {}, + * // "answerQueryToken": "my_answerQueryToken", + * // "session": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + options: StreamMethodOptions + ): Promise>; + answer( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + callback: BodyResponseCallback + ): void; + answer( + callback: BodyResponseCallback + ): void; + answer( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+servingConfig}:answer').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.servingConfigs.get( + * { + * // Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "answerGenerationSpec": {}, + * // "boostControlIds": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "dissociateControlIds": [], + * // "diversityLevel": "my_diversityLevel", + * // "filterControlIds": [], + * // "genericConfig": {}, + * // "ignoreControlIds": [], + * // "mediaConfig": {}, + * // "modelId": "my_modelId", + * // "name": "my_name", + * // "onewaySynonymsControlIds": [], + * // "promoteControlIds": [], + * // "rankingExpression": "my_rankingExpression", + * // "redirectControlIds": [], + * // "replacementControlIds": [], + * // "solutionType": "my_solutionType", + * // "synonymsControlIds": [], + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists all ServingConfigs linked to this dataStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.servingConfigs.list( * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', - * // The standard list page size. + * // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. * pageSize: 'placeholder-value', - * // The standard list page token. + * // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', * }, * ); * console.log(res.data); @@ -36702,8 +37642,7 @@ export namespace discoveryengine_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "servingConfigs": [] * // } * } * @@ -36720,61 +37659,61 @@ export namespace discoveryengine_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; options = {}; } @@ -36788,7 +37727,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/servingConfigs').replace( /([^:]\/)\/+/g, '$1' ), @@ -36798,244 +37737,17 @@ export namespace discoveryengine_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleLongrunningCancelOperationRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Answer query method. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const discoveryengine = google.discoveryengine('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.readwrite', - * ], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await discoveryengine.projects.locations.collections.engines.servingConfigs.answer( - * { - * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - * servingConfig: - * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "answerGenerationSpec": {}, - * // "asynchronousMode": false, - * // "endUserSpec": {}, - * // "groundingSpec": {}, - * // "query": {}, - * // "queryUnderstandingSpec": {}, - * // "relatedQuestionsSpec": {}, - * // "safetySpec": {}, - * // "searchSpec": {}, - * // "session": "my_session", - * // "userLabels": {}, - * // "userPseudoId": "my_userPseudoId" - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "answer": {}, - * // "answerQueryToken": "my_answerQueryToken", - * // "session": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, - options: StreamMethodOptions - ): Promise>; - answer( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, - callback: BodyResponseCallback - ): void; - answer( - callback: BodyResponseCallback - ): void; - answer( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+servingConfig}:answer').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } @@ -38013,6 +38725,28 @@ export namespace discoveryengine_v1 { */ requestBody?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest; } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get + extends StandardParameters { + /** + * Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + */ + parent?: string; + } export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters { /** @@ -39620,7 +40354,7 @@ export namespace discoveryengine_v1 { * query: 'placeholder-value', * // Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. * queryModel: 'placeholder-value', - * // A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * // Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. * userPseudoId: 'placeholder-value', * }, * ); @@ -40767,7 +41501,7 @@ export namespace discoveryengine_v1 { */ queryModel?: string; /** - * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ userPseudoId?: string; } @@ -47079,6 +47813,334 @@ export namespace discoveryengine_v1 { } } + /** + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.dataStores.servingConfigs.get({ + * // Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "answerGenerationSpec": {}, + * // "boostControlIds": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "dissociateControlIds": [], + * // "diversityLevel": "my_diversityLevel", + * // "filterControlIds": [], + * // "genericConfig": {}, + * // "ignoreControlIds": [], + * // "mediaConfig": {}, + * // "modelId": "my_modelId", + * // "name": "my_name", + * // "onewaySynonymsControlIds": [], + * // "promoteControlIds": [], + * // "rankingExpression": "my_rankingExpression", + * // "redirectControlIds": [], + * // "replacementControlIds": [], + * // "solutionType": "my_solutionType", + * // "synonymsControlIds": [], + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists all ServingConfigs linked to this dataStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.dataStores.servingConfigs.list({ + * // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "servingConfigs": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/servingConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * @example @@ -48047,6 +49109,28 @@ export namespace discoveryengine_v1 { */ requestBody?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest; } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get + extends StandardParameters { + /** + * Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + */ + parent?: string; + } export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch extends StandardParameters { /** diff --git a/src/apis/discoveryengine/v1alpha.ts b/src/apis/discoveryengine/v1alpha.ts index 8ab9193656f..401c431ccd5 100644 --- a/src/apis/discoveryengine/v1alpha.ts +++ b/src/apis/discoveryengine/v1alpha.ts @@ -948,6 +948,15 @@ export namespace discoveryengine_v1alpha { */ enrollState?: string | null; } + /** + * Stored definition of an agent that uses A2A. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition { + /** + * Optional. The agent card is a JSON string. + */ + jsonAgentCard?: string | null; + } /** * Access Control Configuration. */ @@ -1003,6 +1012,24 @@ export namespace discoveryengine_v1alpha { */ useStaticSecrets?: boolean | null; } + /** + * Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition { + /** + * Optional. The reasoning engine that the agent is connected to. + */ + provisionedReasoningEngine?: Schema$GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine; + } + /** + * Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine { + /** + * Required. The reasoning engine that the agent is connected to. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + reasoningEngine?: string | null; + } /** * Request message for CompletionService.AdvancedCompleteQuery method. . */ @@ -1040,7 +1067,7 @@ export namespace discoveryengine_v1alpha { */ userInfo?: Schema$GoogleCloudDiscoveryengineV1alphaUserInfo; /** - * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 + * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 */ userPseudoId?: string | null; } @@ -1221,6 +1248,118 @@ export namespace discoveryengine_v1alpha { */ disableInitialIndex?: boolean | null; } + /** + * Performs a predefined, specific task. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAgent { + /** + * Optional. The behavior of the agent is defined as an A2A agent. + */ + a2aAgentDefinition?: Schema$GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition; + /** + * Optional. The behavior of the agent is defined as an ADK agent. + */ + adkAgentDefinition?: Schema$GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition; + /** + * Optional. The authorizations that are required by the agent. + */ + authorizationConfig?: Schema$GoogleCloudDiscoveryengineV1alphaAuthorizationConfig; + /** + * Output only. Timestamp when this Agent was created. + */ + createTime?: string | null; + /** + * Optional. The custom placeholder text that appears in the text box before the user enters any text. + */ + customPlaceholderText?: string | null; + /** + * Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED. + */ + deploymentFailureReason?: string | null; + /** + * Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query. + */ + description?: string | null; + /** + * Optional. The behavior of the agent is defined as a Dialogflow agent. + */ + dialogflowAgentDefinition?: Schema$GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition; + /** + * Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query. + */ + displayName?: string | null; + /** + * Optional. The icon that represents the agent on the UI. + */ + icon?: Schema$GoogleCloudDiscoveryengineV1alphaAgentImage; + /** + * Optional. The code of the language of the text in the description, display_name and starter_prompts fields. + */ + languageCode?: string | null; + /** + * Identifier. Resource name of the agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}` + */ + name?: string | null; + /** + * Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection. + */ + rejectionReason?: string | null; + /** + * Optional. The starter prompt suggestions to show the user on the landing page of the agent. + */ + starterPrompts?: Schema$GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt[]; + /** + * Output only. The lifecycle state of the agent. + */ + state?: string | null; + /** + * Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED. + */ + suspensionReason?: string | null; + /** + * Output only. Timestamp when this Agent was most recently updated. + */ + updateTime?: string | null; + } + /** + * Describes a file used internally by an agent as a context on each invocation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAgentFile { + /** + * Required. The name of the file. + */ + fileName?: string | null; + /** + * Immutable. The content type of the file. + */ + mimeType?: string | null; + /** + * Identifier. The resource name of the file. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}/files/{file\}` + */ + name?: string | null; + } + /** + * Represents an image. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAgentImage { + /** + * Base64-encoded image file contents. + */ + content?: string | null; + /** + * Image URI. + */ + uri?: string | null; + } + /** + * The starter prompt suggestion to show the user on the landing page of the agent. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt { + /** + * Required. The text of the starter prompt. + */ + text?: string | null; + } /** * The connector level alert config. */ @@ -2626,6 +2765,19 @@ export namespace discoveryengine_v1alpha { */ serverSideOauth2?: Schema$GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2; } + /** + * Describes the authorizations required. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAuthorizationConfig { + /** + * Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header. + */ + agentAuthorization?: string | null; + /** + * Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body. + */ + toolAuthorizations?: string[] | null; + } /** * OAuth2 configuration. */ @@ -2924,6 +3076,63 @@ export namespace discoveryengine_v1alpha { */ tableId?: string | null; } + /** + * Information about license configs at billing account level. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig { + /** + * Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date. + */ + autoRenew?: boolean | null; + /** + * Optional. The planed subscription end date. + */ + endDate?: Schema$GoogleTypeDate; + /** + * Whether the license config is for Gemini bundle. + */ + geminiBundle?: boolean | null; + /** + * A map of LicenseConfig names to the number of licenses distributed to each. The key is the full resource name of the LicenseConfig, such as `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`. The value is the count of licenses allocated to it. + */ + licenseConfigDistributions?: {[key: string]: string} | null; + /** + * Required. The number of licenses purchased under this billing account license config. + */ + licenseCount?: string | null; + /** + * Immutable. Identifier. The fully qualified resource name of the billing account license config. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config\}`. + */ + name?: string | null; + /** + * The procurement entitlement id of the subscription. + */ + procurementEntitlementId?: string | null; + /** + * Required. The subscription start date. + */ + startDate?: Schema$GoogleTypeDate; + /** + * Output only. The state of the BillingAccountLicenseConfig. + */ + state?: string | null; + /** + * The subscription display name. + */ + subscriptionDisplayName?: string | null; + /** + * Output only. The corresponding SubV3 subscription name. + */ + subscriptionName?: string | null; + /** + * Required. The subscription term. + */ + subscriptionTerm?: string | null; + /** + * Required. The subscription tier. + */ + subscriptionTier?: string | null; + } /** * A data branch that stores Documents. */ @@ -4565,6 +4774,19 @@ export namespace discoveryengine_v1alpha { */ userTriggeredCrawlRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries; } + /** + * Metadata related to the progress of the AgentService.DeleteAgent operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } /** * Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -4725,6 +4947,15 @@ export namespace discoveryengine_v1alpha { */ port?: number | null; } + /** + * Stored definition of an agent that uses a Dialogflow agent. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition { + /** + * Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project\}/locations/{location\}/agents/{agent\}` + */ + dialogflowAgent?: string | null; + } /** * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -5952,6 +6183,28 @@ export namespace discoveryengine_v1alpha { */ width?: number | null; } + /** + * Request for the AgentService.ImportAgentFile method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest { + /** + * Required. The name of the file. + */ + fileName?: string | null; + /** + * Optional. The content type of the file, see https://www.iana.org/assignments/media-types/media-types.xhtml. This field is required when the data source does not provide the content type. + */ + mimeType?: string | null; + } + /** + * Response for the AgentService.ImportAgentFile method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse { + /** + * The imported AgentFile. + */ + agentFile?: Schema$GoogleCloudDiscoveryengineV1alphaAgentFile; + } /** * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -6447,6 +6700,19 @@ export namespace discoveryengine_v1alpha { */ subscriptionTier?: string | null; } + /** + * Response message for the AgentService.ListAgents method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListAgentsResponse { + /** + * The agents visible to the caller under the parent Assistant. + */ + agents?: Schema$GoogleCloudDiscoveryengineV1alphaAgent[]; + /** + * A token that can be sent as ListAgentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * Response message for the AuthorizationService.ListAuthorizations method. */ @@ -6460,6 +6726,19 @@ export namespace discoveryengine_v1alpha { */ nextPageToken?: string | null; } + /** + * Response message for LicenseConfigService.ListBillingAccountLicenseConfigs method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse { + /** + * All BillingAccountLicenseConfigs for the given billing account. + */ + billingAccountLicenseConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig[]; + /** + * A token that can be sent as ListBillingAccountLicenseConfigsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * Response for BranchService.ListBranches method. */ @@ -8188,7 +8467,7 @@ export namespace discoveryengine_v1alpha { */ userLabels?: {[key: string]: string} | null; /** - * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ userPseudoId?: string | null; } @@ -9980,6 +10259,32 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } + /** + * Request message for the AgentService.UploadAgentFile method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest { + /** + * Information about the file being uploaded. + */ + blob?: Schema$GdataMedia; + /** + * Media upload request metadata. + */ + mediaRequestInfo?: Schema$ApiservingMediaRequestInfo; + } + /** + * Response message for the AgentService.UploadAgentFile method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse { + /** + * The uploaded AgentFile. + */ + agentFile?: Schema$GoogleCloudDiscoveryengineV1alphaAgentFile; + /** + * Media upload response metadata. + */ + mediaResponseInfo?: Schema$ApiservingMediaResponseInfo; + } /** * Request for the AssistantService.UploadSessionFile method. */ @@ -10309,10 +10614,6 @@ export namespace discoveryengine_v1alpha { * Whether to enable standalone web app. */ enableWebApp?: boolean | null; - /** - * Allows to toggle unstable/experimental features in the widget (or web app) - */ - experimentalFeatures?: {[key: string]: string} | null; /** * The configuration and appearance of facets in the end user view. */ @@ -10534,7 +10835,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting { /** - * Optional. The shortcuts to display on the homepage. LINT.IfChange(max_shortcuts_number) LINT.ThenChange( //depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number ) + * Optional. The shortcuts to display on the homepage. */ shortcuts?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut[]; } @@ -10650,6 +10951,10 @@ export namespace discoveryengine_v1alpha { * Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. */ resultDescriptionType?: string | null; + /** + * Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. + */ + searchAddonSpec?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec; } /** * Describes configuration for generative answer. @@ -10696,6 +11001,23 @@ export namespace discoveryengine_v1alpha { */ resultCount?: number | null; } + /** + * SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec { + /** + * Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. + */ + generativeAnswerAddOnDisabled?: boolean | null; + /** + * Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. + */ + kpiPersonalizationAddOnDisabled?: boolean | null; + /** + * Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. + */ + semanticAddOnDisabled?: boolean | null; + } /** * Config to store data store type configuration for workspace data */ @@ -12820,7 +13142,7 @@ export namespace discoveryengine_v1alpha { */ userLabels?: {[key: string]: string} | null; /** - * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ userPseudoId?: string | null; } @@ -16840,7 +17162,7 @@ export namespace discoveryengine_v1alpha { } /** - * This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account. + * Gets a BillingAccountLicenseConfig. * @example * ```js * // Before running the sample: @@ -16873,28 +17195,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.billingAccounts.billingAccountLicenseConfigs.retractLicenseConfig( - * { - * // Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`. - * billingAccountLicenseConfig: - * 'billingAccounts/my-billingAccount/billingAccountLicenseConfigs/my-billingAccountLicenseConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "fullRetract": false, - * // "licenseConfig": "my_licenseConfig", - * // "licenseCount": "my_licenseCount" - * // } - * }, - * }, - * ); + * await discoveryengine.billingAccounts.billingAccountLicenseConfigs.get({ + * // Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`. + * name: 'billingAccounts/my-billingAccount/billingAccountLicenseConfigs/my-billingAccountLicenseConfig', + * }); * console.log(res.data); * * // Example response * // { - * // "licenseConfig": {} + * // "autoRenew": false, + * // "endDate": {}, + * // "geminiBundle": false, + * // "licenseConfigDistributions": {}, + * // "licenseCount": "my_licenseCount", + * // "name": "my_name", + * // "procurementEntitlementId": "my_procurementEntitlementId", + * // "startDate": {}, + * // "state": "my_state", + * // "subscriptionDisplayName": "my_subscriptionDisplayName", + * // "subscriptionName": "my_subscriptionName", + * // "subscriptionTerm": "my_subscriptionTerm", + * // "subscriptionTier": "my_subscriptionTier" * // } * } * @@ -16910,62 +17231,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - retractLicenseConfig( - params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, + get( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Get, options: StreamMethodOptions ): Promise>; - retractLicenseConfig( - params?: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, + get( + params?: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - retractLicenseConfig( - params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, + get( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - retractLicenseConfig( - params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, + get( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - retractLicenseConfig( - params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, - callback: BodyResponseCallback + get( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Get, + callback: BodyResponseCallback ): void; - retractLicenseConfig( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - retractLicenseConfig( + get( paramsOrCallback?: - | Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig - | BodyResponseCallback + | Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig; + {}) as Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig; + {} as Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Get; options = {}; } @@ -16979,66 +17300,408 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1alpha/{+billingAccountLicenseConfig}:retractLicenseConfig' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['billingAccountLicenseConfig'], - pathParams: ['billingAccountLicenseConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig - extends StandardParameters { - /** - * Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`. - */ - billingAccountLicenseConfig?: string; /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest; - } - export interface Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig - extends StandardParameters { - /** - * Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`. - */ - billingAccountLicenseConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest; - } - - export class Resource$Media { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Downloads a file from the session. + * Lists all BillingAccountLicenseConfigs for a given billing account. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.billingAccounts.billingAccountLicenseConfigs.list({ + * // Optional. Not supported. + * pageSize: 'placeholder-value', + * // Optional. Not supported. + * pageToken: 'placeholder-value', + * // Required. Format: `billingAccounts/{billing_account\}`. + * parent: 'billingAccounts/my-billingAccount', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "billingAccountLicenseConfigs": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+parent}/billingAccountLicenseConfigs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.billingAccounts.billingAccountLicenseConfigs.retractLicenseConfig( + * { + * // Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`. + * billingAccountLicenseConfig: + * 'billingAccounts/my-billingAccount/billingAccountLicenseConfigs/my-billingAccountLicenseConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "fullRetract": false, + * // "licenseConfig": "my_licenseConfig", + * // "licenseCount": "my_licenseCount" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "licenseConfig": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + retractLicenseConfig( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, + options: StreamMethodOptions + ): Promise>; + retractLicenseConfig( + params?: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + retractLicenseConfig( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + retractLicenseConfig( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + retractLicenseConfig( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, + callback: BodyResponseCallback + ): void; + retractLicenseConfig( + callback: BodyResponseCallback + ): void; + retractLicenseConfig( + paramsOrCallback?: + | Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1alpha/{+billingAccountLicenseConfig}:retractLicenseConfig' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['billingAccountLicenseConfig'], + pathParams: ['billingAccountLicenseConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig + extends StandardParameters { + /** + * Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`. + */ + billingAccountLicenseConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest; + } + export interface Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Get + extends StandardParameters { + /** + * Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`. + */ + name?: string; + } + export interface Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$List + extends StandardParameters { + /** + * Optional. Not supported. + */ + pageSize?: number; + /** + * Optional. Not supported. + */ + pageToken?: string; + /** + * Required. Format: `billingAccounts/{billing_account\}`. + */ + parent?: string; + } + export interface Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig + extends StandardParameters { + /** + * Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`. + */ + billingAccountLicenseConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest; + } + + export class Resource$Media { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Downloads a file from the session. * @example * ```js * // Before running the sample: @@ -17210,6 +17873,175 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } + + /** + * Uploads a file for the assistant to use as a source of information within the session. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await discoveryengine.media.upload({ + * // Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "blob": {}, + * // "mediaRequestInfo": {} + * // } + * }, + * media: { + * mimeType: 'placeholder-value', + * body: 'placeholder-value', + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "fileId": "my_fileId", + * // "mediaResponseInfo": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + upload( + params: Params$Resource$Media$Upload, + options: StreamMethodOptions + ): Promise>; + upload( + params?: Params$Resource$Media$Upload, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + upload( + params: Params$Resource$Media$Upload, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Media$Upload, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Media$Upload, + callback: BodyResponseCallback + ): void; + upload( + callback: BodyResponseCallback + ): void; + upload( + paramsOrCallback?: + | Params$Resource$Media$Upload + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Media$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Media$Upload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:uploadFile').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + mediaUrl: (rootUrl + '/upload/v1alpha/{+name}:uploadFile').replace( + /([^:]\/)\/+/g, + '$1' + ), + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Media$Download extends StandardParameters { @@ -17226,6 +18058,32 @@ export namespace discoveryengine_v1alpha { */ viewId?: string; } + export interface Params$Resource$Media$Upload extends StandardParameters { + /** + * Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } export class Resource$Projects { context: APIRequestContext; @@ -23951,7 +24809,7 @@ export namespace discoveryengine_v1alpha { * query: 'placeholder-value', * // Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. * queryModel: 'placeholder-value', - * // A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * // Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. * userPseudoId: 'placeholder-value', * }, * ); @@ -25612,7 +26470,7 @@ export namespace discoveryengine_v1alpha { */ queryModel?: string; /** - * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ userPseudoId?: string; } @@ -40624,7 +41482,6 @@ export namespace discoveryengine_v1alpha { * // "enableSnippetResultSummary": false, * // "enableSummarization": false, * // "enableWebApp": false, - * // "experimentalFeatures": {}, * // "facetField": [], * // "fieldsUiComponentsMap": {}, * // "geminiBundle": false, @@ -40744,6 +41601,239 @@ export namespace discoveryengine_v1alpha { ); } } + + /** + * Update a WidgetConfig. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.dataStores.widgetConfigs.patch( + * { + * // Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/widgetConfigs/my-widgetConfig', + * // Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accessSettings": {}, + * // "allowPublicAccess": false, + * // "allowlistedDomains": [], + * // "assistantSettings": {}, + * // "collectionComponents": [], + * // "configId": "my_configId", + * // "contentSearchSpec": {}, + * // "createTime": "my_createTime", + * // "customerProvidedConfig": {}, + * // "dataStoreType": "my_dataStoreType", + * // "dataStoreUiConfigs": [], + * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy", + * // "displayName": "my_displayName", + * // "enableAutocomplete": false, + * // "enableConversationalSearch": false, + * // "enablePrivateKnowledgeGraph": false, + * // "enableQualityFeedback": false, + * // "enableResultScore": false, + * // "enableSafeSearch": false, + * // "enableSearchAsYouType": false, + * // "enableSnippetResultSummary": false, + * // "enableSummarization": false, + * // "enableWebApp": false, + * // "facetField": [], + * // "fieldsUiComponentsMap": {}, + * // "geminiBundle": false, + * // "homepageSetting": {}, + * // "industryVertical": "my_industryVertical", + * // "llmEnabled": false, + * // "minimumDataTermAccepted": false, + * // "name": "my_name", + * // "resultDisplayType": "my_resultDisplayType", + * // "solutionType": "my_solutionType", + * // "uiBranding": {}, + * // "uiSettings": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "accessSettings": {}, + * // "allowPublicAccess": false, + * // "allowlistedDomains": [], + * // "assistantSettings": {}, + * // "collectionComponents": [], + * // "configId": "my_configId", + * // "contentSearchSpec": {}, + * // "createTime": "my_createTime", + * // "customerProvidedConfig": {}, + * // "dataStoreType": "my_dataStoreType", + * // "dataStoreUiConfigs": [], + * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy", + * // "displayName": "my_displayName", + * // "enableAutocomplete": false, + * // "enableConversationalSearch": false, + * // "enablePrivateKnowledgeGraph": false, + * // "enableQualityFeedback": false, + * // "enableResultScore": false, + * // "enableSafeSearch": false, + * // "enableSearchAsYouType": false, + * // "enableSnippetResultSummary": false, + * // "enableSummarization": false, + * // "enableWebApp": false, + * // "facetField": [], + * // "fieldsUiComponentsMap": {}, + * // "geminiBundle": false, + * // "homepageSetting": {}, + * // "industryVertical": "my_industryVertical", + * // "llmEnabled": false, + * // "minimumDataTermAccepted": false, + * // "name": "my_name", + * // "resultDisplayType": "my_resultDisplayType", + * // "solutionType": "my_solutionType", + * // "uiBranding": {}, + * // "uiSettings": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get @@ -40761,6 +41851,22 @@ export namespace discoveryengine_v1alpha { */ name?: string; } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch + extends StandardParameters { + /** + * Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig; + } export class Resource$Projects$Locations$Collections$Engines { context: APIRequestContext; @@ -42621,9 +43727,14 @@ export namespace discoveryengine_v1alpha { export class Resource$Projects$Locations$Collections$Engines$Assistants { context: APIRequestContext; + agents: Resource$Projects$Locations$Collections$Engines$Assistants$Agents; cannedQueries: Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries; constructor(context: APIRequestContext) { this.context = context; + this.agents = + new Resource$Projects$Locations$Collections$Engines$Assistants$Agents( + this.context + ); this.cannedQueries = new Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries( this.context @@ -42993,20 +44104,1181 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.assistants.streamAssist( + * await discoveryengine.projects.locations.collections.engines.assistants.streamAssist( + * { + * // Required. The resource name of the Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "generationSpec": {}, + * // "query": {}, + * // "session": "my_session", + * // "toolsSpec": {}, + * // "userMetadata": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "answer": {}, + * // "assistToken": "my_assistToken", + * // "sessionInfo": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + streamAssist( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, + options: StreamMethodOptions + ): Promise>; + streamAssist( + params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + streamAssist( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamAssist( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamAssist( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, + callback: BodyResponseCallback + ): void; + streamAssist( + callback: BodyResponseCallback + ): void; + streamAssist( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:streamAssist').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get + extends StandardParameters { + /** + * Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch + extends StandardParameters { + /** + * Immutable. Resource name of the assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAssistant; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist + extends StandardParameters { + /** + * Required. The resource name of the Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistRequest; + } + + export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents { + context: APIRequestContext; + files: Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files; + constructor(context: APIRequestContext) { + this.context = context; + this.files = + new Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files( + this.context + ); + } + + /** + * Creates an Agent. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.assistants.agents.create( + * { + * // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "a2aAgentDefinition": {}, + * // "adkAgentDefinition": {}, + * // "authorizationConfig": {}, + * // "createTime": "my_createTime", + * // "customPlaceholderText": "my_customPlaceholderText", + * // "deploymentFailureReason": "my_deploymentFailureReason", + * // "description": "my_description", + * // "dialogflowAgentDefinition": {}, + * // "displayName": "my_displayName", + * // "icon": {}, + * // "languageCode": "my_languageCode", + * // "name": "my_name", + * // "rejectionReason": "my_rejectionReason", + * // "starterPrompts": [], + * // "state": "my_state", + * // "suspensionReason": "my_suspensionReason", + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "a2aAgentDefinition": {}, + * // "adkAgentDefinition": {}, + * // "authorizationConfig": {}, + * // "createTime": "my_createTime", + * // "customPlaceholderText": "my_customPlaceholderText", + * // "deploymentFailureReason": "my_deploymentFailureReason", + * // "description": "my_description", + * // "dialogflowAgentDefinition": {}, + * // "displayName": "my_displayName", + * // "icon": {}, + * // "languageCode": "my_languageCode", + * // "name": "my_name", + * // "rejectionReason": "my_rejectionReason", + * // "starterPrompts": [], + * // "state": "my_state", + * // "suspensionReason": "my_suspensionReason", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/agents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes an Agent. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.assistants.agents.delete( + * { + * // Required. Resource name of Agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}` If the caller does not have permission to delete the agent, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the agent to delete does not exist, a `NOT_FOUND` error is returned. + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets an Agent. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.assistants.agents.get( + * { + * // Required. Resource name of Agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "a2aAgentDefinition": {}, + * // "adkAgentDefinition": {}, + * // "authorizationConfig": {}, + * // "createTime": "my_createTime", + * // "customPlaceholderText": "my_customPlaceholderText", + * // "deploymentFailureReason": "my_deploymentFailureReason", + * // "description": "my_description", + * // "dialogflowAgentDefinition": {}, + * // "displayName": "my_displayName", + * // "icon": {}, + * // "languageCode": "my_languageCode", + * // "name": "my_name", + * // "rejectionReason": "my_rejectionReason", + * // "starterPrompts": [], + * // "state": "my_state", + * // "suspensionReason": "my_suspensionReason", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists all Agents under an Assistant which were created by the caller. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.assistants.agents.list( + * { + * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `is_pinned` Example: * "update_time desc" * "is_pinned desc,update_time desc": list agents by is_pinned first, then by update_time. + * orderBy: 'placeholder-value', + * // Optional. Maximum number of Agents to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000. + * pageSize: 'placeholder-value', + * // Optional. A page token ListAgentsResponse.next_page_token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAgents must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "agents": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/agents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an Agent + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.assistants.agents.patch( + * { + * // Identifier. Resource name of the agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent', + * // Optional. The list of fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "a2aAgentDefinition": {}, + * // "adkAgentDefinition": {}, + * // "authorizationConfig": {}, + * // "createTime": "my_createTime", + * // "customPlaceholderText": "my_customPlaceholderText", + * // "deploymentFailureReason": "my_deploymentFailureReason", + * // "description": "my_description", + * // "dialogflowAgentDefinition": {}, + * // "displayName": "my_displayName", + * // "icon": {}, + * // "languageCode": "my_languageCode", + * // "name": "my_name", + * // "rejectionReason": "my_rejectionReason", + * // "starterPrompts": [], + * // "state": "my_state", + * // "suspensionReason": "my_suspensionReason", + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "a2aAgentDefinition": {}, + * // "adkAgentDefinition": {}, + * // "authorizationConfig": {}, + * // "createTime": "my_createTime", + * // "customPlaceholderText": "my_customPlaceholderText", + * // "deploymentFailureReason": "my_deploymentFailureReason", + * // "description": "my_description", + * // "dialogflowAgentDefinition": {}, + * // "displayName": "my_displayName", + * // "icon": {}, + * // "languageCode": "my_languageCode", + * // "name": "my_name", + * // "rejectionReason": "my_rejectionReason", + * // "starterPrompts": [], + * // "state": "my_state", + * // "suspensionReason": "my_suspensionReason", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Create + extends StandardParameters { + /** + * Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAgent; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete + extends StandardParameters { + /** + * Required. Resource name of Agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}` If the caller does not have permission to delete the agent, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the agent to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get + extends StandardParameters { + /** + * Required. Resource name of Agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$List + extends StandardParameters { + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `is_pinned` Example: * "update_time desc" * "is_pinned desc,update_time desc": list agents by is_pinned first, then by update_time. + */ + orderBy?: string; + /** + * Optional. Maximum number of Agents to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000. + */ + pageSize?: number; + /** + * Optional. A page token ListAgentsResponse.next_page_token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAgents must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch + extends StandardParameters { + /** + * Identifier. Resource name of the agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}` + */ + name?: string; + /** + * Optional. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAgent; + } + + export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Imports a file to an Agent. Currently only No-Code agents are supported. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.assistants.agents.files.import( * { - * // Required. The resource name of the Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant', + * // Required. The resource name of the Agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "generationSpec": {}, - * // "query": {}, - * // "session": "my_session", - * // "toolsSpec": {}, - * // "userMetadata": {} + * // "fileName": "my_fileName", + * // "mimeType": "my_mimeType" * // } * }, * }, @@ -43015,9 +45287,7 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "answer": {}, - * // "assistToken": "my_assistToken", - * // "sessionInfo": {} + * // "agentFile": {} * // } * } * @@ -43033,62 +45303,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamAssist( - params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, + import( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files$Import, options: StreamMethodOptions ): Promise>; - streamAssist( - params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, + import( + params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files$Import, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - streamAssist( - params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, + import( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamAssist( - params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, + import( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamAssist( - params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files$Import, + callback: BodyResponseCallback ): void; - streamAssist( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - streamAssist( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist; + {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files$Import; options = {}; } @@ -43102,7 +45372,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:streamAssist').replace( + url: (rootUrl + '/v1alpha/{+parent}/files:import').replace( /([^:]\/)\/+/g, '$1' ), @@ -43112,57 +45382,34 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files$Import extends StandardParameters { /** - * Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch - extends StandardParameters { - /** - * Immutable. Resource name of the assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` It must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - /** - * The list of fields to update. - */ - updateMask?: string; - - /** - * Request body metadata + * Required. The resource name of the Agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}` */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAssistant; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist - extends StandardParameters { - /** - * Required. The resource name of the Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` - */ - name?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest; } export class Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries { @@ -49696,15 +51943,248 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.widgetConfigs.get( + * await discoveryengine.projects.locations.collections.engines.widgetConfigs.get( + * { + * // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. + * acceptCache: 'placeholder-value', + * // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. + * 'getWidgetConfigRequestOption.turnOffCollectionComponents': + * 'placeholder-value', + * // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/widgetConfigs/my-widgetConfig', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "accessSettings": {}, + * // "allowPublicAccess": false, + * // "allowlistedDomains": [], + * // "assistantSettings": {}, + * // "collectionComponents": [], + * // "configId": "my_configId", + * // "contentSearchSpec": {}, + * // "createTime": "my_createTime", + * // "customerProvidedConfig": {}, + * // "dataStoreType": "my_dataStoreType", + * // "dataStoreUiConfigs": [], + * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy", + * // "displayName": "my_displayName", + * // "enableAutocomplete": false, + * // "enableConversationalSearch": false, + * // "enablePrivateKnowledgeGraph": false, + * // "enableQualityFeedback": false, + * // "enableResultScore": false, + * // "enableSafeSearch": false, + * // "enableSearchAsYouType": false, + * // "enableSnippetResultSummary": false, + * // "enableSummarization": false, + * // "enableWebApp": false, + * // "facetField": [], + * // "fieldsUiComponentsMap": {}, + * // "geminiBundle": false, + * // "homepageSetting": {}, + * // "industryVertical": "my_industryVertical", + * // "llmEnabled": false, + * // "minimumDataTermAccepted": false, + * // "name": "my_name", + * // "resultDisplayType": "my_resultDisplayType", + * // "solutionType": "my_solutionType", + * // "uiBranding": {}, + * // "uiSettings": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update a WidgetConfig. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.widgetConfigs.patch( * { - * // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. - * acceptCache: 'placeholder-value', - * // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. - * 'getWidgetConfigRequestOption.turnOffCollectionComponents': - * 'placeholder-value', - * // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` + * // Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/widgetConfigs/my-widgetConfig', + * // Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accessSettings": {}, + * // "allowPublicAccess": false, + * // "allowlistedDomains": [], + * // "assistantSettings": {}, + * // "collectionComponents": [], + * // "configId": "my_configId", + * // "contentSearchSpec": {}, + * // "createTime": "my_createTime", + * // "customerProvidedConfig": {}, + * // "dataStoreType": "my_dataStoreType", + * // "dataStoreUiConfigs": [], + * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy", + * // "displayName": "my_displayName", + * // "enableAutocomplete": false, + * // "enableConversationalSearch": false, + * // "enablePrivateKnowledgeGraph": false, + * // "enableQualityFeedback": false, + * // "enableResultScore": false, + * // "enableSafeSearch": false, + * // "enableSearchAsYouType": false, + * // "enableSnippetResultSummary": false, + * // "enableSummarization": false, + * // "enableWebApp": false, + * // "facetField": [], + * // "fieldsUiComponentsMap": {}, + * // "geminiBundle": false, + * // "homepageSetting": {}, + * // "industryVertical": "my_industryVertical", + * // "llmEnabled": false, + * // "minimumDataTermAccepted": false, + * // "name": "my_name", + * // "resultDisplayType": "my_resultDisplayType", + * // "solutionType": "my_solutionType", + * // "uiBranding": {}, + * // "uiSettings": {}, + * // "updateTime": "my_updateTime" + * // } + * }, * }, * ); * console.log(res.data); @@ -49734,7 +52214,6 @@ export namespace discoveryengine_v1alpha { * // "enableSnippetResultSummary": false, * // "enableSummarization": false, * // "enableWebApp": false, - * // "experimentalFeatures": {}, * // "facetField": [], * // "fieldsUiComponentsMap": {}, * // "geminiBundle": false, @@ -49763,38 +52242,38 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, callback: BodyResponseCallback ): void; - get( + patch( callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get + | Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -49812,13 +52291,13 @@ export namespace discoveryengine_v1alpha { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch; options = {}; } @@ -49833,7 +52312,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -49871,6 +52350,22 @@ export namespace discoveryengine_v1alpha { */ name?: string; } + export interface Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch + extends StandardParameters { + /** + * Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig; + } export class Resource$Projects$Locations$Collections$Operations { context: APIRequestContext; @@ -50329,7 +52824,7 @@ export namespace discoveryengine_v1alpha { * query: 'placeholder-value', * // Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. * queryModel: 'placeholder-value', - * // A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * // Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. * userPseudoId: 'placeholder-value', * }, * ); @@ -51811,7 +54306,7 @@ export namespace discoveryengine_v1alpha { */ queryModel?: string; /** - * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ userPseudoId?: string; } @@ -64800,7 +67295,6 @@ export namespace discoveryengine_v1alpha { * // "enableSnippetResultSummary": false, * // "enableSummarization": false, * // "enableWebApp": false, - * // "experimentalFeatures": {}, * // "facetField": [], * // "fieldsUiComponentsMap": {}, * // "geminiBundle": false, @@ -64920,6 +67414,237 @@ export namespace discoveryengine_v1alpha { ); } } + + /** + * Update a WidgetConfig. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.dataStores.widgetConfigs.patch({ + * // Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/widgetConfigs/my-widgetConfig', + * // Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accessSettings": {}, + * // "allowPublicAccess": false, + * // "allowlistedDomains": [], + * // "assistantSettings": {}, + * // "collectionComponents": [], + * // "configId": "my_configId", + * // "contentSearchSpec": {}, + * // "createTime": "my_createTime", + * // "customerProvidedConfig": {}, + * // "dataStoreType": "my_dataStoreType", + * // "dataStoreUiConfigs": [], + * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy", + * // "displayName": "my_displayName", + * // "enableAutocomplete": false, + * // "enableConversationalSearch": false, + * // "enablePrivateKnowledgeGraph": false, + * // "enableQualityFeedback": false, + * // "enableResultScore": false, + * // "enableSafeSearch": false, + * // "enableSearchAsYouType": false, + * // "enableSnippetResultSummary": false, + * // "enableSummarization": false, + * // "enableWebApp": false, + * // "facetField": [], + * // "fieldsUiComponentsMap": {}, + * // "geminiBundle": false, + * // "homepageSetting": {}, + * // "industryVertical": "my_industryVertical", + * // "llmEnabled": false, + * // "minimumDataTermAccepted": false, + * // "name": "my_name", + * // "resultDisplayType": "my_resultDisplayType", + * // "solutionType": "my_solutionType", + * // "uiBranding": {}, + * // "uiSettings": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accessSettings": {}, + * // "allowPublicAccess": false, + * // "allowlistedDomains": [], + * // "assistantSettings": {}, + * // "collectionComponents": [], + * // "configId": "my_configId", + * // "contentSearchSpec": {}, + * // "createTime": "my_createTime", + * // "customerProvidedConfig": {}, + * // "dataStoreType": "my_dataStoreType", + * // "dataStoreUiConfigs": [], + * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy", + * // "displayName": "my_displayName", + * // "enableAutocomplete": false, + * // "enableConversationalSearch": false, + * // "enablePrivateKnowledgeGraph": false, + * // "enableQualityFeedback": false, + * // "enableResultScore": false, + * // "enableSafeSearch": false, + * // "enableSearchAsYouType": false, + * // "enableSnippetResultSummary": false, + * // "enableSummarization": false, + * // "enableWebApp": false, + * // "facetField": [], + * // "fieldsUiComponentsMap": {}, + * // "geminiBundle": false, + * // "homepageSetting": {}, + * // "industryVertical": "my_industryVertical", + * // "llmEnabled": false, + * // "minimumDataTermAccepted": false, + * // "name": "my_name", + * // "resultDisplayType": "my_resultDisplayType", + * // "solutionType": "my_solutionType", + * // "uiBranding": {}, + * // "uiSettings": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get @@ -64937,6 +67662,22 @@ export namespace discoveryengine_v1alpha { */ name?: string; } + export interface Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch + extends StandardParameters { + /** + * Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig; + } export class Resource$Projects$Locations$Evaluations { context: APIRequestContext; diff --git a/src/apis/discoveryengine/v1beta.ts b/src/apis/discoveryengine/v1beta.ts index 0cd5cef86f3..3b9ede162f5 100644 --- a/src/apis/discoveryengine/v1beta.ts +++ b/src/apis/discoveryengine/v1beta.ts @@ -2626,6 +2626,19 @@ export namespace discoveryengine_v1beta { */ userTriggeredCrawlRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries; } + /** + * Metadata related to the progress of the AgentService.DeleteAgent operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } /** * Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -4431,7 +4444,7 @@ export namespace discoveryengine_v1beta { */ userLabels?: {[key: string]: string} | null; /** - * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ userPseudoId?: string | null; } @@ -5568,7 +5581,7 @@ export namespace discoveryengine_v1beta { */ userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo; /** - * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 + * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 */ userPseudoId?: string | null; } @@ -10961,7 +10974,7 @@ export namespace discoveryengine_v1beta { */ userLabels?: {[key: string]: string} | null; /** - * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ userPseudoId?: string | null; } @@ -18072,7 +18085,7 @@ export namespace discoveryengine_v1beta { * query: 'placeholder-value', * // Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. * queryModel: 'placeholder-value', - * // A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * // Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. * userPseudoId: 'placeholder-value', * }, * ); @@ -19406,7 +19419,7 @@ export namespace discoveryengine_v1beta { */ queryModel?: string; /** - * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ userPseudoId?: string; } @@ -40963,7 +40976,7 @@ export namespace discoveryengine_v1beta { * query: 'placeholder-value', * // Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. * queryModel: 'placeholder-value', - * // A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * // Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. * userPseudoId: 'placeholder-value', * }, * ); @@ -42118,7 +42131,7 @@ export namespace discoveryengine_v1beta { */ queryModel?: string; /** - * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ userPseudoId?: string; } From a390aeb4bf1645a32d4fe7bb43d7972b62313ea4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:14 +0000 Subject: [PATCH 12/31] feat(firebaseappdistribution): update the API #### firebaseappdistribution:v1alpha The following keys were added: - schemas.GoogleFirebaseAppdistroV1alphaDeviceExecution.properties.executionType.description - schemas.GoogleFirebaseAppdistroV1alphaDeviceExecution.properties.executionType.enum - schemas.GoogleFirebaseAppdistroV1alphaDeviceExecution.properties.executionType.enumDescriptions - schemas.GoogleFirebaseAppdistroV1alphaDeviceExecution.properties.executionType.readOnly - schemas.GoogleFirebaseAppdistroV1alphaDeviceExecution.properties.executionType.type --- .../firebaseappdistribution-v1alpha.json | 19 ++++++++++++++++++- src/apis/firebaseappdistribution/v1alpha.ts | 4 ++++ 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/discovery/firebaseappdistribution-v1alpha.json b/discovery/firebaseappdistribution-v1alpha.json index 8c81447d925..ea025ef3aca 100644 --- a/discovery/firebaseappdistribution-v1alpha.json +++ b/discovery/firebaseappdistribution-v1alpha.json @@ -868,7 +868,7 @@ } } }, - "revision": "20251022", + "revision": "20251030", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "AndroidxCrawlerOutputPoint": { @@ -1336,6 +1336,23 @@ "$ref": "GoogleFirebaseAppdistroV1alphaTestDevice", "description": "Required. The device that the test was run on." }, + "executionType": { + "description": "Output only. The type of execution for the test.", + "enum": [ + "EXECUTION_TYPE_UNSPECIFIED", + "AI", + "ACTION_BASED_REPLAY", + "AI_REPLAY" + ], + "enumDescriptions": [ + "Execution type unspecified.", + "An AI-driven test.", + "A replay of a previous test run.", + "A failed replay that was rerun using the AI agent." + ], + "readOnly": true, + "type": "string" + }, "failedReason": { "description": "Output only. The reason why the test failed.", "enum": [ diff --git a/src/apis/firebaseappdistribution/v1alpha.ts b/src/apis/firebaseappdistribution/v1alpha.ts index 52880f0c865..52439e28fd0 100644 --- a/src/apis/firebaseappdistribution/v1alpha.ts +++ b/src/apis/firebaseappdistribution/v1alpha.ts @@ -364,6 +364,10 @@ export namespace firebaseappdistribution_v1alpha { * Required. The device that the test was run on. */ device?: Schema$GoogleFirebaseAppdistroV1alphaTestDevice; + /** + * Output only. The type of execution for the test. + */ + executionType?: string | null; /** * Output only. The reason why the test failed. */ From 247164937e3e6e89e745138cda76a0b8d7ea3334 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:15 +0000 Subject: [PATCH 13/31] fix(firebasedataconnect): update the API #### firebasedataconnect:v1beta The following keys were changed: - resources.projects.resources.locations.resources.services.resources.schemas.methods.list.description #### firebasedataconnect:v1 The following keys were changed: - resources.projects.resources.locations.resources.services.resources.schemas.methods.list.description --- discovery/firebasedataconnect-v1.json | 4 ++-- discovery/firebasedataconnect-v1beta.json | 4 ++-- src/apis/firebasedataconnect/v1.ts | 2 +- src/apis/firebasedataconnect/v1beta.ts | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/discovery/firebasedataconnect-v1.json b/discovery/firebasedataconnect-v1.json index 01b1d8e3b82..ecd40bd76a9 100644 --- a/discovery/firebasedataconnect-v1.json +++ b/discovery/firebasedataconnect-v1.json @@ -1062,7 +1062,7 @@ ] }, "list": { - "description": "Lists Schemas in a given project and location. Note that only `schemas/main` is supported, so this will always return at most one Schema.", + "description": "Lists Schemas in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas", "httpMethod": "GET", "id": "firebasedataconnect.projects.locations.services.schemas.list", @@ -1165,7 +1165,7 @@ } } }, - "revision": "20251021", + "revision": "20251026", "rootUrl": "https://firebasedataconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/discovery/firebasedataconnect-v1beta.json b/discovery/firebasedataconnect-v1beta.json index 01b7d252ed0..59ae1102c6f 100644 --- a/discovery/firebasedataconnect-v1beta.json +++ b/discovery/firebasedataconnect-v1beta.json @@ -1062,7 +1062,7 @@ ] }, "list": { - "description": "Lists Schemas in a given project and location. Note that only `schemas/main` is supported, so this will always return at most one Schema.", + "description": "Lists Schemas in a given project and location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas", "httpMethod": "GET", "id": "firebasedataconnect.projects.locations.services.schemas.list", @@ -1165,7 +1165,7 @@ } } }, - "revision": "20251021", + "revision": "20251026", "rootUrl": "https://firebasedataconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/src/apis/firebasedataconnect/v1.ts b/src/apis/firebasedataconnect/v1.ts index 597c0b462c3..6c963f72381 100644 --- a/src/apis/firebasedataconnect/v1.ts +++ b/src/apis/firebasedataconnect/v1.ts @@ -5116,7 +5116,7 @@ export namespace firebasedataconnect_v1 { } /** - * Lists Schemas in a given project and location. Note that only `schemas/main` is supported, so this will always return at most one Schema. + * Lists Schemas in a given project and location. * @example * ```js * // Before running the sample: diff --git a/src/apis/firebasedataconnect/v1beta.ts b/src/apis/firebasedataconnect/v1beta.ts index 710e6442bb5..b3eca85311b 100644 --- a/src/apis/firebasedataconnect/v1beta.ts +++ b/src/apis/firebasedataconnect/v1beta.ts @@ -5119,7 +5119,7 @@ export namespace firebasedataconnect_v1beta { } /** - * Lists Schemas in a given project and location. Note that only `schemas/main` is supported, so this will always return at most one Schema. + * Lists Schemas in a given project and location. * @example * ```js * // Before running the sample: From d3dac6b66848ff59852781c3253becc17018e562 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:15 +0000 Subject: [PATCH 14/31] fix(gkehub): update the API #### gkehub:v1alpha The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description #### gkehub:v2alpha The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description #### gkehub:v1beta The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description #### gkehub:v1beta1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description #### gkehub:v2beta The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description #### gkehub:v1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description #### gkehub:v2 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description --- discovery/gkehub-v1.json | 4 ++-- discovery/gkehub-v1alpha.json | 4 ++-- discovery/gkehub-v1beta.json | 4 ++-- discovery/gkehub-v1beta1.json | 4 ++-- discovery/gkehub-v2.json | 4 ++-- discovery/gkehub-v2alpha.json | 4 ++-- discovery/gkehub-v2beta.json | 4 ++-- src/apis/gkehub/v1.ts | 4 ++-- src/apis/gkehub/v1alpha.ts | 4 ++-- src/apis/gkehub/v1beta.ts | 4 ++-- src/apis/gkehub/v1beta1.ts | 4 ++-- src/apis/gkehub/v2.ts | 4 ++-- src/apis/gkehub/v2alpha.ts | 4 ++-- src/apis/gkehub/v2beta.ts | 4 ++-- 14 files changed, 28 insertions(+), 28 deletions(-) diff --git a/discovery/gkehub-v1.json b/discovery/gkehub-v1.json index c7daf11cd48..38b15ac342c 100644 --- a/discovery/gkehub-v1.json +++ b/discovery/gkehub-v1.json @@ -192,7 +192,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2122,7 +2122,7 @@ } } }, - "revision": "20251002", + "revision": "20251026", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { diff --git a/discovery/gkehub-v1alpha.json b/discovery/gkehub-v1alpha.json index c4af8134710..bf55abd00d4 100644 --- a/discovery/gkehub-v1alpha.json +++ b/discovery/gkehub-v1alpha.json @@ -192,7 +192,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2266,7 +2266,7 @@ } } }, - "revision": "20251002", + "revision": "20251026", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { diff --git a/discovery/gkehub-v1beta.json b/discovery/gkehub-v1beta.json index 386670a5558..2aabd941039 100644 --- a/discovery/gkehub-v1beta.json +++ b/discovery/gkehub-v1beta.json @@ -192,7 +192,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2122,7 +2122,7 @@ } } }, - "revision": "20251002", + "revision": "20251026", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { diff --git a/discovery/gkehub-v1beta1.json b/discovery/gkehub-v1beta1.json index 443cc144ce3..05db89844c5 100644 --- a/discovery/gkehub-v1beta1.json +++ b/discovery/gkehub-v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -723,7 +723,7 @@ } } }, - "revision": "20250925", + "revision": "20251026", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "ApplianceCluster": { diff --git a/discovery/gkehub-v2.json b/discovery/gkehub-v2.json index 6db3d796eb9..9e7cb03bc61 100644 --- a/discovery/gkehub-v2.json +++ b/discovery/gkehub-v2.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -482,7 +482,7 @@ } } }, - "revision": "20251002", + "revision": "20251026", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { diff --git a/discovery/gkehub-v2alpha.json b/discovery/gkehub-v2alpha.json index c0c285572bc..558f72b8deb 100644 --- a/discovery/gkehub-v2alpha.json +++ b/discovery/gkehub-v2alpha.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -482,7 +482,7 @@ } } }, - "revision": "20251002", + "revision": "20251026", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { diff --git a/discovery/gkehub-v2beta.json b/discovery/gkehub-v2beta.json index 9e9d4ba6521..c114d07f58c 100644 --- a/discovery/gkehub-v2beta.json +++ b/discovery/gkehub-v2beta.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -482,7 +482,7 @@ } } }, - "revision": "20251002", + "revision": "20251026", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { diff --git a/src/apis/gkehub/v1.ts b/src/apis/gkehub/v1.ts index a56494ad1c9..817f1a6eb4e 100644 --- a/src/apis/gkehub/v1.ts +++ b/src/apis/gkehub/v1.ts @@ -3446,7 +3446,7 @@ export namespace gkehub_v1 { * * // Do the magic * const res = await gkehub.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -3574,7 +3574,7 @@ export namespace gkehub_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/gkehub/v1alpha.ts b/src/apis/gkehub/v1alpha.ts index 65d6437d476..476e3a687fd 100644 --- a/src/apis/gkehub/v1alpha.ts +++ b/src/apis/gkehub/v1alpha.ts @@ -3914,7 +3914,7 @@ export namespace gkehub_v1alpha { * * // Do the magic * const res = await gkehub.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -4042,7 +4042,7 @@ export namespace gkehub_v1alpha { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/gkehub/v1beta.ts b/src/apis/gkehub/v1beta.ts index 0932e79cece..6c19b1b3637 100644 --- a/src/apis/gkehub/v1beta.ts +++ b/src/apis/gkehub/v1beta.ts @@ -3523,7 +3523,7 @@ export namespace gkehub_v1beta { * * // Do the magic * const res = await gkehub.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -3651,7 +3651,7 @@ export namespace gkehub_v1beta { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/gkehub/v1beta1.ts b/src/apis/gkehub/v1beta1.ts index 9421e5026de..581ff031abb 100644 --- a/src/apis/gkehub/v1beta1.ts +++ b/src/apis/gkehub/v1beta1.ts @@ -963,7 +963,7 @@ export namespace gkehub_v1beta1 { * * // Do the magic * const res = await gkehub.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1091,7 +1091,7 @@ export namespace gkehub_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/gkehub/v2.ts b/src/apis/gkehub/v2.ts index 121296a04fb..6e88b95be90 100644 --- a/src/apis/gkehub/v2.ts +++ b/src/apis/gkehub/v2.ts @@ -2149,7 +2149,7 @@ export namespace gkehub_v2 { * * // Do the magic * const res = await gkehub.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2277,7 +2277,7 @@ export namespace gkehub_v2 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/gkehub/v2alpha.ts b/src/apis/gkehub/v2alpha.ts index 1cd7cf6d640..efcecf6e95e 100644 --- a/src/apis/gkehub/v2alpha.ts +++ b/src/apis/gkehub/v2alpha.ts @@ -2149,7 +2149,7 @@ export namespace gkehub_v2alpha { * * // Do the magic * const res = await gkehub.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2277,7 +2277,7 @@ export namespace gkehub_v2alpha { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/gkehub/v2beta.ts b/src/apis/gkehub/v2beta.ts index c1be63ccc4d..cc9a0f2787f 100644 --- a/src/apis/gkehub/v2beta.ts +++ b/src/apis/gkehub/v2beta.ts @@ -2149,7 +2149,7 @@ export namespace gkehub_v2beta { * * // Do the magic * const res = await gkehub.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2277,7 +2277,7 @@ export namespace gkehub_v2beta { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** From 9fa8c8a677e5fb0ed659285cb68384ea862965e5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:15 +0000 Subject: [PATCH 15/31] fix(gkeonprem): update the API #### gkeonprem:v1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description --- discovery/gkeonprem-v1.json | 4 ++-- src/apis/gkeonprem/v1.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/discovery/gkeonprem-v1.json b/discovery/gkeonprem-v1.json index 7d394bb6a96..10fb62b443a 100644 --- a/discovery/gkeonprem-v1.json +++ b/discovery/gkeonprem-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -3140,7 +3140,7 @@ } } }, - "revision": "20251020", + "revision": "20251022", "rootUrl": "https://gkeonprem.googleapis.com/", "schemas": { "Authorization": { diff --git a/src/apis/gkeonprem/v1.ts b/src/apis/gkeonprem/v1.ts index 4a0bea7ea58..e5e77a0ad21 100644 --- a/src/apis/gkeonprem/v1.ts +++ b/src/apis/gkeonprem/v1.ts @@ -3167,7 +3167,7 @@ export namespace gkeonprem_v1 { * * // Do the magic * const res = await gkeonprem.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -3295,7 +3295,7 @@ export namespace gkeonprem_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** From 5b78dca1a48a5e148aea9e6e10844e34e5993eeb Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:15 +0000 Subject: [PATCH 16/31] fix(looker): update the API #### looker:v1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description --- discovery/looker-v1.json | 4 ++-- src/apis/looker/v1.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/discovery/looker-v1.json b/discovery/looker-v1.json index 69ded3448c1..ab7dba73eae 100644 --- a/discovery/looker-v1.json +++ b/discovery/looker-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -715,7 +715,7 @@ } } }, - "revision": "20251017", + "revision": "20251021", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { diff --git a/src/apis/looker/v1.ts b/src/apis/looker/v1.ts index dac7ee77279..b0d329238f0 100644 --- a/src/apis/looker/v1.ts +++ b/src/apis/looker/v1.ts @@ -944,7 +944,7 @@ export namespace looker_v1 { * * // Do the magic * const res = await looker.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1072,7 +1072,7 @@ export namespace looker_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** From aa50f675d2910c2b787682db7e6cec49bf871b20 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:15 +0000 Subject: [PATCH 17/31] fix(metastore): update the API #### metastore:v1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description --- discovery/metastore-v1.json | 4 ++-- src/apis/metastore/v1.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/discovery/metastore-v1.json b/discovery/metastore-v1.json index ddfba2757d8..ed114765cb0 100644 --- a/discovery/metastore-v1.json +++ b/discovery/metastore-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1695,7 +1695,7 @@ } } }, - "revision": "20250925", + "revision": "20251023", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { diff --git a/src/apis/metastore/v1.ts b/src/apis/metastore/v1.ts index c6cd88ca720..4d95014759f 100644 --- a/src/apis/metastore/v1.ts +++ b/src/apis/metastore/v1.ts @@ -1573,7 +1573,7 @@ export namespace metastore_v1 { * * // Do the magic * const res = await metastore.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1701,7 +1701,7 @@ export namespace metastore_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** From 8d125d7b9f53efbbd7166bd13b729ef6d64a5a0e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:15 +0000 Subject: [PATCH 18/31] fix(netapp): update the API #### netapp:v1beta1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description #### netapp:v1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description --- discovery/netapp-v1.json | 4 ++-- discovery/netapp-v1beta1.json | 4 ++-- src/apis/netapp/v1.ts | 4 ++-- src/apis/netapp/v1beta1.ts | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/discovery/netapp-v1.json b/discovery/netapp-v1.json index 05782f8a1bf..4123c6352e1 100644 --- a/discovery/netapp-v1.json +++ b/discovery/netapp-v1.json @@ -356,7 +356,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2515,7 +2515,7 @@ } } }, - "revision": "20251018", + "revision": "20251029", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { diff --git a/discovery/netapp-v1beta1.json b/discovery/netapp-v1beta1.json index b1c4e39621e..5c33ac031ff 100644 --- a/discovery/netapp-v1beta1.json +++ b/discovery/netapp-v1beta1.json @@ -356,7 +356,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2543,7 +2543,7 @@ } } }, - "revision": "20251018", + "revision": "20251029", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { diff --git a/src/apis/netapp/v1.ts b/src/apis/netapp/v1.ts index f3b44a3e12b..515d5600239 100644 --- a/src/apis/netapp/v1.ts +++ b/src/apis/netapp/v1.ts @@ -1982,7 +1982,7 @@ export namespace netapp_v1 { * * // Do the magic * const res = await netapp.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2110,7 +2110,7 @@ export namespace netapp_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/netapp/v1beta1.ts b/src/apis/netapp/v1beta1.ts index 7107780861c..7fa829973b6 100644 --- a/src/apis/netapp/v1beta1.ts +++ b/src/apis/netapp/v1beta1.ts @@ -2003,7 +2003,7 @@ export namespace netapp_v1beta1 { * * // Do the magic * const res = await netapp.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2131,7 +2131,7 @@ export namespace netapp_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** From efa8ec02b78d19597ca17115c465869413ee0982 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:15 +0000 Subject: [PATCH 19/31] fix(networkconnectivity): update the API #### networkconnectivity:v1alpha1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description --- discovery/networkconnectivity-v1alpha1.json | 4 ++-- src/apis/networkconnectivity/v1alpha1.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/discovery/networkconnectivity-v1alpha1.json b/discovery/networkconnectivity-v1alpha1.json index f5dde8a2ba8..9317d60ba00 100644 --- a/discovery/networkconnectivity-v1alpha1.json +++ b/discovery/networkconnectivity-v1alpha1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1127,7 +1127,7 @@ } } }, - "revision": "20250925", + "revision": "20251030", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AllocationOptions": { diff --git a/src/apis/networkconnectivity/v1alpha1.ts b/src/apis/networkconnectivity/v1alpha1.ts index 56a4fa3d03d..45742717f71 100644 --- a/src/apis/networkconnectivity/v1alpha1.ts +++ b/src/apis/networkconnectivity/v1alpha1.ts @@ -826,7 +826,7 @@ export namespace networkconnectivity_v1alpha1 { * * // Do the magic * const res = await networkconnectivity.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -955,7 +955,7 @@ export namespace networkconnectivity_v1alpha1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** From 7d76842710f57ade609ca484c6181428deb70c9d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:15 +0000 Subject: [PATCH 20/31] fix(networkmanagement): update the API #### networkmanagement:v1beta1 The following keys were changed: - resources.organizations.resources.locations.methods.list.parameters.extraLocationTypes.description - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description #### networkmanagement:v1 The following keys were changed: - resources.organizations.resources.locations.methods.list.parameters.extraLocationTypes.description - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description --- discovery/networkmanagement-v1.json | 6 +++--- discovery/networkmanagement-v1beta1.json | 6 +++--- src/apis/networkmanagement/v1.ts | 8 ++++---- src/apis/networkmanagement/v1beta1.ts | 8 ++++---- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/discovery/networkmanagement-v1.json b/discovery/networkmanagement-v1.json index b1fac11ff2a..943f8cce655 100644 --- a/discovery/networkmanagement-v1.json +++ b/discovery/networkmanagement-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -521,7 +521,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1233,7 +1233,7 @@ } } }, - "revision": "20251008", + "revision": "20251022", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { diff --git a/discovery/networkmanagement-v1beta1.json b/discovery/networkmanagement-v1beta1.json index bdc03257e83..28dd4a785a6 100644 --- a/discovery/networkmanagement-v1beta1.json +++ b/discovery/networkmanagement-v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -525,7 +525,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1237,7 +1237,7 @@ } } }, - "revision": "20251008", + "revision": "20251022", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { diff --git a/src/apis/networkmanagement/v1.ts b/src/apis/networkmanagement/v1.ts index d68fe833872..75c769fc75c 100644 --- a/src/apis/networkmanagement/v1.ts +++ b/src/apis/networkmanagement/v1.ts @@ -2236,7 +2236,7 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = await networkmanagement.organizations.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2365,7 +2365,7 @@ export namespace networkmanagement_v1 { export interface Params$Resource$Organizations$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -4064,7 +4064,7 @@ export namespace networkmanagement_v1 { * * // Do the magic * const res = await networkmanagement.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -4193,7 +4193,7 @@ export namespace networkmanagement_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/networkmanagement/v1beta1.ts b/src/apis/networkmanagement/v1beta1.ts index c648eb07a44..e66481b0149 100644 --- a/src/apis/networkmanagement/v1beta1.ts +++ b/src/apis/networkmanagement/v1beta1.ts @@ -2242,7 +2242,7 @@ export namespace networkmanagement_v1beta1 { * * // Do the magic * const res = await networkmanagement.organizations.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2371,7 +2371,7 @@ export namespace networkmanagement_v1beta1 { export interface Params$Resource$Organizations$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -4086,7 +4086,7 @@ export namespace networkmanagement_v1beta1 { * * // Do the magic * const res = await networkmanagement.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -4215,7 +4215,7 @@ export namespace networkmanagement_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** From 52ad695a27cbfd96793734f25aa506b2c2cbf407 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:15 +0000 Subject: [PATCH 21/31] feat(notebooks): update the API #### notebooks:v2 The following keys were added: - schemas.GceSetup.properties.instanceId.description - schemas.GceSetup.properties.instanceId.readOnly - schemas.GceSetup.properties.instanceId.type --- discovery/notebooks-v2.json | 7 ++++++- src/apis/notebooks/v2.ts | 4 ++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/discovery/notebooks-v2.json b/discovery/notebooks-v2.json index 53851b1261b..451e541d397 100644 --- a/discovery/notebooks-v2.json +++ b/discovery/notebooks-v2.json @@ -971,7 +971,7 @@ } } }, - "revision": "20251008", + "revision": "20251016", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1464,6 +1464,11 @@ "$ref": "GPUDriverConfig", "description": "Optional. Configuration for GPU drivers." }, + "instanceId": { + "description": "Output only. The unique ID of the Compute Engine instance resource.", + "readOnly": true, + "type": "string" + }, "machineType": { "description": "Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource", "type": "string" diff --git a/src/apis/notebooks/v2.ts b/src/apis/notebooks/v2.ts index d2facee22d8..fba6874d94f 100644 --- a/src/apis/notebooks/v2.ts +++ b/src/apis/notebooks/v2.ts @@ -428,6 +428,10 @@ export namespace notebooks_v2 { * Optional. Configuration for GPU drivers. */ gpuDriverConfig?: Schema$GPUDriverConfig; + /** + * Output only. The unique ID of the Compute Engine instance resource. + */ + instanceId?: string | null; /** * Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource */ From 57b0c2e06899f1be6bf68b69e005c2d6aa6eb127 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:15 +0000 Subject: [PATCH 22/31] fix(parallelstore): update the API #### parallelstore:v1beta The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description #### parallelstore:v1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description --- discovery/parallelstore-v1.json | 4 ++-- discovery/parallelstore-v1beta.json | 4 ++-- src/apis/parallelstore/v1.ts | 4 ++-- src/apis/parallelstore/v1beta.ts | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/discovery/parallelstore-v1.json b/discovery/parallelstore-v1.json index 62af45ac3ae..a2dacad26f2 100644 --- a/discovery/parallelstore-v1.json +++ b/discovery/parallelstore-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -554,7 +554,7 @@ } } }, - "revision": "20250924", + "revision": "20251022", "rootUrl": "https://parallelstore.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/discovery/parallelstore-v1beta.json b/discovery/parallelstore-v1beta.json index f516df5f876..e70f0a64a63 100644 --- a/discovery/parallelstore-v1beta.json +++ b/discovery/parallelstore-v1beta.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -551,7 +551,7 @@ } } }, - "revision": "20250924", + "revision": "20251022", "rootUrl": "https://parallelstore.googleapis.com/", "schemas": { "DestinationGcsBucket": { diff --git a/src/apis/parallelstore/v1.ts b/src/apis/parallelstore/v1.ts index 293e8b8f42c..57724e87ef5 100644 --- a/src/apis/parallelstore/v1.ts +++ b/src/apis/parallelstore/v1.ts @@ -652,7 +652,7 @@ export namespace parallelstore_v1 { * * // Do the magic * const res = await parallelstore.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -781,7 +781,7 @@ export namespace parallelstore_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/parallelstore/v1beta.ts b/src/apis/parallelstore/v1beta.ts index 949449b320b..6f759bb7d35 100644 --- a/src/apis/parallelstore/v1beta.ts +++ b/src/apis/parallelstore/v1beta.ts @@ -648,7 +648,7 @@ export namespace parallelstore_v1beta { * * // Do the magic * const res = await parallelstore.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -777,7 +777,7 @@ export namespace parallelstore_v1beta { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** From 6cd8e301a7c708a568eb2d2b1403edae284bec04 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:15 +0000 Subject: [PATCH 23/31] feat(pubsub): update the API #### pubsub:v1 The following keys were added: - schemas.CreateSnapshotRequest.properties.tags.additionalProperties.type - schemas.CreateSnapshotRequest.properties.tags.description - schemas.CreateSnapshotRequest.properties.tags.type - schemas.Subscription.properties.tags.additionalProperties.type - schemas.Subscription.properties.tags.description - schemas.Subscription.properties.tags.type - schemas.Topic.properties.tags.additionalProperties.type - schemas.Topic.properties.tags.description - schemas.Topic.properties.tags.type --- discovery/pubsub-v1.json | 23 ++++++++++++++++++++++- src/apis/pubsub/v1.ts | 31 ++++++++++++++++++++++++++----- 2 files changed, 48 insertions(+), 6 deletions(-) diff --git a/discovery/pubsub-v1.json b/discovery/pubsub-v1.json index d1f5ccaeecb..43f411281f9 100644 --- a/discovery/pubsub-v1.json +++ b/discovery/pubsub-v1.json @@ -1648,7 +1648,7 @@ } } }, - "revision": "20250807", + "revision": "20251025", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -2122,6 +2122,13 @@ "subscription": { "description": "Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`.", "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", + "type": "object" } }, "type": "object" @@ -2916,6 +2923,13 @@ "readOnly": true, "type": "string" }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", + "type": "object" + }, "topic": { "description": "Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted.", "type": "string" @@ -3035,6 +3049,13 @@ ], "readOnly": true, "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", + "type": "object" } }, "type": "object" diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index 5692377ca55..a26f3a2c6d4 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -432,6 +432,10 @@ export namespace pubsub_v1 { * Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project\}/subscriptions/{sub\}`. */ subscription?: string | null; + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + */ + tags?: {[key: string]: string} | null; } /** * Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times. If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail. @@ -1023,6 +1027,10 @@ export namespace pubsub_v1 { * Output only. An output-only field indicating whether or not the subscription can receive messages. */ state?: string | null; + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + */ + tags?: {[key: string]: string} | null; /** * Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project\}/topics/{topic\}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. */ @@ -1107,6 +1115,10 @@ export namespace pubsub_v1 { * Output only. An output-only field indicating the state of the topic. */ state?: string | null; + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + */ + tags?: {[key: string]: string} | null; } /** * Request for the UpdateSnapshot method. @@ -3353,7 +3365,8 @@ export namespace pubsub_v1 { * // request body parameters * // { * // "labels": {}, - * // "subscription": "my_subscription" + * // "subscription": "my_subscription", + * // "tags": {} * // } * }, * }); @@ -4778,6 +4791,7 @@ export namespace pubsub_v1 { * // "retainAckedMessages": false, * // "retryPolicy": {}, * // "state": "my_state", + * // "tags": {}, * // "topic": "my_topic", * // "topicMessageRetentionDuration": "my_topicMessageRetentionDuration" * // } @@ -4805,6 +4819,7 @@ export namespace pubsub_v1 { * // "retainAckedMessages": false, * // "retryPolicy": {}, * // "state": "my_state", + * // "tags": {}, * // "topic": "my_topic", * // "topicMessageRetentionDuration": "my_topicMessageRetentionDuration" * // } @@ -5241,6 +5256,7 @@ export namespace pubsub_v1 { * // "retainAckedMessages": false, * // "retryPolicy": {}, * // "state": "my_state", + * // "tags": {}, * // "topic": "my_topic", * // "topicMessageRetentionDuration": "my_topicMessageRetentionDuration" * // } @@ -5995,6 +6011,7 @@ export namespace pubsub_v1 { * // "retainAckedMessages": false, * // "retryPolicy": {}, * // "state": "my_state", + * // "tags": {}, * // "topic": "my_topic", * // "topicMessageRetentionDuration": "my_topicMessageRetentionDuration" * // } @@ -6910,7 +6927,8 @@ export namespace pubsub_v1 { * // "name": "my_name", * // "satisfiesPzs": false, * // "schemaSettings": {}, - * // "state": "my_state" + * // "state": "my_state", + * // "tags": {} * // } * }, * }); @@ -6927,7 +6945,8 @@ export namespace pubsub_v1 { * // "name": "my_name", * // "satisfiesPzs": false, * // "schemaSettings": {}, - * // "state": "my_state" + * // "state": "my_state", + * // "tags": {} * // } * } * @@ -7208,7 +7227,8 @@ export namespace pubsub_v1 { * // "name": "my_name", * // "satisfiesPzs": false, * // "schemaSettings": {}, - * // "state": "my_state" + * // "state": "my_state", + * // "tags": {} * // } * } * @@ -7652,7 +7672,8 @@ export namespace pubsub_v1 { * // "name": "my_name", * // "satisfiesPzs": false, * // "schemaSettings": {}, - * // "state": "my_state" + * // "state": "my_state", + * // "tags": {} * // } * } * From 73eb667b67f4376f07212cd4a9b6ab5277eb13a4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:15 +0000 Subject: [PATCH 24/31] feat(run)!: update the API BREAKING CHANGE: This release has breaking changes. #### run:v1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description #### run:v2 The following keys were deleted: - schemas.GoogleCloudRunV2Container.properties.source.description - schemas.GoogleCloudRunV2Container.properties.source.type --- discovery/run-v1.json | 4 ++-- discovery/run-v2.json | 6 +----- src/apis/run/v1.ts | 4 ++-- src/apis/run/v2.ts | 4 ---- 4 files changed, 5 insertions(+), 13 deletions(-) diff --git a/discovery/run-v1.json b/discovery/run-v1.json index bfb00505ae0..39d4c2a24b9 100644 --- a/discovery/run-v1.json +++ b/discovery/run-v1.json @@ -1742,7 +1742,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2907,7 +2907,7 @@ } } }, - "revision": "20251003", + "revision": "20251024", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { diff --git a/discovery/run-v2.json b/discovery/run-v2.json index 6ed80e1e6cc..334c785efcf 100644 --- a/discovery/run-v2.json +++ b/discovery/run-v2.json @@ -1942,7 +1942,7 @@ } } }, - "revision": "20251019", + "revision": "20251024", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2311,10 +2311,6 @@ "$ref": "GoogleCloudRunV2ResourceRequirements", "description": "Compute Resource requirements by this container." }, - "source": { - "description": "Optional. Location of the source .tar.gz file in Cloud Storage. examples: - gs://bucket/object.tar.gz. - gs://bucket/object.tar.gz#1234567890 (with object generation)", - "type": "string" - }, "startupProbe": { "$ref": "GoogleCloudRunV2Probe", "description": "Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails." diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index c1e7767cbeb..641cf3b2de0 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -9217,7 +9217,7 @@ export namespace run_v1 { * * // Do the magic * const res = await run.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -9338,7 +9338,7 @@ export namespace run_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/run/v2.ts b/src/apis/run/v2.ts index dcf1898e0a2..72ef38fd1a3 100644 --- a/src/apis/run/v2.ts +++ b/src/apis/run/v2.ts @@ -335,10 +335,6 @@ export namespace run_v2 { * Compute Resource requirements by this container. */ resources?: Schema$GoogleCloudRunV2ResourceRequirements; - /** - * Optional. Location of the source .tar.gz file in Cloud Storage. examples: - gs://bucket/object.tar.gz. - gs://bucket/object.tar.gz#1234567890 (with object generation) - */ - source?: string | null; /** * Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. */ From ea1ad3672992b349fe1b2e914d6a318a1e07ef60 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:15 +0000 Subject: [PATCH 25/31] fix(servicedirectory): update the API #### servicedirectory:v1beta1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description #### servicedirectory:v1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description --- discovery/servicedirectory-v1.json | 4 ++-- discovery/servicedirectory-v1beta1.json | 4 ++-- src/apis/servicedirectory/v1.ts | 4 ++-- src/apis/servicedirectory/v1beta1.ts | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/discovery/servicedirectory-v1.json b/discovery/servicedirectory-v1.json index 4b5290c60ec..51e595acab0 100644 --- a/discovery/servicedirectory-v1.json +++ b/discovery/servicedirectory-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -889,7 +889,7 @@ } } }, - "revision": "20250906", + "revision": "20251030", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/discovery/servicedirectory-v1beta1.json b/discovery/servicedirectory-v1beta1.json index e59801e7d42..d28d3a248aa 100644 --- a/discovery/servicedirectory-v1beta1.json +++ b/discovery/servicedirectory-v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -977,7 +977,7 @@ } } }, - "revision": "20250906", + "revision": "20251030", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/src/apis/servicedirectory/v1.ts b/src/apis/servicedirectory/v1.ts index b2c2cb591e9..c8911439d4e 100644 --- a/src/apis/servicedirectory/v1.ts +++ b/src/apis/servicedirectory/v1.ts @@ -581,7 +581,7 @@ export namespace servicedirectory_v1 { * * // Do the magic * const res = await servicedirectory.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -710,7 +710,7 @@ export namespace servicedirectory_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/servicedirectory/v1beta1.ts b/src/apis/servicedirectory/v1beta1.ts index 5a27ab7374a..c2ae3e3f1ad 100644 --- a/src/apis/servicedirectory/v1beta1.ts +++ b/src/apis/servicedirectory/v1beta1.ts @@ -605,7 +605,7 @@ export namespace servicedirectory_v1beta1 { * * // Do the magic * const res = await servicedirectory.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -734,7 +734,7 @@ export namespace servicedirectory_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** From 6738759b90d283d4c47d4ac9fd1dbe0179948917 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:15 +0000 Subject: [PATCH 26/31] fix(servicemanagement): update the API #### servicemanagement:v1 The following keys were changed: - schemas.Control.properties.environment.description --- discovery/servicemanagement-v1.json | 4 ++-- src/apis/servicemanagement/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/servicemanagement-v1.json b/discovery/servicemanagement-v1.json index 37d9fc3294e..9694762ab39 100644 --- a/discovery/servicemanagement-v1.json +++ b/discovery/servicemanagement-v1.json @@ -835,7 +835,7 @@ } } }, - "revision": "20251001", + "revision": "20251027", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -1584,7 +1584,7 @@ "id": "Control", "properties": { "environment": { - "description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com", + "description": "The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com.", "type": "string" }, "methodPolicies": { diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index e6fd48b9f9c..d61c2180b48 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -629,7 +629,7 @@ export namespace servicemanagement_v1 { */ export interface Schema$Control { /** - * The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com + * The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com. */ environment?: string | null; /** From cb86cd2c5346df7357e15dafacba395632510142 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:15 +0000 Subject: [PATCH 27/31] fix(travelimpactmodel): update the API #### travelimpactmodel:v1 The following keys were changed: - schemas.Scope3FlightSegment.properties.carrierCode.description - schemas.Scope3FlightSegment.properties.destination.description - schemas.Scope3FlightSegment.properties.distanceKm.description - schemas.Scope3FlightSegment.properties.flightNumber.description - schemas.Scope3FlightSegment.properties.origin.description --- discovery/travelimpactmodel-v1.json | 12 ++++++------ src/apis/travelimpactmodel/v1.ts | 10 +++++----- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/discovery/travelimpactmodel-v1.json b/discovery/travelimpactmodel-v1.json index 85a3295b370..7faba9ccd4f 100644 --- a/discovery/travelimpactmodel-v1.json +++ b/discovery/travelimpactmodel-v1.json @@ -146,7 +146,7 @@ } } }, - "revision": "20251008", + "revision": "20251102", "rootUrl": "https://travelimpactmodel.googleapis.com/", "schemas": { "ComputeFlightEmissionsRequest": { @@ -505,7 +505,7 @@ "type": "string" }, "carrierCode": { - "description": "Optional. IATA carrier code, e.g. `KE`. This is required if specific flight matching is desired. Otherwise, this is unused for typical flight and distance-based emissions models. This could be both operating and marketing carrier code (i.e. codeshare is covered).", + "description": "Optional. 2-character [IATA carrier code](https://www.iata.org/en/publications/directories/code-search/), e.g. `KE`. This is required if specific flight matching is desired. Otherwise, this is unused for typical flight and distance-based emissions models. This could be both operating and marketing carrier code (i.e. codeshare is covered).", "type": "string" }, "departureDate": { @@ -513,21 +513,21 @@ "description": "Required. Date of the flight in the time zone of the origin airport. Only year is required for typical flight and distance-based emissions models (month and day values are ignored and therefore, can be either omitted, set to 0, or set to a valid date for those cases). Correspondingly, if a specific date is not provided for TIM emissions, we will fallback to typical flight (or distance-based) emissions." }, "destination": { - "description": "Optional. IATA airport code for flight destination, e.g. `ICN`. This is used to match specific flight if provided alongside origin, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided.", + "description": "Optional. 3-character [IATA airport code](https://www.iata.org/en/publications/directories/code-search/) for flight destination, e.g. `ICN`. This is used to match specific flight if provided alongside origin, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided.", "type": "string" }, "distanceKm": { - "description": "Optional. Distance in kilometers, e.g. `2423`. This is used to match a flight to distance-based emissions when origin and destination are not provided or there are no matching typical flights. This field supports values between 0 and 2.5e16 km.", + "description": "Optional. Distance in kilometers, e.g. `2423`, from [1, 2.5e16) km. This is used to match a flight to distance-based emissions when origin and destination are not provided or there are no matching typical flights.", "format": "int64", "type": "string" }, "flightNumber": { - "description": "Optional. Flight number, e.g. `71`. This is first used to match a specific flight if a flight number is specified alongside origin, destination, and carrier. If a flight number is not specified, we will first try to match the flight to a typical flight between the provided origin and destination airports. If that fails and/or origin & destination are not provided, we will use the distance-based emissions model based on the flight distance provided.", + "description": "Optional. Up to 4-digit [flight number](https://en.wikipedia.org/wiki/Flight_number), e.g. `71`, from [1, 9999]. This is first used to match a specific flight if a flight number is specified alongside origin, destination, and carrier. If a flight number is not specified, we will first try to match the flight to a typical flight between the provided origin and destination airports. If that fails and/or origin & destination are not provided, we will use the distance-based emissions model based on the flight distance provided.", "format": "int32", "type": "integer" }, "origin": { - "description": "Optional. IATA airport code for flight origin, e.g. `YVR`. This is used to match specific flight if provided alongside destination, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided.", + "description": "Optional. 3-character [IATA airport code](https://www.iata.org/en/publications/directories/code-search/) for flight origin, e.g. `YVR`. This is used to match specific flight if provided alongside destination, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided.", "type": "string" } }, diff --git a/src/apis/travelimpactmodel/v1.ts b/src/apis/travelimpactmodel/v1.ts index cd000a33a75..3660440c6ef 100644 --- a/src/apis/travelimpactmodel/v1.ts +++ b/src/apis/travelimpactmodel/v1.ts @@ -371,7 +371,7 @@ export namespace travelimpactmodel_v1 { */ cabinClass?: string | null; /** - * Optional. IATA carrier code, e.g. `KE`. This is required if specific flight matching is desired. Otherwise, this is unused for typical flight and distance-based emissions models. This could be both operating and marketing carrier code (i.e. codeshare is covered). + * Optional. 2-character [IATA carrier code](https://www.iata.org/en/publications/directories/code-search/), e.g. `KE`. This is required if specific flight matching is desired. Otherwise, this is unused for typical flight and distance-based emissions models. This could be both operating and marketing carrier code (i.e. codeshare is covered). */ carrierCode?: string | null; /** @@ -379,19 +379,19 @@ export namespace travelimpactmodel_v1 { */ departureDate?: Schema$Date; /** - * Optional. IATA airport code for flight destination, e.g. `ICN`. This is used to match specific flight if provided alongside origin, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided. + * Optional. 3-character [IATA airport code](https://www.iata.org/en/publications/directories/code-search/) for flight destination, e.g. `ICN`. This is used to match specific flight if provided alongside origin, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided. */ destination?: string | null; /** - * Optional. Distance in kilometers, e.g. `2423`. This is used to match a flight to distance-based emissions when origin and destination are not provided or there are no matching typical flights. This field supports values between 0 and 2.5e16 km. + * Optional. Distance in kilometers, e.g. `2423`, from [1, 2.5e16) km. This is used to match a flight to distance-based emissions when origin and destination are not provided or there are no matching typical flights. */ distanceKm?: string | null; /** - * Optional. Flight number, e.g. `71`. This is first used to match a specific flight if a flight number is specified alongside origin, destination, and carrier. If a flight number is not specified, we will first try to match the flight to a typical flight between the provided origin and destination airports. If that fails and/or origin & destination are not provided, we will use the distance-based emissions model based on the flight distance provided. + * Optional. Up to 4-digit [flight number](https://en.wikipedia.org/wiki/Flight_number), e.g. `71`, from [1, 9999]. This is first used to match a specific flight if a flight number is specified alongside origin, destination, and carrier. If a flight number is not specified, we will first try to match the flight to a typical flight between the provided origin and destination airports. If that fails and/or origin & destination are not provided, we will use the distance-based emissions model based on the flight distance provided. */ flightNumber?: number | null; /** - * Optional. IATA airport code for flight origin, e.g. `YVR`. This is used to match specific flight if provided alongside destination, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided. + * Optional. 3-character [IATA airport code](https://www.iata.org/en/publications/directories/code-search/) for flight origin, e.g. `YVR`. This is used to match specific flight if provided alongside destination, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided. */ origin?: string | null; } From a21bcf21f7bcbdc52ef333e19add90bf91124a4e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:15 +0000 Subject: [PATCH 28/31] feat(vmmigration): update the API #### vmmigration:v1 The following keys were added: - schemas.ComputeEngineTargetDefaults.properties.storagePool.description - schemas.ComputeEngineTargetDefaults.properties.storagePool.type - schemas.ComputeEngineTargetDetails.properties.storagePool.description - schemas.ComputeEngineTargetDetails.properties.storagePool.type The following keys were changed: - schemas.DataDiskImageImport.description --- discovery/vmmigration-v1.json | 12 ++++++++++-- src/apis/vmmigration/v1.ts | 10 +++++++++- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/discovery/vmmigration-v1.json b/discovery/vmmigration-v1.json index d4ddaa133f9..24d6149ccb9 100644 --- a/discovery/vmmigration-v1.json +++ b/discovery/vmmigration-v1.json @@ -2548,7 +2548,7 @@ } } }, - "revision": "20251023", + "revision": "20251030", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -3736,6 +3736,10 @@ "description": "Optional. The service account to associate the VM with.", "type": "string" }, + "storagePool": { + "description": "Optional. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: \"projects/my-project/zones/us-central1-a/storagePools/my-storage-pool\". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type.", + "type": "string" + }, "targetProject": { "description": "The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.", "type": "string" @@ -3908,6 +3912,10 @@ "description": "The service account to associate the VM with.", "type": "string" }, + "storagePool": { + "description": "Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: \"projects/my-project/zones/us-central1-a/storagePools/my-storage-pool\". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type.", + "type": "string" + }, "vmName": { "description": "The name of the VM to create.", "type": "string" @@ -4153,7 +4161,7 @@ "type": "object" }, "DataDiskImageImport": { - "description": "Mentions that the image import is not using OS adaptation process.", + "description": "Used when the image import is not using OS adaptation process.", "id": "DataDiskImageImport", "properties": {}, "type": "object" diff --git a/src/apis/vmmigration/v1.ts b/src/apis/vmmigration/v1.ts index b26630a3dfb..59269d81ce5 100644 --- a/src/apis/vmmigration/v1.ts +++ b/src/apis/vmmigration/v1.ts @@ -841,6 +841,10 @@ export namespace vmmigration_v1 { * Optional. The service account to associate the VM with. */ serviceAccount?: string | null; + /** + * Optional. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. + */ + storagePool?: string | null; /** * The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM. */ @@ -946,6 +950,10 @@ export namespace vmmigration_v1 { * The service account to associate the VM with. */ serviceAccount?: string | null; + /** + * Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. + */ + storagePool?: string | null; /** * The name of the VM to create. */ @@ -1166,7 +1174,7 @@ export namespace vmmigration_v1 { version?: string | null; } /** - * Mentions that the image import is not using OS adaptation process. + * Used when the image import is not using OS adaptation process. */ export interface Schema$DataDiskImageImport {} /** From 8dac096201898de8626bdb9035a5aeba35f273cb Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:16 +0000 Subject: [PATCH 29/31] feat(vmwareengine): update the API #### vmwareengine:v1 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess.type - schemas.ListOperationsResponse.properties.unreachable.description - schemas.ListOperationsResponse.properties.unreachable.items.type - schemas.ListOperationsResponse.properties.unreachable.type --- discovery/vmwareengine-v1.json | 14 +++++++++++++- src/apis/vmwareengine/v1.ts | 13 ++++++++++++- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/discovery/vmwareengine-v1.json b/discovery/vmwareengine-v1.json index 2d3fddf0096..f0f2836322f 100644 --- a/discovery/vmwareengine-v1.json +++ b/discovery/vmwareengine-v1.json @@ -1127,6 +1127,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -3396,7 +3401,7 @@ } } }, - "revision": "20250912", + "revision": "20251020", "rootUrl": "https://vmwareengine.googleapis.com/", "schemas": { "AcceleratePrivateCloudDeletionRequest": { @@ -4451,6 +4456,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/src/apis/vmwareengine/v1.ts b/src/apis/vmwareengine/v1.ts index 148c7dd3481..6f8ab1e5866 100644 --- a/src/apis/vmwareengine/v1.ts +++ b/src/apis/vmwareengine/v1.ts @@ -830,6 +830,10 @@ export namespace vmwareengine_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response message for VmwareEngine.ListPeeringRoutes @@ -6723,13 +6727,16 @@ export namespace vmwareengine_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -6863,6 +6870,10 @@ export namespace vmwareengine_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Privateclouds { From 308b72e83ff2ebd17933e473a31895ab88e47e70 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:16 +0000 Subject: [PATCH 30/31] fix(workloadmanager): update the API #### workloadmanager:v1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description - schemas.ViolationDetails.properties.observed.description --- discovery/workloadmanager-v1.json | 6 +++--- src/apis/workloadmanager/v1.ts | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/discovery/workloadmanager-v1.json b/discovery/workloadmanager-v1.json index 81985298f8a..a8b6ec9aec0 100644 --- a/discovery/workloadmanager-v1.json +++ b/discovery/workloadmanager-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -923,7 +923,7 @@ } } }, - "revision": "20251001", + "revision": "20251022", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "AgentCommand": { @@ -3430,7 +3430,7 @@ "additionalProperties": { "type": "string" }, - "description": "Details of the violation.", + "description": "Details of the violation. TODO(b/452163887)", "type": "object" }, "serviceAccount": { diff --git a/src/apis/workloadmanager/v1.ts b/src/apis/workloadmanager/v1.ts index ca4b3d17bae..6ede510c356 100644 --- a/src/apis/workloadmanager/v1.ts +++ b/src/apis/workloadmanager/v1.ts @@ -1701,7 +1701,7 @@ export namespace workloadmanager_v1 { */ asset?: string | null; /** - * Details of the violation. + * Details of the violation. TODO(b/452163887) */ observed?: {[key: string]: string} | null; /** @@ -1956,7 +1956,7 @@ export namespace workloadmanager_v1 { * * // Do the magic * const res = await workloadmanager.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2085,7 +2085,7 @@ export namespace workloadmanager_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** From fba4e21d0c44d5d6cf83e6af8828aebbcd3ce087 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 01:37:16 +0000 Subject: [PATCH 31/31] feat: regenerate index files --- disclaimers.json | 4 + discovery/batch-v1.json | 16 ++- discovery/dataflow-v1b3.json | 42 +++++++- discovery/identitytoolkit-v1.json | 10 +- discovery/language-v1.json | 174 +++++++++++++++++++++++++++++- discovery/language-v1beta2.json | 174 +++++++++++++++++++++++++++++- discovery/language-v2.json | 174 +++++++++++++++++++++++++++++- discovery/sqladmin-v1beta4.json | 14 +-- 8 files changed, 578 insertions(+), 30 deletions(-) diff --git a/disclaimers.json b/disclaimers.json index 97c7168fe8d..a9268e72230 100644 --- a/disclaimers.json +++ b/disclaimers.json @@ -679,6 +679,10 @@ "api": "css", "package": "@google-shopping/css" }, + { + "api": "geminidataanalytics", + "package": "@google-cloud/geminidataanalytics" + }, { "api": "datalabeling", "package": "@google-cloud/datalabeling" diff --git a/discovery/batch-v1.json b/discovery/batch-v1.json index 3cd1e3c5ba0..127856776ff 100644 --- a/discovery/batch-v1.json +++ b/discovery/batch-v1.json @@ -600,7 +600,7 @@ } } }, - "revision": "20251005", + "revision": "20251020", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { @@ -1304,13 +1304,15 @@ "STANDARD", "SPOT", "PREEMPTIBLE", - "RESERVATION_BOUND" + "RESERVATION_BOUND", + "FLEX_START" ], "enumDeprecated": [ false, false, false, true, + false, false ], "enumDescriptions": [ @@ -1318,7 +1320,8 @@ "Standard VM.", "SPOT VM.", "Preemptible VM (PVM). Above SPOT VM is the preferable model for preemptible VM instances: the old preemptible VM model (indicated by this field) is the older model, and has been migrated to use the SPOT model as the underlying technology. This old model will still be supported.", - "Bound to the lifecycle of the reservation in which it is provisioned." + "Bound to the lifecycle of the reservation in which it is provisioned.", + "Instance is provisioned with DWS Flex Start and has limited max run duration." ], "type": "string" }, @@ -1375,13 +1378,15 @@ "STANDARD", "SPOT", "PREEMPTIBLE", - "RESERVATION_BOUND" + "RESERVATION_BOUND", + "FLEX_START" ], "enumDeprecated": [ false, false, false, true, + false, false ], "enumDescriptions": [ @@ -1389,7 +1394,8 @@ "Standard VM.", "SPOT VM.", "Preemptible VM (PVM). Above SPOT VM is the preferable model for preemptible VM instances: the old preemptible VM model (indicated by this field) is the older model, and has been migrated to use the SPOT model as the underlying technology. This old model will still be supported.", - "Bound to the lifecycle of the reservation in which it is provisioned." + "Bound to the lifecycle of the reservation in which it is provisioned.", + "Instance is provisioned with DWS Flex Start and has limited max run duration." ], "type": "string" }, diff --git a/discovery/dataflow-v1b3.json b/discovery/dataflow-v1b3.json index 32d5f9d1b7f..5d679676c4d 100644 --- a/discovery/dataflow-v1b3.json +++ b/discovery/dataflow-v1b3.json @@ -29,6 +29,16 @@ "endpointUrl": "https://dataflow.asia-east1.rep.googleapis.com/", "location": "asia-east1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, { "description": "Regional Endpoint", "endpointUrl": "https://dataflow.asia-south1.rep.googleapis.com/", @@ -39,16 +49,36 @@ "endpointUrl": "https://dataflow.asia-south2.rep.googleapis.com/", "location": "asia-south2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.asia-southeast3.rep.googleapis.com/", + "location": "asia-southeast3" + }, { "description": "Regional Endpoint", "endpointUrl": "https://dataflow.australia-southeast1.rep.googleapis.com/", "location": "australia-southeast1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://dataflow.europe-central2.rep.googleapis.com/", "location": "europe-central2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, { "description": "Regional Endpoint", "endpointUrl": "https://dataflow.europe-west3.rep.googleapis.com/", @@ -74,11 +104,21 @@ "endpointUrl": "https://dataflow.me-central2.rep.googleapis.com/", "location": "me-central2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://dataflow.northamerica-northeast1.rep.googleapis.com/", "location": "northamerica-northeast1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://dataflow.southamerica-west1.rep.googleapis.com/", @@ -2295,7 +2335,7 @@ } } }, - "revision": "20251019", + "revision": "20251026", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { diff --git a/discovery/identitytoolkit-v1.json b/discovery/identitytoolkit-v1.json index 1be564ea364..efdbc213629 100644 --- a/discovery/identitytoolkit-v1.json +++ b/discovery/identitytoolkit-v1.json @@ -1239,7 +1239,7 @@ } } }, - "revision": "20250130", + "revision": "20251024", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitV1Argon2Parameters": { @@ -2440,7 +2440,7 @@ "type": "object" }, "GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest": { - "description": "Request message for SendVerificationCode. 'captcha_response' is required when reCAPTCHA enterprise is enabled, or otherwise at least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator.", + "description": "Request message for SendVerificationCode. 'captcha_response' is required when reCAPTCHA enterprise is enabled, or otherwise at least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `play_integrity_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator.", "id": "GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest", "properties": { "autoRetrievalInfo": { @@ -2468,7 +2468,7 @@ "type": "string" }, "iosReceipt": { - "description": "Receipt of successful iOS app token validation. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). This should come from the response of verifyIosClient. If present, the caller should also provide the `ios_secret`, as well as a bundle ID in the `x-ios-bundle-identifier` header, which must match the bundle ID from the verifyIosClient request.", + "description": "Receipt of successful iOS app token validation. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `play_integrity_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). This should come from the response of verifyIosClient. If present, the caller should also provide the `ios_secret`, as well as a bundle ID in the `x-ios-bundle-identifier` header, which must match the bundle ID from the verifyIosClient request.", "type": "string" }, "iosSecret": { @@ -2484,7 +2484,7 @@ "type": "string" }, "recaptchaToken": { - "description": "Recaptcha token for app verification. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). The recaptcha should be generated by calling getRecaptchaParams and the recaptcha token will be generated on user completion of the recaptcha challenge.", + "description": "Recaptcha token for app verification. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `play_integrity_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). The recaptcha should be generated by calling getRecaptchaParams and the recaptcha token will be generated on user completion of the recaptcha challenge.", "type": "string" }, "recaptchaVersion": { @@ -2500,7 +2500,7 @@ "type": "string" }, "safetyNetToken": { - "description": "Android only. Used to assert application identity in place of a recaptcha token. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). A SafetyNet Token can be generated via the [SafetyNet Android Attestation API](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce.", + "description": "Android only. Safety Net has been deprecated. Please use play_integrity_token instead.", "type": "string" }, "tenantId": { diff --git a/discovery/language-v1.json b/discovery/language-v1.json index 9297996721d..f2b71a4410c 100644 --- a/discovery/language-v1.json +++ b/discovery/language-v1.json @@ -246,7 +246,7 @@ } } }, - "revision": "20250824", + "revision": "20251026", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -699,6 +699,7 @@ "G2", "G4", "C3", + "C4", "M2", "M1", "N1", @@ -719,6 +720,7 @@ "GPU-based machine, skip quota reporting.", "GPU-based machine, skip quota reporting.", "", + "", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", @@ -897,7 +899,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", - "C3_HIGHMEM_176" + "C3_HIGHMEM_176", + "C4_STANDARD_8", + "C4_STANDARD_16", + "C4_STANDARD_24", + "C4_STANDARD_32", + "C4_STANDARD_48", + "C4_STANDARD_96", + "C4_STANDARD_144", + "C4_STANDARD_192", + "C4_STANDARD_288", + "C4_HIGHCPU_8", + "C4_HIGHCPU_16", + "C4_HIGHCPU_24", + "C4_HIGHCPU_32", + "C4_HIGHCPU_48", + "C4_HIGHCPU_96", + "C4_HIGHCPU_144", + "C4_HIGHCPU_192", + "C4_HIGHCPU_288", + "C4_HIGHMEM_8", + "C4_HIGHMEM_16", + "C4_HIGHMEM_24", + "C4_HIGHMEM_32", + "C4_HIGHMEM_48", + "C4_HIGHMEM_96", + "C4_HIGHMEM_144", + "C4_HIGHMEM_192", + "C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -1066,6 +1095,33 @@ "", "", "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", "" ], "type": "string" @@ -1642,7 +1698,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", - "C3_HIGHMEM_176" + "C3_HIGHMEM_176", + "C4_STANDARD_8", + "C4_STANDARD_16", + "C4_STANDARD_24", + "C4_STANDARD_32", + "C4_STANDARD_48", + "C4_STANDARD_96", + "C4_STANDARD_144", + "C4_STANDARD_192", + "C4_STANDARD_288", + "C4_HIGHCPU_8", + "C4_HIGHCPU_16", + "C4_HIGHCPU_24", + "C4_HIGHCPU_32", + "C4_HIGHCPU_48", + "C4_HIGHCPU_96", + "C4_HIGHCPU_144", + "C4_HIGHCPU_192", + "C4_HIGHCPU_288", + "C4_HIGHMEM_8", + "C4_HIGHMEM_16", + "C4_HIGHMEM_24", + "C4_HIGHMEM_32", + "C4_HIGHMEM_48", + "C4_HIGHMEM_96", + "C4_HIGHMEM_144", + "C4_HIGHMEM_192", + "C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -1811,6 +1894,33 @@ "", "", "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", "" ], "type": "string" @@ -2336,7 +2446,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", - "C3_HIGHMEM_176" + "C3_HIGHMEM_176", + "C4_STANDARD_8", + "C4_STANDARD_16", + "C4_STANDARD_24", + "C4_STANDARD_32", + "C4_STANDARD_48", + "C4_STANDARD_96", + "C4_STANDARD_144", + "C4_STANDARD_192", + "C4_STANDARD_288", + "C4_HIGHCPU_8", + "C4_HIGHCPU_16", + "C4_HIGHCPU_24", + "C4_HIGHCPU_32", + "C4_HIGHCPU_48", + "C4_HIGHCPU_96", + "C4_HIGHCPU_144", + "C4_HIGHCPU_192", + "C4_HIGHCPU_288", + "C4_HIGHMEM_8", + "C4_HIGHMEM_16", + "C4_HIGHMEM_24", + "C4_HIGHMEM_32", + "C4_HIGHMEM_48", + "C4_HIGHMEM_96", + "C4_HIGHMEM_144", + "C4_HIGHMEM_192", + "C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -2505,6 +2642,33 @@ "", "", "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", "" ], "type": "string" @@ -2528,6 +2692,7 @@ "E2", "G2", "G4", + "C4", "C3", "M2", "M1", @@ -2549,6 +2714,7 @@ "", "", "", + "", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", diff --git a/discovery/language-v1beta2.json b/discovery/language-v1beta2.json index 132995f5a95..71f9a7b7f62 100644 --- a/discovery/language-v1beta2.json +++ b/discovery/language-v1beta2.json @@ -246,7 +246,7 @@ } } }, - "revision": "20250824", + "revision": "20251026", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -699,6 +699,7 @@ "G2", "G4", "C3", + "C4", "M2", "M1", "N1", @@ -719,6 +720,7 @@ "GPU-based machine, skip quota reporting.", "GPU-based machine, skip quota reporting.", "", + "", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", @@ -897,7 +899,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", - "C3_HIGHMEM_176" + "C3_HIGHMEM_176", + "C4_STANDARD_8", + "C4_STANDARD_16", + "C4_STANDARD_24", + "C4_STANDARD_32", + "C4_STANDARD_48", + "C4_STANDARD_96", + "C4_STANDARD_144", + "C4_STANDARD_192", + "C4_STANDARD_288", + "C4_HIGHCPU_8", + "C4_HIGHCPU_16", + "C4_HIGHCPU_24", + "C4_HIGHCPU_32", + "C4_HIGHCPU_48", + "C4_HIGHCPU_96", + "C4_HIGHCPU_144", + "C4_HIGHCPU_192", + "C4_HIGHCPU_288", + "C4_HIGHMEM_8", + "C4_HIGHMEM_16", + "C4_HIGHMEM_24", + "C4_HIGHMEM_32", + "C4_HIGHMEM_48", + "C4_HIGHMEM_96", + "C4_HIGHMEM_144", + "C4_HIGHMEM_192", + "C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -1066,6 +1095,33 @@ "", "", "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", "" ], "type": "string" @@ -1660,7 +1716,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", - "C3_HIGHMEM_176" + "C3_HIGHMEM_176", + "C4_STANDARD_8", + "C4_STANDARD_16", + "C4_STANDARD_24", + "C4_STANDARD_32", + "C4_STANDARD_48", + "C4_STANDARD_96", + "C4_STANDARD_144", + "C4_STANDARD_192", + "C4_STANDARD_288", + "C4_HIGHCPU_8", + "C4_HIGHCPU_16", + "C4_HIGHCPU_24", + "C4_HIGHCPU_32", + "C4_HIGHCPU_48", + "C4_HIGHCPU_96", + "C4_HIGHCPU_144", + "C4_HIGHCPU_192", + "C4_HIGHCPU_288", + "C4_HIGHMEM_8", + "C4_HIGHMEM_16", + "C4_HIGHMEM_24", + "C4_HIGHMEM_32", + "C4_HIGHMEM_48", + "C4_HIGHMEM_96", + "C4_HIGHMEM_144", + "C4_HIGHMEM_192", + "C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -1829,6 +1912,33 @@ "", "", "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", "" ], "type": "string" @@ -2354,7 +2464,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", - "C3_HIGHMEM_176" + "C3_HIGHMEM_176", + "C4_STANDARD_8", + "C4_STANDARD_16", + "C4_STANDARD_24", + "C4_STANDARD_32", + "C4_STANDARD_48", + "C4_STANDARD_96", + "C4_STANDARD_144", + "C4_STANDARD_192", + "C4_STANDARD_288", + "C4_HIGHCPU_8", + "C4_HIGHCPU_16", + "C4_HIGHCPU_24", + "C4_HIGHCPU_32", + "C4_HIGHCPU_48", + "C4_HIGHCPU_96", + "C4_HIGHCPU_144", + "C4_HIGHCPU_192", + "C4_HIGHCPU_288", + "C4_HIGHMEM_8", + "C4_HIGHMEM_16", + "C4_HIGHMEM_24", + "C4_HIGHMEM_32", + "C4_HIGHMEM_48", + "C4_HIGHMEM_96", + "C4_HIGHMEM_144", + "C4_HIGHMEM_192", + "C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -2523,6 +2660,33 @@ "", "", "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", "" ], "type": "string" @@ -2546,6 +2710,7 @@ "E2", "G2", "G4", + "C4", "C3", "M2", "M1", @@ -2567,6 +2732,7 @@ "", "", "", + "", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", diff --git a/discovery/language-v2.json b/discovery/language-v2.json index 43d5cdb2011..67900e3335e 100644 --- a/discovery/language-v2.json +++ b/discovery/language-v2.json @@ -208,7 +208,7 @@ } } }, - "revision": "20250824", + "revision": "20251026", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -524,6 +524,7 @@ "G2", "G4", "C3", + "C4", "M2", "M1", "N1", @@ -544,6 +545,7 @@ "GPU-based machine, skip quota reporting.", "GPU-based machine, skip quota reporting.", "", + "", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", @@ -722,7 +724,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", - "C3_HIGHMEM_176" + "C3_HIGHMEM_176", + "C4_STANDARD_8", + "C4_STANDARD_16", + "C4_STANDARD_24", + "C4_STANDARD_32", + "C4_STANDARD_48", + "C4_STANDARD_96", + "C4_STANDARD_144", + "C4_STANDARD_192", + "C4_STANDARD_288", + "C4_HIGHCPU_8", + "C4_HIGHCPU_16", + "C4_HIGHCPU_24", + "C4_HIGHCPU_32", + "C4_HIGHCPU_48", + "C4_HIGHCPU_96", + "C4_HIGHCPU_144", + "C4_HIGHCPU_192", + "C4_HIGHCPU_288", + "C4_HIGHMEM_8", + "C4_HIGHMEM_16", + "C4_HIGHMEM_24", + "C4_HIGHMEM_32", + "C4_HIGHMEM_48", + "C4_HIGHMEM_96", + "C4_HIGHMEM_144", + "C4_HIGHMEM_192", + "C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -891,6 +920,33 @@ "", "", "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", "" ], "type": "string" @@ -1281,7 +1337,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", - "C3_HIGHMEM_176" + "C3_HIGHMEM_176", + "C4_STANDARD_8", + "C4_STANDARD_16", + "C4_STANDARD_24", + "C4_STANDARD_32", + "C4_STANDARD_48", + "C4_STANDARD_96", + "C4_STANDARD_144", + "C4_STANDARD_192", + "C4_STANDARD_288", + "C4_HIGHCPU_8", + "C4_HIGHCPU_16", + "C4_HIGHCPU_24", + "C4_HIGHCPU_32", + "C4_HIGHCPU_48", + "C4_HIGHCPU_96", + "C4_HIGHCPU_144", + "C4_HIGHCPU_192", + "C4_HIGHCPU_288", + "C4_HIGHMEM_8", + "C4_HIGHMEM_16", + "C4_HIGHMEM_24", + "C4_HIGHMEM_32", + "C4_HIGHMEM_48", + "C4_HIGHMEM_96", + "C4_HIGHMEM_144", + "C4_HIGHMEM_192", + "C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -1450,6 +1533,33 @@ "", "", "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", "" ], "type": "string" @@ -1730,7 +1840,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", - "C3_HIGHMEM_176" + "C3_HIGHMEM_176", + "C4_STANDARD_8", + "C4_STANDARD_16", + "C4_STANDARD_24", + "C4_STANDARD_32", + "C4_STANDARD_48", + "C4_STANDARD_96", + "C4_STANDARD_144", + "C4_STANDARD_192", + "C4_STANDARD_288", + "C4_HIGHCPU_8", + "C4_HIGHCPU_16", + "C4_HIGHCPU_24", + "C4_HIGHCPU_32", + "C4_HIGHCPU_48", + "C4_HIGHCPU_96", + "C4_HIGHCPU_144", + "C4_HIGHCPU_192", + "C4_HIGHCPU_288", + "C4_HIGHMEM_8", + "C4_HIGHMEM_16", + "C4_HIGHMEM_24", + "C4_HIGHMEM_32", + "C4_HIGHMEM_48", + "C4_HIGHMEM_96", + "C4_HIGHMEM_144", + "C4_HIGHMEM_192", + "C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -1899,6 +2036,33 @@ "", "", "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", "" ], "type": "string" @@ -1922,6 +2086,7 @@ "E2", "G2", "G4", + "C4", "C3", "M2", "M1", @@ -1943,6 +2108,7 @@ "", "", "", + "", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", diff --git a/discovery/sqladmin-v1beta4.json b/discovery/sqladmin-v1beta4.json index 7aed7b8d006..e1b3dbbe1a9 100644 --- a/discovery/sqladmin-v1beta4.json +++ b/discovery/sqladmin-v1beta4.json @@ -2685,7 +2685,7 @@ } } }, - "revision": "20251019", + "revision": "20251023", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2977,7 +2977,7 @@ "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", - "The database version is AGBALA. The database version is PostgreSQL 18.", + "The database version is PostgreSQL 18.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -3439,7 +3439,7 @@ "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", - "The database version is AGBALA. The database version is PostgreSQL 18.", + "The database version is PostgreSQL 18.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -3888,7 +3888,7 @@ "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", - "The database version is AGBALA. The database version is PostgreSQL 18.", + "The database version is PostgreSQL 18.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -4293,7 +4293,7 @@ "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", - "The database version is AGBALA. The database version is PostgreSQL 18.", + "The database version is PostgreSQL 18.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -5247,7 +5247,7 @@ "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", - "The database version is AGBALA. The database version is PostgreSQL 18.", + "The database version is PostgreSQL 18.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.", @@ -7001,7 +7001,7 @@ "The database version is PostgreSQL 15.", "The database version is PostgreSQL 16.", "The database version is PostgreSQL 17.", - "The database version is AGBALA. The database version is PostgreSQL 18.", + "The database version is PostgreSQL 18.", "The database version is SQL Server 2019 Standard.", "The database version is SQL Server 2019 Enterprise.", "The database version is SQL Server 2019 Express.",